Champ
Type
Description
external_id
Votre propre identifiant pour ce paiement, provenant de votre logiciel. Envoyez de nouveau le même external_id pour mettre à jour ce paiement au lieu d'en ajouter un nouveau. Nous faisons la correspondance sur cette valeur, mais nous n'empêchons pas les doublons; gardez-la donc unique au sein du site.
_id
L'identifiant du paiement, attribué par le système.
display_name
Le nom convivial sécurisé de la méthode de paiement. Exemple : VISA **** 3421.
last_4
Les 4 derniers chiffres du mode de paiement. Retourné uniquement pour les paiements effectués avec un mode de paiement enregistré; un paiement enregistré par cette API n'en a pas, il est donc omis.
amount
Le montant qui a été payé. Format = 0.00
paid_on
La date et l'heure à laquelle le paiement a été effectué. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ssZ
gateway_transaction_id
L'identifiant unique qui a été attribué à l'enregistrement de paiement par la passerelle lorsque le paiement a été traité.
tip
Le montant du pourboire qui a été ajouté. Format = 0.00
tax
Le montant de taxe qui a été ajouté. Format = 0.00
fee
Le montant des frais qui a été ajouté. Format = 0.00
invoice
Une référence à l'enregistrement Facture. En écriture, c'est ainsi que le paiement est appliqué à Facture; elle est retournée en lecture, avec la liste plus complète allocations.
payment_type
Le type de méthode de paiement utilisé pour effectuer le paiement.
One of payment_card, ach, eft, apple_pay, google_pay, oxxo, spei, bnpl, dlocal, cash, check, other
payment_sub_type
Le sous-type de la méthode de paiement utilisée pour effectuer le paiement.
One of visa, mastercard, amex, discover, diners, jcb, checking, savings, oxxo, spei, bnpl, google_pay, dlocal, cash, check, other
status
Le statut actuel du paiement. created : enregistré, mais pas encore envoyé au processeur. failed : la tentative a échoué avant que le processeur ne réponde. declined : le processeur l'a refusé. expired : il n'a pas été complété à temps. cancelled : il a été annulé avant d'être traité. authorized : la carte a été approuvée et les fonds sont retenus, mais pas encore débités. captured : le paiement a été débité et n'est pas encore réglé. settled : le processeur a réglé les fonds. voided : annulé avant le règlement, donc aucun argent n'a été transféré. refundRequested : un remboursement attend le règlement du paiement. returned : la banque a renvoyé le paiement. chargebacked : le titulaire de la carte a contesté le paiement. Un remboursement est un paiement distinct, avec refunded, refundSettled ou refundFailed.
Default = captured | One of failed, declined, created, expired, cancelled, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled, chargebacked, refundRequested
created_at
La date à laquelle le paiement a été créé. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updated_at
La date à laquelle le paiement a été dernièrement mis à jour. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
manual_status_change
Le dernier changement de statut effectué manuellement par un utilisateur dans l'application, par exemple marquer un paiement comme refusé. Utilisez-le pour distinguer un changement manuel d'un changement signalé par la passerelle de paiement. Omis lorsque personne n'a modifié manuellement le statut du paiement.
reference_number
Le numéro de référence unique attribué au paiement par le système et affiché au marchand.
early_pay_discounts_and_late_fees
Le montant net après tout escompte de paiement anticipé et tous frais de retard appliqués au paiement. Format = 0.00
is_refund
Indique si le paiement est un remboursement d'un autre paiement.
orig_payment
Pour un remboursement, l'_id du paiement qu'il a remboursé. Omis pour les paiements qui ne sont pas des remboursements.
custom_fields
Les champs personnalisés consignés sur le paiement, sous forme de paires nom/valeur. {} s'il n'y en a aucun.
allocations
Comment le paiement a été appliqué. Un paiement réparti sur plusieurs Factures comporte une entrée par Facture.