---
title: "Get cashback balance for a payment token"
method: POST
path: "/tokenized-payment/v1/tokens/cashback-balance"
tags: ["Pre-Auth"]
---

# Get cashback balance for a payment token

`POST /tokenized-payment/v1/tokens/cashback-balance`

## Request

- Base URL: `https://integrations-sandbox.shopback.com/demo/merchant`
- URL: `https://integrations-sandbox.shopback.com/demo/merchant/tokenized-payment/v1/tokens/cashback-balance`
- 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)

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

## Request body

- GetCashbackBalanceRequest
  - `paymentToken` string, required: Payment token issued by ShopBack to identify the linked ShopBack user.

## Response `200`

- GetCashbackBalanceResponse
  - `cashbackBalance` number, required: Available cashback balance in major units (e.g. 15.00 = $15.00).
  - `currency` string, required: 3-letter ISO currency code for the balance.

## Other responses

- `400`: The paymentToken field is required.
- `401`: Missing or invalid merchant JWT, or the payment token was not found, has been unlinked, or belongs to a different merchant.

---

[API](https://skmtc.dev/shopback/apis/online-payments-api.md) - [All operations](https://skmtc.dev/shopback/apis/online-payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/shopback/apis/online-payments-api/revisions/a3ac503a275e?raw)