Envoyer un paiement mobile money
Deux issues selon la portée de qui appelle, clé d'API ou jeton de session : avec `PAYOUT_APPROVE` en plus de `PAYOUT_INITIATE`, le payout s'exécute directement (`200`) ; sans `PAYOUT_APPROVE`, l'appel dépose un **brouillon** `pending_approval` (`201`), à valider par un tiers habilité depuis le tableau de bord avant dispatch — une clé d'API sans `PAYOUT_APPROVE` produit donc aussi ce brouillon, au même titre qu'un rôle `accountant`. Sur Sandbox, l'issue suit le même catalogue de numéros que le pay-in (cf. [numéros de test](/docs/numeros-de-test)).
Clé d'API de l'organisation, envoyée en Authorization: Bearer sk_live_… (sk_test_… sur le serveur Sandbox). Il n'existe aucun header X-API-Key.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
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", "failureCode": "string" }}Consulter le reçu public par identifiant de transaction GET
Même reçu que `GET /v1/transactions/{orderId}`, adressé par l'identifiant (`transactionId`) az54, sans authentification. Cet identifiant est unique toutes organisations confondues : contrairement à l'`orderId`, il n'est jamais refusé pour cause d'ambiguïté. Plafonné à 30 requêtes/min par `transactionId`, sans seau par IP : ce n'est pas un endpoint de polling serveur.
Prévisualiser les frais d'un payout GET
Calcule les frais et le solde résiduel d'un payout sans créer de transaction ni réserver de fonds. Mêmes gardes d'autorisation que `POST /v1/pay-out` : `PAYOUT_INITIATE` est exigé quel que soit l'appelant ; un jeton de session doit en plus avoir vérifié sa 2FA, hors de portée d'une clé d'API.