Skip to main content
Hver regel angiver en sats, et berettigelsesvindue og valgfrie forhandlerfiltre og kan begrænses til én underkonto. Brug Cashback Rules API’et til at oprette, opdatere og liste de regler, din platform finansierer, og udbetal derefter cashback efter behov fra din tilgængelige USD-saldo.

Endpoints

Udbetal cashback

Send et tomt objekt til POST /cashback_rules/payout for at udbetale al berettiget cashback. Angiv cashback_rule_id for at udbetale én regel, account_id for at betale én underkonto eller transaction_id for at betale én korttransaktion. Flere filtre skal alle matche.
Brug en Idempotency-Key-header, når du anmoder om en udbetaling. Et 202-svar med status: "processing" bekræfter, at behandlingen blev sat i kø, og gentager de angivne filtre. Et 200-svar med status: "failed" betyder, at køen afviste anmodningen. Disse statusser beskriver planlægning, ikke gennemførelse af betaling. Transaktionsjobs genforsøger fejl automatisk. Tilføj USD til finansieringstegnebogen, hvis den har utilstrækkelige midler. Gentagne anmodninger springer betalinger over, der allerede er registreret, og ledger-idempotens forhindrer dobbelte krediteringer. Svar:

Attributter

string
påkrævet
Cashback-regel-ID med præfikset cicbr_.
string
påkrævet
Hvornår reglen blev oprettet, som et ISO 8601-tidsstempel.
string | null
påkrævet
Valgfri beskrivelse af cashback-reglen.
string | null
påkrævet
Hvornår reglen blev kasseret, som et ISO 8601-tidsstempel. Null betyder, at den ikke er blevet kasseret.
string | null
påkrævet
Eksklusiv afslutning på berettigelsesvinduet som et ISO 8601-tidsstempel. Null betyder intet udløb.
string
påkrævet
Platformskonto udpeget til at finansiere cashback, med præfikset biz_. Afledt af de godkendte legitimationsoplysninger.
string | null
påkrævet
Firecifret forhandlerkategorikode. Null matcher enhver MCC. Når begge forhandlerfiltre er null, er scoped_account_id påkrævet.
string | null
påkrævet
Rå forhandlernavn rapporteret af kortudbyderen. Null matcher ethvert forhandlernavn. Når angivet, matcher det sammen med et eventuelt MCC-filter; ikke et delstrengs- eller beriget visningsnavnsmatch.
integer
påkrævet
Cashback-sats i basispoint. 100 betyder 1 %, og 10000 betyder 100 %.
string | null
påkrævet
Underkonto-ID med præfikset biz_. Null udpeger alle direkte underkonti af den finansierende platform.
string
påkrævet
Inklusiv start på reglens berettigelsesvindue som et ISO 8601-tidsstempel.
string
påkrævet
Hvornår reglen sidst blev opdateret, som et ISO 8601-tidsstempel.
CashbackRule