États d'un paiement

Contexte

Un paiement a deux états :

• Un état métier (Status) qui peut être vu comme un état simplifié ou un état externe

• Un état technique (StatePayment) qui reflète l’état métier et apporte de précisions sur le cycle de vie de ce paiement.

État métier

C’est l’état qui vous intéressera dans la plupart des cas. Il indique l’état de l’abonnement tel qu’un logiciel tiers a besoin de le voir.

Note

Important : un paiement est lié à un échange unique de fonds entre votre client et votre organisation. Si un paiement est remboursé ou en opposition, il y aura 2 paiements dans ProAbono, le premier pour le paiement réussi, le second pour le rétro-paiement.

État métier	API (Status)	Description
Brouillon	Draft	Cet état n’est pas encore utilisé, il est réservé à de futures évolutions.
En cours	Pending	Le paiement est en cours, c’est le cas typique du prélèvement automatique.
Confirmé	Completed	Le paiement est complété, les fonds sont à votre disposition sur votre compte en banque ou chez votre passerelle de paiement.
Annulé	Cancelled	Le paiement a été annulé.
En échec	Failed	La tentative de paiement a échoué.
Retourné	Reversed	Un paiement précédent a été reversé au client, à la suite d’un remboursement ou un litige.

États techniques

Cet état ne vous servira que si vous souhaitez des informations avancées sur un paiement. Il donne plus d’informations sur les raisons de son état.

État métier	État technique (StatePayment)	Description
Brouillon	Draft	Cet état n’est pas encore utilisé, il est réservé à de futures évolutions.
En cours	Pending	Le paiement est en cours et changera d’état une fois le processus terminé.
Confirmé	Completed	Le paiement est complété.
CompletedRefunded	Le paiement est complété, mais il a été remboursé. Il est associé à un autre paiement retourné.
CompletedChargedback	Le paiement est complété, mais il a été rétro-facturé. Il est associé à un autre paiement retourné.
Annulé	CancelledAgent	Le paiement a été annulé par un membre de votre organisation.
En échec	Failed	La tentative de paiement a échoué.
Retourné	ReversedRefund	Les fonds ont été reversés au client suite à un remboursement par un membre de votre équipe.
ReversedChargeback	Les fonds ont été reversés au client en réponse à une opposition par le client ou la banque du client.

Exemple d’un paiement au format JSON

{
  "Id": 42",
  ...
  "ReferenceCustomer": "123456",
  "Status": "Completed", // Etat métier
  "StatePayment": "CompletedRefunded", // Etat technique
  ...
}