Sign in
Cashback Rules

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.

post/cashback_rules/payout

Headers

Idempotency-Keystring

Client-generated key for replaying the same request safely for 24 hours.

Request body

account_idstring nullable

Pay only this direct connected account.

cashback_rule_idstring nullable

Pay only transactions whose winning cashback rule has this ID and is funded by the authenticated platform.

transaction_idstring nullable

Pay only this card transaction belonging to a direct connected account.

Example request

{
  "transaction_id": "citx_xxxxxxxxxxxxxx"
}

Response

queue rejected the request

account_idstring nullable

Connected account filter from the request, prefixed biz_. Omitted when not supplied.

cashback_rule_idstring nullable

Cashback rule filter from the request, prefixed cicbr_. Omitted when not supplied.

status'processing' | 'failed' required

Request status. processing means background processing was queued, not that payment completed. failed means the queue rejected the request. Subsequent transaction failures retry automatically.

transaction_idstring nullable

Card transaction filter from the request, prefixed citx_. Omitted when not supplied.

Example response

{
  "status": "failed",
  "transaction_id": "citx_xxxxxxxxxxxxxx"
}

Changes

Changed in 1 of the 74 revisions of this API.1

Of the 74 revisions, 1 has no diff computed.