Skip to main content
POST
Pay Out Cashback

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string

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

Required string length: 1 - 255
Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-14"

Body

application/json
account_id
string | null

Pay only this direct connected account.

Pattern: ^biz_
cashback_rule_id
string | null

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

Pattern: ^cicbr_
transaction_id
string | null

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

Pattern: ^citx_
Example:

"citx_xxxxxxxxxxxxxx"

Response

queue rejected the request

status
enum<string>
required

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.

Available options:
processing,
failed
Example:

"failed"

account_id
string | null

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

cashback_rule_id
string | null

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

transaction_id
string | null

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

Example:

"citx_xxxxxxxxxxxxxx"