Sign in

v1

latestOpenAPI 3.0.12026-07-24204977.5 KB
Pre-Auth

Get cashback balance for a payment token

Returns the user's available cashback balance for the merchant channel associated with the payment token.

post/tokenized-payment/v1/tokens/cashback-balance

Request body

paymentTokenstring required

Payment token issued by ShopBack to identify the linked ShopBack user.

Example request

{
  "paymentToken": "aBcD1234eFgH5678iJkL9012mNoP3456"
}

Response

cashbackBalancenumber required

Available cashback balance in major units (e.g. 15.00 = $15.00).

currencystring required

3-letter ISO currency code for the balance.

Example response

{
  "cashbackBalance": 15,
  "currency": "SGD"
}