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"
}
'import requests
url = "https://api.bonifiq.com.br/v1/pvt/Points/toexpire"
payload = {
"PageNumber": 123,
"PageSize": 123,
"From": "2023-11-07T05:31:56Z",
"To": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
PageNumber: 123,
PageSize: 123,
From: '2023-11-07T05:31:56Z',
To: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.bonifiq.com.br/v1/pvt/Points/toexpire', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bonifiq.com.br/v1/pvt/Points/toexpire",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'PageNumber' => 123,
'PageSize' => 123,
'From' => '2023-11-07T05:31:56Z',
'To' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bonifiq.com.br/v1/pvt/Points/toexpire"
payload := strings.NewReader("{\n \"PageNumber\": 123,\n \"PageSize\": 123,\n \"From\": \"2023-11-07T05:31:56Z\",\n \"To\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bonifiq.com.br/v1/pvt/Points/toexpire")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"PageNumber\": 123,\n \"PageSize\": 123,\n \"From\": \"2023-11-07T05:31:56Z\",\n \"To\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bonifiq.com.br/v1/pvt/Points/toexpire")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"PageNumber\": 123,\n \"PageSize\": 123,\n \"From\": \"2023-11-07T05:31:56Z\",\n \"To\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"Items": [
{
"Id": 123,
"PointId": 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>",
"PointMetadatas": {}
}
],
"TotalItemCount": 123,
"PageSize": 123,
"PageNumber": 123,
"HasNextPage": true
}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
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"
}
'import requests
url = "https://api.bonifiq.com.br/v1/pvt/Points/toexpire"
payload = {
"PageNumber": 123,
"PageSize": 123,
"From": "2023-11-07T05:31:56Z",
"To": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
PageNumber: 123,
PageSize: 123,
From: '2023-11-07T05:31:56Z',
To: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.bonifiq.com.br/v1/pvt/Points/toexpire', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bonifiq.com.br/v1/pvt/Points/toexpire",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'PageNumber' => 123,
'PageSize' => 123,
'From' => '2023-11-07T05:31:56Z',
'To' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bonifiq.com.br/v1/pvt/Points/toexpire"
payload := strings.NewReader("{\n \"PageNumber\": 123,\n \"PageSize\": 123,\n \"From\": \"2023-11-07T05:31:56Z\",\n \"To\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bonifiq.com.br/v1/pvt/Points/toexpire")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"PageNumber\": 123,\n \"PageSize\": 123,\n \"From\": \"2023-11-07T05:31:56Z\",\n \"To\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bonifiq.com.br/v1/pvt/Points/toexpire")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"PageNumber\": 123,\n \"PageSize\": 123,\n \"From\": \"2023-11-07T05:31:56Z\",\n \"To\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"Items": [
{
"Id": 123,
"PointId": 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>",
"PointMetadatas": {}
}
],
"TotalItemCount": 123,
"PageSize": 123,
"PageNumber": 123,
"HasNextPage": true
}Authorizations
Use API Basic Auth Keys
Body
application/json
Filter containing the optional date range (From, To) for expiration dates and pagination parameters (PageNumber, PageSize).
Request filter for retrieving expiring points via the external API.
Pagenation number
Amount of items per page, Max size is 50 items per page.
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").
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").
Was this page helpful?