Retirer
POST/v1/payouts
Envoie de l’argent vers un bénéficiaire enregistré.
Selon le régime réglé pour votre compte, le retrait peut attendre une approbation : son « status » le dit. Exige un en-tête Idempotency-Key.
Les en-têtes
Idempotency-KeyREQUIStexteObligatoire ici : rejouée, la même clé rend le même remboursement ou le même retrait, sans faire sortir l’argent deux fois. Tirez-la de votre propre référence.
Idempotency-KeyREQUIStexteObligatoire ici : rejouée, la même clé rend le même remboursement ou le même retrait, sans faire sortir l’argent deux fois. Tirez-la de votre propre référence.
Ce qu’on envoie
Un corps JSON. Ce qui n’est pas requis peut être omis.
amountREQUISentierCe que le bénéficiaire reçoit.
recipientREQUIStexteVers qui l’argent part.
currencytexteSans précision : la monnaie de l’espace.
amountREQUISentierCe que le bénéficiaire reçoit.
recipientREQUIStexteVers qui l’argent part.
currencytexteSans précision : la monnaie de l’espace.
La demande
bash
curl https://api.payiz.app/v1/payouts \
-H "Authorization: Bearer sk_test_…" \
-H "Idempotency-Key: retraits-creer-01" \
-H "Content-Type: application/json" \
-d '{
"amount": 50000,
"recipient": "ben_01j9xd7mk4s2pvb8ya3c"
}'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
201 · 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.