Retours de paiement
Un fichier de retours de la caisse, lu, rapproché des factures, avec ses écarts.
Le cycle de vie et les pièges : Retours des caisses.
Événements : remittance.*.
Routes
| Route | Effet |
|---|---|
POST /v1/remittances | Déposer un fichier de retours de paiement |
GET /v1/remittances/{remittance} | Lire un retour de paiement |
GET /v1/remittances | Lister les retours de paiement |
L’objet
idtexteL'identifiant de l'objet, préfixé par son type.
objecttexteLe nom du type d'objet.
normtexteLa référence NOEMIE du fichier :
580.emittertexteou nullL'organisme qui a émis le fichier, tel que l'entité 000 le nomme.
sourceénumérationfilesimulatorfile_nametexteou nullreturn_countentierLes retours du fichier : un par facture, paiement ponctuel ou retenue.
matched_countentierLes retours rapprochés d'une facture.
unmatched_countentierLes retours de facture qu'aucune facture n'a reconnus : ils attendent un rapprochement à la main.
total_centsentierLa somme signée des virements du fichier, en centimes.
discrepanciestableau de objetLes écarts relevés :
unmatched(retour sans facture),underpaid(payé moins que demandé),total_mismatch(cumul d'un virement faux),unknown_return(type de retour inconnu).received_atentierou nulllivemodebooléentrueen production,falseen mode test.createdentierou nullLa création de l'objet, en secondes Unix.
{
"id": "obj_…",
"object": "remittance",
"norm": "…",
"emitter": null,
"source": "file",
"file_name": null,
"return_count": 0,
"matched_count": 0,
"unmatched_count": 0,
"total_cents": 0,
"discrepancies": [
{}
],
"received_at": null,
"livemode": false,
"created": 1793970000
}