Skip to main content
All endpoints below require:
  • X-Application-Id
  • X-Api-Key

GET /sdk/v1/wallet/balance

Get the agency wallet balance summary.

Response

POST /sdk/v1/wallet/check-payout-balance

Check whether the wallet can cover a payout (including platform fee and settlement rules). This endpoint returns a bare { sufficient: boolean } object (no success wrapper).

Body

Uses the same payload rules as POST /sdk/v1/payouts/trigger, except payoutRecipientEmail is optional. If you include platformFeePayerOverride and, when needed, platformFeeAgencySharePercent, the affordability check uses that override when calculating the required wallet debit.

Response

Common errors

  • 400: invalid payload (currency not supported, >2 decimals, missing amount, etc.)
  • 401: missing/invalid SDK headers
  • 403: origin not allowed (when allowlist is configured and Origin is present)

POST /sdk/v1/wallet/check-payout-balance-bulk

Check whether the wallet can cover the total of up to 100 payouts. This endpoint returns a bare { sufficient: boolean } object (no success wrapper).

Body

Response