Skip to Content
RéférenceRetours de paiementL’objet

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

RouteEffet
POST /v1/remittancesDéposer un fichier de retours de paiement
GET /v1/remittances/{remittance}Lire un retour de paiement
GET /v1/remittancesLister les retours de paiement

L’objet

  • idtexte

    L'identifiant de l'objet, préfixé par son type.

  • objecttexte

    Le nom du type d'objet.

  • normtexte

    La référence NOEMIE du fichier : 580.

  • emittertexteou null

    L'organisme qui a émis le fichier, tel que l'entité 000 le nomme.

  • sourceénumération

    filesimulator

  • file_nametexteou null
  • return_countentier

    Les retours du fichier : un par facture, paiement ponctuel ou retenue.

  • matched_countentier

    Les retours rapprochés d'une facture.

  • unmatched_countentier

    Les retours de facture qu'aucune facture n'a reconnus : ils attendent un rapprochement à la main.

  • total_centsentier

    La somme signée des virements du fichier, en centimes.

  • discrepanciestableau de objet

    Les é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 null
  • livemodebooléen

    true en production, false en mode test.

  • createdentierou null

    La création de l'objet, en secondes Unix.

L'objet
{ "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 }
Mis à jour le