Pay Out Cashback
Pays out cashback on demand from the authenticated platform’s available USD balance to its direct connected accounts. Covers completed, unpaid card transactions created before the request, each under its latest matching rule, which must be funded by the authenticated platform. Filters combine, and an empty body includes every eligible transaction. Payouts process in the background and amounts are calculated then, so the response confirms queuing, not payment. If a payout fails for insufficient funds, add USD to the platform’s balance. Requires payout:transfer_funds. Supports Idempotency-Key, and overlapping requests cannot pay the same card transaction twice.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
Client-generated key for replaying the same request safely for 24 hours.
1 - 255Pins the request to a dated API version.
"2026-10-14"
Body
Pay only this direct connected account.
^biz_Pay only transactions whose winning cashback rule has this ID and is funded by the authenticated platform.
^cicbr_Pay only this card transaction belonging to a direct connected account.
^citx_"citx_xxxxxxxxxxxxxx"
Response
queue rejected the request
Request status. processing means background processing was queued, not that payment completed. failed, returned with HTTP 200, means the queue rejected the request. Subsequent transaction failures retry automatically.
processing, failed "failed"
Connected account filter from the request, prefixed biz_. Omitted when not supplied.
Cashback rule filter from the request, prefixed cicbr_. Omitted when not supplied.
Card transaction filter from the request, prefixed citx_. Omitted when not supplied.
"citx_xxxxxxxxxxxxxx"

