v1

latestOpenAPI 3.0.32026-07-24153644.3 KB

RewardsService

Retrieve a calculated rewards balance for a specified customer.

This endpoint is designed to provide a detailed customer balance.

The response includes pertinent information about the customer balance, such as: unavailable balance, available balance, next purchase available balance and the first due date for next purchase value.

For now, we will return only the description of the campaign related to rewards availables on next purchase.

get/api/v1alpha1/customers/{customerId}/balance

Path parameters

customerIdstring required

The customer identifier must be the same as that sent to Dito.

Query parameters

storeIdstring

The store identifier must be the same as that sent to Dito.

Headers

Brandstring required

The brand label provided by us.

Response

A successful response.

unavailableBalancestring

availableBalancestring

Amount of cashback that is available to be consumed.

nextPurchaseBalancestring

Amount of cashback that is available for the next purchase based on redemption rules.

nextPurchaseFirstDueDatestring date-time

First due date of the rewards that make up the balance of the next purchase.

Example response

{
  "nextPurchaseFirstDueDate": "2024-02-02T04:22:18-03:00",
  "campaign": {
    "id": 1,
    "name": "Every store with 10 cashback",
    "description": "All products have a 10% cashback until the end of the month or the end of stock. The cashback will be available 7 days after the purchase date and can be used for up to 20% of the next purchase."
  }
}