Skip to main content
Chaque règle définit un taux, une période d’éligibilité et des filtres marchands facultatifs, et peut être limitée à un seul sous-compte. Utilisez l’API Cashback Rules pour créer, mettre à jour et lister les règles que votre plateforme finance, puis versez le cashback à la demande depuis votre solde USD disponible.

Endpoints

Verser le cashback

Envoyez un objet vide à POST /cashback_rules/payout pour distribuer tout le cashback éligible. Définissez cashback_rule_id pour distribuer une seule règle, account_id pour payer un seul sous-compte, ou transaction_id pour payer une seule transaction par carte. Si plusieurs filtres sont fournis, ils doivent tous correspondre.
Utilisez un en-tête Idempotency-Key lorsque vous demandez un versement. Une réponse 202 avec status: "processing" confirme que le traitement a été mis en file d’attente et renvoie les filtres fournis. Une réponse 200 avec status: "failed" signifie que la file d’attente a rejeté la requête. Ces statuts décrivent la planification, pas l’achèvement du paiement. Les tâches de transaction relancent automatiquement les échecs. Ajoutez des USD au portefeuille de financement si ses fonds sont insuffisants. Les requêtes répétées ignorent les paiements déjà enregistrés, et l’idempotence du registre empêche les crédits en double. Réponse :

Attributs

string
requis
ID de la règle de cashback, préfixé par cicbr_.
string
requis
Date de création de la règle, sous forme d’horodatage ISO 8601.
string | null
requis
Description facultative de la règle de cashback.
string | null
requis
Date à laquelle la règle a été abandonnée, sous forme d’horodatage ISO 8601. Null signifie qu’elle n’a pas été abandonnée.
string | null
requis
Fin exclusive de la période d’éligibilité, sous forme d’horodatage ISO 8601. Null signifie aucune expiration.
string
requis
Compte de plateforme désigné pour financer le cashback, préfixé par biz_. Déduit des identifiants authentifiés.
string | null
requis
Code de catégorie marchand à quatre chiffres. Null correspond à n’importe quel MCC. Lorsque les deux filtres marchands sont null, scoped_account_id est requis.
string | null
requis
Nom brut du marchand tel que communiqué par le fournisseur de la carte. Null correspond à n’importe quel nom de marchand. Lorsqu’il est défini, il est combiné à tout filtre MCC ; il ne s’agit pas d’une correspondance par sous-chaîne ni sur un nom d’affichage enrichi.
integer
requis
Taux de cashback en points de base. 100 signifie 1 %, et 10000 signifie 100 %.
string | null
requis
ID du sous-compte, préfixé par biz_. Null désigne tous les sous-comptes directs de la plateforme qui finance.
string
requis
Début inclusif de la période d’éligibilité de la règle, sous forme d’horodatage ISO 8601.
string
requis
Date de dernière mise à jour de la règle, sous forme d’horodatage ISO 8601.
CashbackRule