Skip to main content
POST
/
v1
/
pvt
/
Points
/
toexpire
Lists points set to expire within the specified date range (paginated).
curl --request POST \
  --url https://api.bonifiq.com.br/v1/pvt/Points/toexpire \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "PageNumber": 123,
  "PageSize": 123,
  "From": "2023-11-07T05:31:56Z",
  "To": "2023-11-07T05:31:56Z"
}
'
{
  "Items": [
    {
      "Id": 123,
      "ExpirationDate": "2023-11-07T05:31:56Z",
      "Points": 123,
      "ReasonType": 0,
      "GenerationDate": "2023-11-07T05:31:56Z",
      "CustomerId": 123,
      "CustomerName": "<string>",
      "CustomerEmail": "<string>",
      "CustomerPhone": "<string>",
      "CustomerDocument": "<string>",
      "BranchName": "<string>",
      "BranchId": 123,
      "CashbackValue": 123,
      "OrderOrigin": "<string>",
      "Salesman": "<string>"
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true
}

Authorizations

​
Authorization
string
header
required

Use API Basic Auth Keys

Body

application/json

Filter containing the optional date range (From, To) for expiration dates and pagination parameters (PageNumber, PageSize).

Base Filter model Request filter for retrieving expiring points via the external API.

​
PageNumber
integer<int32>

Pagenation number

​
PageSize
integer<int32>

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

​
From
string<date-time> | null

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").

​
To
string<date-time> | null

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

200 - application/json

A paginated list of expiring points.

​
Items
object[]
​
TotalItemCount
integer<int32>
​
PageSize
integer<int32>
​
PageNumber
integer<int32>
​
HasNextPage
boolean