Pay Out Cashback
Distributes cashback on demand from the authenticated platform’s available USD balance to its direct connected accounts. Requires payout:transfer_funds. Optional filters combine; an empty body includes all eligible transactions. Only completed, unpaid transactions created before this request are considered. The latest matching rule wins; its funding account must be the authenticated platform. Amounts are calculated when processed. Returns status processing and echoes supplied filters when background processing is queued. Status failed with HTTP 200 means the queue rejected the request. This is not a payment confirmation. Failed transaction jobs retry automatically; insufficient funds requires adding USD to the funding wallet. 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-09-24"
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 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"

