Skip to main content
PATCH
Update Cashback Rule

Autorisationer

Authorization
string
header
påkrævet

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.

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

ID of the cashback rule, prefixed cicbr_.

Krop

application/json
description
string | null

Description of the rule. Set null to clear it.

Maximum string length: 255
Eksempel:

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

Eksempel:

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

merchant_category_code
string | null

Four-digit MCC, including leading zeros. Null matches any MCC. When both merchant filters are absent, scoped_account_id is required.

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

"7372"

merchant_name
string | null

Raw merchant name reported by the card provider. Set null to match any merchant name. Supplied names must contain a non-whitespace character and match together with any MCC filter. Clearing both filters requires an existing scoped_account_id.

Required string length: 1 - 128
Eksempel:

"ACME CLOUD"

Svar

cashback rule updated

created_at
string
påkrævet

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

Eksempel:

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

description
string | null
påkrævet

Optional description of the cashback rule.

Eksempel:

"Cloud cashback"

discarded_at
string | null
påkrævet

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

Eksempel:

null

expires_at
string | null
påkrævet

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

Eksempel:

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

funding_account_id
string
påkrævet

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

Eksempel:

"biz_xxxxxxxxxxxxxx"

id
string
påkrævet

Cashback rule ID, prefixed cicbr_.

Eksempel:

"cicbr_xxxxxxxxxxxxxx"

merchant_category_code
string | null
påkrævet

Four-digit merchant category code. Null matches any MCC. When both merchant filters are null, scoped_account_id is required.

Eksempel:

"7372"

merchant_name
string | null
påkrævet

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.

Eksempel:

"ACME CLOUD"

rate_bps
integer
påkrævet

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

Eksempel:

500

scoped_account_id
string | null
påkrævet

Subaccount ID, prefixed biz_. Null designates all direct subaccounts of the funding platform.

Eksempel:

"biz_xxxxxxxxxxxxxx"

starts_at
string
påkrævet

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

Eksempel:

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

updated_at
string
påkrævet

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

Eksempel:

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