Skip to main content
Un Refund est une annulation totale ou partielle d’un paiement, émise avec Refund Payment. Il enregistre le montant transféré, le prestataire utilisé et si l’opération a réussi. Utilisez l’API Refunds pour lister les remboursements d’un paiement ou de l’ensemble d’un compte, et pour récupérer un remboursement précis.

Endpoints

Attributs

string
requis
ID du remboursement, préfixé par rf_.
string | null
requis
Le compte qui a émis le remboursement, préfixé par biz_.
object | null
requis
Le montant remboursé tel que réglé, dans la devise de règlement du paiement, afin que les pages de remboursements se compensent avec le refunded_amount du paiement. Converti au taux en vigueur au moment de l’émission du remboursement, et non au taux d’origine du paiement. Null uniquement lorsqu’aucun taux de change n’est enregistré pour un ancien paiement multidevise.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, ce qui donne 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string
requis
Date de la demande de remboursement, sous forme d’horodatage ISO 8601.
string | null
requis
Une explication destinée au marchand indiquant pourquoi le remboursement a échoué, dans la langue de la requête. Null sauf si le remboursement a échoué ou a été annulé.
string | null
requis
Raison de l’échec du remboursement, normalisée pour tous les prestataires. Null sauf si le remboursement a échoué ou a été annulé.Options disponibles : bank_declined, expired_or_canceled_card, lost_or_stolen_card, insufficient_funds, charge_disputed, not_refundable, merchant_request, unknown
object | null
requis
Vos propres données clé-valeur associées lors de la demande de remboursement.
object
requis
Le montant remboursé dans la devise transférée par le processeur.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales du montant. Il s’agit de la précision à laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, ce qui donne 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string
requis
Le paiement annulé par ce remboursement, préfixé par pay_.
string
requis
Le prestataire de paiement qui a traité le remboursement, par exemple paypal ou coinbase.
string | null
requis
Date à laquelle le prestataire a créé le remboursement, sous forme d’horodatage ISO 8601.
string | null
requis
Raison de l’émission du remboursement, lorsqu’elle est enregistrée.Options disponibles : duplicate, fraudulent, requested_by_customer, expired_uncaptured_charge, dispute_alert
string | null
requis
Indique si une référence de suivi du réseau bancaire est disponible pour ce remboursement.Options disponibles : available, pending, unavailable
string | null
requis
Le type de référence de suivi, par exemple un numéro de référence de l’acquéreur.Options disponibles : acquirer_reference_number, retrieval_reference_number, system_trace_audit_number
string | null
requis
La référence de suivi grâce à laquelle la banque de l’acheteur peut retracer le remboursement.
string
requis
Où en est le remboursement auprès du processeur : pending, requires_action, succeeded, failed ou canceled.Options disponibles : pending, requires_action, succeeded, failed, canceled
string
requis
Date de la dernière modification du remboursement, sous forme d’horodatage ISO 8601.
boolean
requis
Vrai lorsque le réseau de cartes a initié le remboursement via Rapid Dispute Resolution.
Refund