Skip to main content
A Cashback Rule pays a platform’s direct connected accounts back a share of their card spend, funded by the platform. Each rule sets a rate, an eligibility window, and optional merchant filters, and can be limited to one connected account. Use the Cashback Rules API to create, update, and list the rules your platform funds, then pay out cashback on demand from your available USD balance.

​
Endpoints

​
Pay out cashback

Send an empty object to POST /cashback_rules/payout to distribute all eligible cashback. Set cashback_rule_id to distribute one rule, account_id to pay one connected account, or transaction_id to pay one card transaction. Multiple filters must all match.
Use an Idempotency-Key header when requesting a payout. A 202 response with status: "processing" confirms that processing was queued and echoes the supplied filters. A 200 response with status: "failed" means the queue rejected the request. These statuses describe scheduling, not payment completion. Transaction jobs retry failures automatically. Add USD to the funding wallet if it has insufficient funds. Repeated requests skip payments already recorded, and ledger idempotency prevents duplicate credits. Response:

​
Attributes

​
string
required
Cashback rule ID, prefixed cicbr_.
​
string
required
When the rule was created, as an ISO 8601 timestamp.
​
string | null
required
Optional description of the cashback rule.
​
string | null
required
When the rule was discarded, as an ISO 8601 timestamp. Null means it has not been discarded.
​
string | null
required
Exclusive end of the eligibility window, as an ISO 8601 timestamp. Null means no expiration.
​
string
required
Platform account designated to fund cashback, prefixed biz_. Derived from the authenticated credential.
​
string | null
required
Four-digit merchant category code. Null matches any MCC. When both merchant filters are null, scoped_account_id is required.
​
string | null
required
Raw merchant name reported by the card provider. Null matches any merchant name. When set, matches together with any MCC filter; not a substring or enriched display-name match.
​
integer
required
Cashback rate in basis points. 100 means 1%, and 10000 means 100%.
​
string | null
required
Connected account ID, prefixed biz_. Null designates all direct connected accounts of the funding platform.
​
string
required
Inclusive start of the rule’s eligibility window, as an ISO 8601 timestamp.
​
string
required
When the rule was last updated, as an ISO 8601 timestamp.
CashbackRule