Skip to main content
PATCH
Update Cashback Rule

Authorizations

Authorization
string
header
required

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

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-11"

Path Parameters

id
string
required

ID of the cashback rule, prefixed cicbr_.

Body

application/json
description
string | null

Description of the rule. Set null to clear it.

Maximum string length: 255
Example:

"Cloud cashback"

expires_at
string<date-time> | null

Exclusive end as an ISO 8601 timestamp, strictly later than the original starts_at. May be in the past to end an active rule. Set null to remove the expiration.

Example:

"2026-01-01T12:00:00.000Z"

merchant_category_code
string

Four-digit MCC, including leading zeros. Must match together with merchant_name.

Required string length: 4
Pattern: ^[0-9]{4}$
Example:

"7372"

merchant_name
string

Raw merchant name reported by the card provider. Must contain a non-whitespace character. Matched with the MCC; not a substring or wildcard.

Required string length: 1 - 128
Example:

"ACME CLOUD"

Response

cashback rule updated

created_at
string
required

When the rule was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

description
string | null
required

Optional description of the cashback rule.

Example:

"Cloud cashback"

discarded_at
string | null
required

When the rule was discarded, as an ISO 8601 timestamp. Null means it has not been discarded.

expires_at
string | null
required

Exclusive end of the eligibility window, as an ISO 8601 timestamp. Null means no expiration.

Example:

"2026-01-01T12:00:00.000Z"

funding_account_id
string
required

Platform account designated to fund cashback, prefixed biz_. Derived from the authenticated credential.

Example:

"biz_xxxxxxxxxxxxxx"

id
string
required

Cashback rule ID, prefixed cicbr_.

Example:

"cicbr_xxxxxxxxxxxxxx"

merchant_category_code
string
required

Four-digit merchant category code. Both merchant filters must match.

Example:

"7372"

merchant_name
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.

Example:

"ACME CLOUD"

rate_bps
integer
required

Cashback rate in basis points. 100 means 1%, and 10000 means 100%.

Example:

500

scoped_account_id
string | null
required

Connected account ID, prefixed biz_. Null designates all direct connected accounts of the funding platform.

Example:

"biz_xxxxxxxxxxxxxx"

starts_at
string
required

Inclusive start of the rule's eligibility window, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

updated_at
string
required

When the rule was last updated, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"