Returns earned points that can be used to track received-point events and customer notification flows.

curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints', 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/Reports/ListReceivedPoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "Items": [
    {
      "Id": "<string>",
      "EventDate": "2023-11-07T05:31:56Z",
      "Points": 123,
      "Cashback": 123,
      "ExpirationDate": "2023-11-07T05:31:56Z",
      "Type": 0,
      "Customer": {
        "OriginalId": "<string>",
        "PublicId": "<string>",
        "Name": "<string>",
        "Email": "<string>",
        "Phone": "<string>",
        "BirthdayDate": "2023-11-07T05:31:56Z",
        "SignupDate": "2023-11-07T05:31:56Z",
        "Document": "<string>",
        "IsEnrolled": true,
        "ReferralURL": "<string>",
        "WhatsappReferralUrl": "<string>",
        "CurrentTier": {
          "Name": "<string>",
          "Color": "<string>",
          "IconUrl": "<string>"
        },
        "BalanceOfPoints": 123,
        "BalanceCashback": 123
      },
      "NotificationDate": "2023-11-07T05:31:56Z",
      "CashbackPercent": 123,
      "TotalCashbackAvailable": 123,
      "Order": {
        "Id": 123,
        "OriginalId": "<string>",
        "OrderPlacementDate": "2023-11-07T05:31:56Z",
        "OrderCompletedDate": "2023-11-07T05:31:56Z",
        "OrderCancelledDate": "2023-11-07T05:31:56Z",
        "OrderStatus": "<string>",
        "IsCancelledOrReturned": true,
        "IsCompleted": true,
        "OrderTotal": 123,
        "Customer": {
          "Id": 123,
          "OriginalId": "<string>",
          "Name": "<string>",
          "Email": "<string>",
          "Phone": "<string>",
          "BirthdayDate": "2023-11-07T05:31:56Z",
          "SignupDate": "2023-11-07T05:31:56Z",
          "Document": "<string>",
          "IsEnrolled": true,
          "PointsBalance": 123,
          "BalanceOfPoints": 123,
          "Cashback": 123,
          "BirthdayUpdateDate": "2023-11-07T05:31:56Z",
          "FirstName": "<string>",
          "PublicId": "<string>",
          "SecondaryId": "<string>",
          "OrderCount": 123,
          "ReasonEnrolled": "<string>",
          "AdminId": 123,
          "EmailAdmin": "<string>",
          "EnrolledDate": "2023-11-07T05:31:56Z",
          "TierName": "<string>",
          "Origin": 0,
          "RfmGroup": 0,
          "RfmGroupName": "<string>",
          "Affiliate": {
            "Id": 123,
            "CustomerId": 123,
            "IsActive": true,
            "AffiliateCoupon": "<string>",
            "LastUpdated": "2023-11-07T05:31:56Z",
            "CouponHistories": [
              {
                "Id": 123,
                "AffiliateId": 123,
                "Coupon": "<string>",
                "AssociatedDate": "2023-11-07T05:31:56Z"
              }
            ]
          },
          "AffiliateCode": "<string>",
          "AffiliateCodeAssignedAt": "2023-11-07T05:31:56Z"
        },
        "Products": [
          {
            "OriginalId": "<string>",
            "Title": "<string>",
            "Url": "<string>",
            "ImageUrl": "<string>",
            "IsActive": true,
            "ProductPrice": 123
          }
        ],
        "UpdatedDate": "2023-11-07T05:31:56Z",
        "Coupon": "<string>",
        "State": 0,
        "Origin": 0,
        "Branch": {
          "Id": 123,
          "OriginalId": "<string>",
          "Name": "<string>"
        },
        "TenantSalesman": {
          "Id": 123,
          "OriginalId": "<string>",
          "Name": "<string>",
          "Store": "<string>",
          "Branch": {
            "Id": 123,
            "OriginalId": "<string>",
            "Name": "<string>"
          },
          "BranchId": 123
        },
        "Metadatas": [
          {
            "Id": 123,
            "OrderId": 123,
            "Name": "<string>",
            "Value": "<string>"
          }
        ],
        "ExternalCoupon": "<string>"
      },
      "Objective": {
        "Id": 123,
        "Title": "<string>",
        "Description": "<string>",
        "Type": 0
      },
      "PurchaseDetails": [
        {
          "Type": 0,
          "TypeDescription": "<string>",
          "SingleMessage": "<string>",
          "ScheduleIds": [
            123
          ]
        }
      ]
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true,
  "HasError": true,
  "ErrorMessages": [
    "<string>"
  ]
}

