Skip to main content
Elke regel stelt een percentage, een geschiktheidsperiode en optionele merchantfilters in, en kan worden beperkt tot één subaccount. Gebruik de Cashback Rules API om de regels die je platform financiert aan te maken, bij te werken en weer te geven, en betaal cashback op aanvraag uit vanuit je beschikbare USD-saldo.

Endpoints

Cashback uitbetalen

Stuur een leeg object naar POST /cashback_rules/payout om alle in aanmerking komende cashback uit te keren. Stel cashback_rule_id in om één regel uit te keren, account_id om één subaccount te betalen, of transaction_id om één kaarttransactie te betalen. Meerdere filters moeten allemaal overeenkomen.
Gebruik een Idempotency-Key-header wanneer je een uitbetaling aanvraagt. Een 202-response met status: "processing" bevestigt dat de verwerking in de wachtrij is geplaatst en herhaalt de opgegeven filters. Een 200-response met status: "failed" betekent dat de wachtrij het verzoek heeft geweigerd. Deze statussen beschrijven de planning, niet de voltooiing van de betaling. Transactiejobs proberen mislukte pogingen automatisch opnieuw. Voeg USD toe aan de financieringswallet als die onvoldoende saldo heeft. Herhaalde verzoeken slaan betalingen over die al zijn vastgelegd, en idempotentie in het grootboek voorkomt dubbele creditering. Response:

Attributen

string
vereist
Cashbackregel-ID, met prefix cicbr_.
string
vereist
Wanneer de regel is aangemaakt, als ISO 8601-tijdstempel.
string | null
vereist
Optionele beschrijving van de cashbackregel.
string | null
vereist
Wanneer de regel is verwijderd, als ISO 8601-tijdstempel. Null betekent dat deze niet is verwijderd.
string | null
vereist
Exclusief einde van de geschiktheidsperiode, als ISO 8601-tijdstempel. Null betekent geen vervaldatum.
string
vereist
Platformaccount dat is aangewezen om cashback te financieren, met prefix biz_. Afgeleid uit de geauthenticeerde credential.
string | null
vereist
Viercijferige merchant category code. Null komt overeen met elke MCC. Wanneer beide merchantfilters null zijn, is scoped_account_id vereist.
string | null
vereist
Ruwe merchantnaam zoals gerapporteerd door de kaartprovider. Null komt overeen met elke merchantnaam. Wanneer ingesteld, wordt deze samen met een eventueel MCC-filter gematcht; geen substring- of verrijkte weergavenaam-match.
integer
vereist
Cashbackpercentage in basispunten. 100 betekent 1% en 10000 betekent 100%.
string | null
vereist
Subaccount-ID, met prefix biz_. Null wijst alle directe subaccounts van het financierende platform aan.
string
vereist
Inclusief begin van de geschiktheidsperiode van de regel, als ISO 8601-tijdstempel.
string
vereist
Wanneer de regel voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.
CashbackRule