Virements

Un virement qu’un retour de paiement annonce, avec ses paiements et ses retenues, rapproché du crédit que montre le relevé du compte.

Le cycle de vie et les pièges : Virements et relevés.

Événements : payout.*.

Routes

Route	Effet
`GET /v1/payouts/{payout}`	Lire un virement
`GET /v1/payouts`	Lister les virements
`POST /v1/payouts/{payout}/reconcile`	Pointer un virement à la main

L’objet

idtexte
L'identifiant de l'objet, préfixé par son type.
objecttexte
Le nom du type d'objet.
statusénumération
pending : en attente du relevé. reconciled : rapproché d'un crédit, ou pointé à la main. discrepancy : un écart est signalé.
pendingreconcileddiscrepancy
amount_centsentier
Le montant du virement, en centimes, signé : le cumul que le retour annonce.
currencytexte
statement_descriptortexteou null
Ce que le relevé du compte montre du virement : la ligne 2 du libellé, sinon le libellé entier.
labelobjet
Le libellé du virement, tel que le retour le donne. La ligne 1 nomme souvent le donneur d'ordre.
Champs de label
- line_1texteobligatoireou null
- line_2texteobligatoireou null
accounting_datetexteou null
La date d'émission du virement, pas celle de son arrivée sur le compte.
payertexteou null
L'organisme payeur, tel que le retour le nomme.
practitioner_numbertexteou null
Le numéro de facturation du professionnel payé.
remittancetexteou null
Le fichier de retours qui l'annonce, rem_….
payment_countentier
Les paiements et retenues qui le composent.
claim_countentier
Les factures qu'il règle.
detail_centsentier
La somme signée de ses paiements et retenues, en centimes. Elle égale amount_cents, sauf écart total_mismatch.
breakdownobjet
Son détail par type de mouvement, en centimes signés.
Champs de breakdown
- liquidation_centsentierobligatoire
- regularization_centsentierobligatoire
- one_off_payment_centsentierobligatoire
- deduction_centsentierobligatoire
bank_transactiontexteou null
Le crédit du relevé qui lui répond, btx_….
received_centsentierou null
Le montant crédité sur le compte, en centimes. Null tant qu'aucun crédit ne lui répond.
arrival_datetexteou null
Le jour où le crédit apparaît sur le relevé.
reconciliationénumérationou null
automaticmanual
reconciled_atentierou null
discrepanciestableau de objet
Les écarts : amount_mismatch (montant reçu différent), not_received (absent d'un relevé qui couvre sa date), total_mismatch (cumul du retour faux), unmatched_payments (paiements qui attendent leur facture).
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": "payout",
  "status": "pending",
  "amount_cents": 0,
  "currency": "eur",
  "statement_descriptor": null,
  "label": {
    "line_1": null,
    "line_2": null
  },
  "accounting_date": null,
  "payer": null,
  "practitioner_number": null,
  "remittance": null,
  "payment_count": 0,
  "claim_count": 0,
  "detail_cents": 0,
  "breakdown": {
    "liquidation_cents": 0,
    "regularization_cents": 0,
    "one_off_payment_cents": 0,
    "deduction_cents": 0
  },
  "bank_transaction": null,
  "received_cents": 0,
  "arrival_date": null,
  "reconciliation": "automatic",
  "reconciled_at": null,
  "discrepancies": [
    {}
  ],
  "livemode": false,
  "created": 1793970000
}