Settlement and marketing balances
The client's settlement balance and its marketing balance.
/v1/clients/{clientId}/marketingThe client's settlement balance and its marketing balance. Settlement is sharded, so the figure is the sum across shards; a client that has neither account yet reads zero rather than an error. Needs authority over the client — membership of its organization, an API key bound to this client, or tenant staff holding clients:manage; anything else is refused not_client_member or insufficient_scope (403), and an unknown client client_not_found (404).
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/marketing"{ "settlement_balance": 0, "marketing_balance": 0}Delivery attempts to the merchant's endpoints
Delivery attempts to this merchant's endpoints, newest first, with response code and error.
Move the client's settlement money into its marketing account
Moves money from the client's settlement balance into its marketing account, where cashback rules draw from.