Skip to main content

Overview

Every Dancity merchant account has one or more wallets (e.g., main, bonus). Your API key is tied to a specific account, so calling the wallet endpoint always returns balances for that account. Use wallet balances to:
  • Display a live balance before processing a purchase
  • Check which wallet type (wallettype) to pass in a buy request
  • Detect low-balance conditions and alert your team

Authentication

Wallet reads use your merchant API key only — no channel: API header is required for this endpoint.

Get wallets balance

Returns all wallets linked to the API key’s account, including their types and current balances.

Example

Sample response

Using wallet types in purchases

Most buy endpoints accept an optional wallettype field. Omit it to debit your main wallet, or pass a value from GET /api/v1/wallet (e.g. "main", "bonus").
If your balance is insufficient for the purchase amount, the API returns a 400 error with a message indicating low balance. Always check balances before bulk purchase flows.

Next steps