Payments

Paiement métier réconciliable, souvent agrégé depuis un ou plusieurs paiements PSP.

Objet métier

Vue d’ensemble

Les endpoints payments créent et consultent les paiements business. Ils permettent aussi de retrouver les PSP payments qui composent ou sourcent un paiement.

Voir aussi la page du modèle métier payment pour la sémantique, les relations et le cycle de vie fonctionnel.

Contrat JSON

Objet payment

Les réponses utilisent l’identifiant préfixé pay_ et le champ object pour rendre le type explicite.

buyer_idstring

Identifiant de la company de la contrepartie, sauf pour certaines sources PSP.

statusenum

pending, matched, partially_matched ou unmatched.

amount / currencynumber/string

Montant reçu et devise.

sourceenum

open_banking, manual, psp ou psp_with_allocations.

payment_datedate

Date métier du paiement.

source_referencestring

Référence externe utilisée pour l’idempotence métier.

REST

Endpoints

MéthodeEndpointUsage
POST/v1/paymentsCréer un paiement métier reçu.
GET/v1/paymentsLister les paiements, avec filtres merchant_id, buyer_id, status, source ou source_reference.
GET/v1/payments/{id}Récupérer un paiement.
GET/v1/payments/{id}/psp-paymentsLister les paiements PSP rattachés.

Événements

Événements associés

Ces événements peuvent être consommés via les webhooks plateforme lorsque le compte est configuré pour les recevoir.

payment.received

Comportement

Points d’attention

  • payment représente le paiement business réconciliable, tandis que psp_payment conserve le détail provider.
  • Pour les paiements provider, préférez soumettre un draft via le processus prévu plutôt que créer directement un objet business depuis un webhook provider.