Lire un retrait
GET/v1/payouts/{id}
Un retrait, et ce qu’il est devenu.
La demande
bash
curl https://api.payiz.app/v1/payouts/ret_01j9xe9np6w7rzc5mb4d \ -H "Authorization: Bearer sk_test_…"
La réponse
json
{
"object": "payout",
"id": "ret_01j9xe9np6w7rzc5mb4d",
"amount": 50000,
"currency": "XOF",
"status": "processing",
"fee": 500,
"amount_debited": 50500,
"recipient": {
"id": "ben_01j9xd7mk4s2pvb8ya3c",
"name": "Adjoa Mensah",
"phone": "+229 01 •• •• 34 00",
"operator": "mtn",
"country": "BEN"
},
"failure_message": null,
"paid_at": null,
"created": 1790009892,
"livemode": false
}Ce qu’on reçoit
200 · un objet payout
object« payout »Le genre de l’objet rendu : il ne change jamais.
idtexteUn identifiant préfixé « ret_ », par exemple ret_01j9x3kq7m4tzv8qhw2n.
amountentierCe que le bénéficiaire reçoit.
currencytexteLe code ISO 4217, en majuscules.
status« pending » · « in_review » · « processing » · « paid » · « failed » · « refused » · « canceled »Où en est le retrait.
feeentierLes frais du retrait.
amount_debitedentierCe qui sort du solde, frais compris.
recipientobjetVers qui l’argent part.
failure_messagetexte ou nullCe que l’opérateur a répondu, quand ça a échoué.
paid_atentier ou nullDes secondes depuis 1970, ou null.
createdentier ou nullDes secondes depuis 1970, ou null.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.
object« payout »Le genre de l’objet rendu : il ne change jamais.
idtexteUn identifiant préfixé « ret_ », par exemple ret_01j9x3kq7m4tzv8qhw2n.
amountentierCe que le bénéficiaire reçoit.
currencytexteLe code ISO 4217, en majuscules.
status« pending » · « in_review » · « processing » · « paid » · « failed » · « refused » · « canceled »Où en est le retrait.
feeentierLes frais du retrait.
amount_debitedentierCe qui sort du solde, frais compris.
recipientobjetVers qui l’argent part.
failure_messagetexte ou nullCe que l’opérateur a répondu, quand ça a échoué.
paid_atentier ou nullDes secondes depuis 1970, ou null.
createdentier ou nullDes secondes depuis 1970, ou null.
livemodevrai ou fauxFaux en mode test : aucun argent ne circule.
© 2026 PayizUne question ? L’aide est dans le rond, en bas à droite.