Mouvements monétaires du compte marchand
L'objet Balance Transaction
décrit un flux entrant ou sortant concernant le solde d'un marchand : un montant négatif indique une opération sortante (remboursements, décaissements), un montant positif indique une opération entrante (paiements, gratuité de frais).
Ces objets ne sont disponibles qu'en lecture seule.
Champ | Type | Description |
---|---|---|
id | string | Identifiant de la Balance Transaction. |
merchant_id | string | Identifiant du marchand auquel correspond cette Balance Transaction. |
amount | integer | Montant brut de la Balance Transaction, en centimes. |
net_amount | integer | Montant net de la Balance Transaction, en centimes. |
merchant_fee | integer | Éventuels frais appliqués au marchand, en centimes. |
refund_id | string | Identifiant du remboursement correspondant à cette Balance Transaction, le cas échéant. |
payment_id | string | Identifiant du paiement correspondant à cette Balance Transaction, le cas échéant. |
payout_id | string | Identifiant du décaissement correspondant à cette Balance Transaction, le cas échéant. Toutes les Balance Transactions ayant leur champ |
included_in_payout_id | string | Identifiant du décaissement dans lequel les fonds de cette Balance Transaction sont inclus. |
comment | string | Commentaire éventuel correspondant à cette Balance Transaction. |
kind | string | Indique le type de la Balance Transaction. Valeurs possibles : |
created | timestamp | Date de création de la Balance Transaction. |
updated | timestamp | Date de la dernière modification de la Balance Transaction. |
available_on | timestamp | Date a partir de laquelle les fonds concernés par cette Balance Transaction seront disponibles pour un décaissement. Ne concerne que les Balance Transaction entrantes. |
Exemple d'objet Balance Transaction au format JSON, représentant l'exécution d'un décaissement de 2834,62€ vers le compte bancaire du marchand :
{
"id": "balance_txn_11jdy0c34dqAkKfXsqUy042CAqaq577qFN",
"merchant_id": "merchant_11iTSik4Ej76KAEMyo8cEK42wUeSd69hbo",
"amount": -283462,
"net_amount": -283462,
"merchant_fee": 0,
"payment_id": null,
"refund_id": null,
"payout_id": "payout_11jdxsj3doAjuaugq864kukq4WMYM2kPl1",
"included_in_payout_id": null,
"kind": "from_payout",
"comment": null,
"updated": 1590592915,
"available_on": 1590592915,
"created": 1590592915,
}
Sur d'autres Balance Transactions, on retrouvera donc l'ID payout_11jdxsj3doAjuaugq864kukq4WMYM2kPl1
dans le champ included_in_payout_id
, indiquant que ces mouvements de fonds ont été pris en compte dans le décaissement.