Create Cashback Rule
Creates a future-dated card cashback rule funded by the authenticated platform account. Requires payout:transfer_funds. Both the raw merchant name and four-digit MCC are required. Optionally limit the rule to one direct connected account. The funding account is derived from the credential and cannot be supplied. Creation does not transfer funds. Supports Idempotency-Key for safe retries.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
Client-generated key for replaying the same request safely for 24 hours.
1 - 255Pins the request to a dated API version.
"2026-09-09"
Body
Four-digit MCC, including leading zeros. Must match together with merchant_name.
^[0-9]{4}$"5734"
Raw merchant name reported by the card provider, not the enriched display name. Matched with the MCC; not a substring or wildcard.
1 - 128"ACME SOFTWARE"
Cashback rate in basis points: 500 means 5%.
1 <= x <= 10000500
Inclusive start, strictly later than the current time, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
Optional description of the rule.
255"Software cashback"
Exclusive end, strictly later than starts_at. Omit or set null for no expiration.
"2026-01-01T12:00:00.000Z"
Account ID prefixed biz_ belonging to a direct connected account. Omit or set null to designate all direct connected accounts.
^biz_Response
cashback rule created
When the rule was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
Optional description of the cashback rule.
"Software cashback"
When the rule was discarded, as an ISO 8601 timestamp. Null means it has not been discarded.
Exclusive end of the eligibility window, as an ISO 8601 timestamp. Null means no expiration.
"2026-01-01T12:00:00.000Z"
Platform account designated to fund cashback, prefixed biz_. Derived from the authenticated credential.
"biz_xxxxxxxxxxxxxx"
Cashback rule ID, prefixed cicbr_.
"cicbr_xxxxxxxxxxxxxx"
Four-digit merchant category code. Both merchant filters must match.
"5734"
Raw merchant name reported by the card provider. Matched together with the merchant category code; not a substring or enriched display-name match.
"ACME SOFTWARE"
Cashback rate in basis points. 100 means 1%, and 10000 means 100%.
500
Connected account ID, prefixed biz_. Null designates all direct connected accounts of the funding platform.
Inclusive start of the rule's eligibility window, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
When the rule was last updated, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"

