Passer au contenu principal
Un payout envoie des fonds hors de votre solde Orqex vers un destinataire. La destination est un instrument typé : un numéro de téléphone mobile-money ou wallet, un compte bancaire, ou une adresse crypto. Orqex choisit la passerelle selon les règles de routing payout de votre projet.

​
Créer un payout

curl https://api.orqex.com/v1/payouts \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -H "X-Idempotency-Key: payout-1024" \
  -d '{
    "amount": 5000,
    "currency": "XOF",
    "method": "momo_mtn",
    "instrument": {
      "type": "phone",
      "phone_number": "+22990000000",
      "country": "BJ"
    }
  }'

​
Corps de la requête

​
amount
integer
requis
Montant à envoyer, en unités mineures (ex. 5000 pour 50,00). Minimum 1.
​
currency
string
requis
Code devise ISO 4217 à trois lettres.
​
method
string
requis
Code de méthode de payout, ex. momo_mtn, momo_orange, momo_moov, wallet_wave, wallet_djamo, momo_mpesa, momo_airtel.
​
instrument
object
requis
Destination typée. Les champs requis dépendent de instrument.type.
​
metadata
object
Jusqu’à 10 paires clé/valeur arbitraires, conservées sur le payout.

​
Types d’instrument

{
  "type": "phone",
  "phone_number": "+22990000000",
  "country": "BJ"
}
phone_number et country (ISO 3166-1 alpha-2) sont requis.

​
Réponse

​
id
string
Identifiant public du payout (ex. po_...).
​
method
string
Le code de méthode de payout utilisé.
​
status
string
pending, processing, completed, failed, cancelled ou reversed.
​
instrument
object
L’instrument de destination. recipient est masqué ; l’instrument complet n’est jamais renvoyé.
​
fee_amount
integer
Frais du payout en unités mineures.
​
gateway_transaction_id
string
Référence de transaction de la passerelle, si disponible.

​
Lister & récupérer

curl https://api.orqex.com/v1/payouts \
  -H "Authorization: Bearer sk_live_xxx"
Les payouts sont aussi utilisés en coulisses par le remboursement via payout : lorsqu’une passerelle ne gère pas le remboursement nativement et que le projet l’autorise, un remboursement peut être restitué au payeur d’origine sous forme de payout. Voir Rembourser un paiement.