BObonifiq
Points

Lists points set to expire within the specified date range (paginated).

Retrieves a paginated list of points scheduled to expire.

post/v1/pvt/Points/toexpire

Request

  • Base URL
    https://api.bonifiq.com.br
  • Auth
    HTTP basic

Request body

PageNumberinteger

Pagenation number

PageSizeinteger

Amount of items per page, Max size is 50 items per page.

Fromstring date-time nullable

Optional start date for the expiration period (inclusive). Filters points expiring on or after this date. Expected format: ISO 8601 (e.g., "2023-10-27T00:00:00Z").

Tostring date-time nullable

Optional end date for the expiration period (inclusive). Filters points expiring on or before this date. Expected format: ISO 8601 (e.g., "2023-11-27T23:59:59Z").

Response

A paginated list of expiring points.

TotalItemCountinteger
PageSizeinteger
PageNumberinteger
HasNextPageboolean

Changes

No recorded changes to this operation across all 38 revisions of this API.