Documentation API az54

Deux issues selon qui appelle. Une clé d'API **exécute toujours directement** le payout (`200`) : elle contourne le circuit d'approbation interne à l'organisation, au même titre qu'elle contourne le RBAC. Un jeton de session sans la permission d'approbation crée un **brouillon** `pending_approval` (`201`), qui devra être validé depuis le tableau de bord — cas hors du périmètre d'une intégration serveur.

POST/v1/pay-out

Authorization

AuthorizationBearer <token>

Clé d'API de l'organisation, envoyée en Authorization: Bearer sk_live_…. Il n'existe aucun header X-API-Key.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

orderId*string

Match^[A-Za-z0-9_-]+$

Length1 <= length <= 100

amount*number

Montant en unité majeure de currencyCode. Le nombre de décimales admis est le decimalPlaces de la devise ; au-delà, 400 VALIDATION_ERROR.

Range0 < value

phoneNumber*string

Numéro du bénéficiaire au format E.164, indicatif compris.

Match^\+[1-9]\d{8,14}$

Length1 <= length

currencyCode*string

Length1 <= length

operatorCode?string

À n'envoyer que pour choisir Wave. Wave n'est pas un opérateur télécom : son compte se superpose à celui du telco, un même numéro peut donc porter les deux — le préfixe ne suffit pas à trancher. Une seule valeur a un effet : wave, sensible à la casse, qui force le rail Wave. Pour tous les autres opérateurs, le préfixe du numéro décide et la valeur envoyée est ignorée en silence.

description?string

Lengthlength <= 500

webhookUrl?string

Destination de la notification sortante. Vérifiée à l'émission, pas ici : https en production, hôte résolvant vers une IP publique unicast, aucune redirection suivie, une seule tentative sans retry. Une URL invalide donne donc un payout qui réussit et une notification perdue en silence.

Formaturi

customerId?string

Référence libre côté marchand. Stockée, jamais restituée par l'API.

Lengthlength <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/pay-out" \  -H "Content-Type: application/json" \  -d '{    "orderId": "string",    "amount": 100,    "phoneNumber": "string",    "currencyCode": "string"  }'

{  "success": true,  "data": {    "orderId": "string",    "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",    "status": "string",    "newBalance": 0,    "message": "string",    "failureCategory": "INSUFFICIENT_FUNDS",    "failureReason": "string"  }}

Envoyer un paiement mobile money

Authorization

Request Body

Response Body

200application/json

201application/json

400application/json

401application/json

403application/json

409application/json

413application/json

429application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`