Reports

Returns earned points that can be used to track received-point events and customer notification flows.

Use this endpoint when the integration needs the list of points received by customers in a period, especially for “points available” communication and notification use cases.

This endpoint returns earned/received point entries only and depends on the tenant’s points-available notification configuration. If that notification feature is disabled, the response is an empty list.

The result includes the structured Customer node, the associated Order when the point was generated from a purchase, the associated Objective when available, expiration/cashback information, and the notification date calculated from the notification cadence.

When includePurchaseDetails is true, the response includes PurchaseDetails only for purchase points that have persisted purchase calculation details. Pagination is applied before these details are loaded, so PurchaseDetails is resolved only for purchase points in the current page.

For a complete historical report of all point movements, including rewards, expirations, refunds and other non-earned point types, use ListPointsReport instead.

GET

pvt

Reports

ListReceivedPoints

Returns earned points that can be used to track received-point events and customer notification flows.

curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints', 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/Reports/ListReceivedPoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bonifiq.com.br/v1/pvt/Reports/ListReceivedPoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "Items": [
    {
      "Id": "<string>",
      "EventDate": "2023-11-07T05:31:56Z",
      "Points": 123,
      "Cashback": 123,
      "ExpirationDate": "2023-11-07T05:31:56Z",
      "Type": 0,
      "Customer": {
        "OriginalId": "<string>",
        "PublicId": "<string>",
        "Name": "<string>",
        "Email": "<string>",
        "Phone": "<string>",
        "BirthdayDate": "2023-11-07T05:31:56Z",
        "SignupDate": "2023-11-07T05:31:56Z",
        "Document": "<string>",
        "IsEnrolled": true,
        "ReferralURL": "<string>",
        "WhatsappReferralUrl": "<string>",
        "CurrentTier": {
          "Name": "<string>",
          "Color": "<string>",
          "IconUrl": "<string>"
        },
        "BalanceOfPoints": 123,
        "BalanceCashback": 123
      },
      "NotificationDate": "2023-11-07T05:31:56Z",
      "CashbackPercent": 123,
      "TotalCashbackAvailable": 123,
      "Order": {
        "Id": 123,
        "OriginalId": "<string>",
        "OrderPlacementDate": "2023-11-07T05:31:56Z",
        "OrderCompletedDate": "2023-11-07T05:31:56Z",
        "OrderCancelledDate": "2023-11-07T05:31:56Z",
        "OrderStatus": "<string>",
        "IsCancelledOrReturned": true,
        "IsCompleted": true,
        "OrderTotal": 123,
        "Customer": {
          "Id": 123,
          "OriginalId": "<string>",
          "Name": "<string>",
          "Email": "<string>",
          "Phone": "<string>",
          "BirthdayDate": "2023-11-07T05:31:56Z",
          "SignupDate": "2023-11-07T05:31:56Z",
          "Document": "<string>",
          "IsEnrolled": true,
          "PointsBalance": 123,
          "BalanceOfPoints": 123,
          "Cashback": 123,
          "BirthdayUpdateDate": "2023-11-07T05:31:56Z",
          "FirstName": "<string>",
          "PublicId": "<string>",
          "SecondaryId": "<string>",
          "OrderCount": 123,
          "ReasonEnrolled": "<string>",
          "AdminId": 123,
          "EmailAdmin": "<string>",
          "EnrolledDate": "2023-11-07T05:31:56Z",
          "TierName": "<string>",
          "Origin": 0,
          "RfmGroup": 0,
          "RfmGroupName": "<string>",
          "Affiliate": {
            "Id": 123,
            "CustomerId": 123,
            "IsActive": true,
            "AffiliateCoupon": "<string>",
            "LastUpdated": "2023-11-07T05:31:56Z",
            "CouponHistories": [
              {
                "Id": 123,
                "AffiliateId": 123,
                "Coupon": "<string>",
                "AssociatedDate": "2023-11-07T05:31:56Z"
              }
            ]
          },
          "AffiliateCode": "<string>",
          "AffiliateCodeAssignedAt": "2023-11-07T05:31:56Z"
        },
        "Products": [
          {
            "OriginalId": "<string>",
            "Title": "<string>",
            "Url": "<string>",
            "ImageUrl": "<string>",
            "IsActive": true,
            "ProductPrice": 123
          }
        ],
        "UpdatedDate": "2023-11-07T05:31:56Z",
        "Coupon": "<string>",
        "State": 0,
        "Origin": 0,
        "Branch": {
          "Id": 123,
          "OriginalId": "<string>",
          "Name": "<string>"
        },
        "TenantSalesman": {
          "Id": 123,
          "OriginalId": "<string>",
          "Name": "<string>",
          "Store": "<string>",
          "Branch": {
            "Id": 123,
            "OriginalId": "<string>",
            "Name": "<string>"
          },
          "BranchId": 123
        },
        "Metadatas": [
          {
            "Id": 123,
            "OrderId": 123,
            "Name": "<string>",
            "Value": "<string>"
          }
        ],
        "ExternalCoupon": "<string>"
      },
      "Objective": {
        "Id": 123,
        "Title": "<string>",
        "Description": "<string>",
        "Type": 0
      },
      "PurchaseDetails": [
        {
          "Type": 0,
          "TypeDescription": "<string>",
          "SingleMessage": "<string>",
          "ScheduleIds": [
            123
          ]
        }
      ]
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true,
  "HasError": true,
  "ErrorMessages": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Query Parameters

from

string<date-time>

Start date for filtering points by event date.

string<date-time>

End date for filtering points by event date. When omitted or default, DateTime.UtcNow is used.

PointTypes

enum<integer>[] | null

Optional list of point types to include in the received-points result.

0 = Purchase 1 = Signup 2 = Birthday 3 = Ordinary 4 = Reward 5 = Review 6 = Refund 7 = Expire 8 = Referral 9 = SocialMediaFollowFacebook 10 = SocialMediaFollowInstagram 11 = PartialOrderRefund 12 = Quiz 13 = CustomObjective 14 = ReferralAffiliate 15 = SocialMediaFollowLinkedin 16 = SocialMediaFollowTikTok 17 = Campaign 18 = Participation 19 = Fitness

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

13,

14,

15,

16,

17,

18,

19

pageNumber

integer<int32>

default:1

Page number for pagination (default: 1).

pageSize

integer<int32>

default:10

Number of items per page (default: 10, max: 10000).

includePurchaseDetails

boolean

default:false

When true, includes purchase point calculation details for purchase points in the returned page when available. Default is false for backward compatibility.

Response

200 - application/json

Paginated list of received point entries for customer notification/integration workflows.

Base List response model methods

Items

object[] | null

Collection with the found entities on the bonifiq DB.

Show child attributes

TotalItemCount

integer<int32>

Total of rewards Configurations founds.

PageSize

integer<int32>

Pagination size

PageNumber

integer<int32>

Actual Page Number

HasNextPage

boolean

true if there is another page to be load.

HasError

boolean

If true the request had an error.

ErrorMessages

string[]

List with the error messages