Skip to main content
Cashback rules designate a funding platform, a merchant name and category, a rate, and an eligibility window. An optional account ID limits the rule to one of the platform’s direct connected accounts. Use the Cashback Rules API to create future-dated rules and list every rule funded by the authenticated platform, including expired and discarded rules. Creating a rule does not transfer funds.

​
Endpoints

​
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
required
Four-digit merchant category code. Both merchant filters must match.
​
string
required
Raw merchant name reported by the card provider. Matched together with the merchant category code; 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