Pre-Auth

Get cashback balance for a payment token

(ONLY IN PRODUCTION) Returns the user's available cashback balance for the merchant channel associated with the payment token.

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

Request

Base URL
https://integrations-sandbox.shopback.com/demo/merchant
Auth
HTTP bearer
TypeScript
https://skmtc.dev/shopback/apis/online-payments-api/docs/tokenized-payment/v1/tokens/cashback-balance/post.ts
A function with typed inputs. Its response is checked against the schema.

paymentTokenstring required

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

{
  "paymentToken": "aBcD1234eFgH5678iJkL9012mNoP3456"
}

cashbackBalancenumber required

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

currencystring required

3-letter ISO currency code for the balance.

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

No recorded changes to this operation across all 2 revisions of this API.