Skip to main content
GET
https://sandbox-api.caurisflux.com/api/v1
/
payments
/
status
/
{payoutId}
Statut du payout
curl --request GET \
  --url https://sandbox-api.caurisflux.com/api/v1/payments/status/{payoutId} \
  --header 'X-API-Key: <api-key>'
Vérifie le statut actuel d’un payout.
Les payouts utilisent le même endpoint de statut que les paiements : /payments/status/:id.

Authentification

X-API-Key: pk_test_xxx:sk_test_xxx

Paramètres de chemin

ParamètreTypeDescription
payoutIdstringID du payout retourné lors de la création

Requête

curl https://sandbox-api.caurisflux.com/api/v1/payments/status/POMLWYG1W59FDCEA \
  -H "X-API-Key: pk_test_xxx:sk_test_xxx"

Réponse - Payout complété

{
  "transactionId": "POMLWYG1W59FDCEA",
  "externalReference": "PAY-2024-001",
  "type": "payout",
  "status": "completed",
  "amount": 50000,
  "currency": "XOF",
  "method": "mobile_money",
  "mobileProvider": "wave",
  "recipientPhone": "+221771234567",
  "recipientName": "Amadou Diallo",
  "providerReference": "WAVE-PAY-123456",
  "message": "Payout effectué avec succès",
  "errorCode": null,
  "errorMessage": null,
  "completedAt": "2024-01-15T14:02:00.000Z",
  "createdAt": "2024-01-15T14:00:00.000Z",
  "updatedAt": "2024-01-15T14:02:00.000Z",
  "metadata": {
    "supplierId": "SUP-123",
    "invoiceId": "INV-456"
  }
}

Réponse - Payout en attente

{
  "transactionId": "POMLWYG1W59FDCEA",
  "externalReference": "PAY-2024-001",
  "type": "payout",
  "status": "pending",
  "amount": 50000,
  "currency": "XOF",
  "method": "mobile_money",
  "mobileProvider": "wave",
  "recipientPhone": "+221771234567",
  "recipientName": "Amadou Diallo",
  "message": "Payout en cours de traitement",
  "errorCode": null,
  "errorMessage": null,
  "completedAt": null,
  "createdAt": "2024-01-15T14:00:00.000Z",
  "updatedAt": "2024-01-15T14:00:00.000Z",
  "metadata": null
}

Réponse - Payout échoué

{
  "transactionId": "POMLWYG1W59FDCEA",
  "externalReference": "PAY-2024-003",
  "type": "payout",
  "status": "failed",
  "amount": 100000,
  "currency": "XOF",
  "method": "mobile_money",
  "mobileProvider": "wave",
  "recipientPhone": "+221770000000",
  "recipientName": "Test User",
  "message": "Payout échoué",
  "errorCode": "invalid_recipient",
  "errorMessage": "Le numéro de téléphone n'est pas associé à un compte Wave actif",
  "completedAt": null,
  "createdAt": "2024-01-15T14:00:00.000Z",
  "updatedAt": "2024-01-15T14:05:00.000Z",
  "metadata": null
}

Statuts possibles

StatutDescription
pendingEn attente de traitement
processingEn cours de traitement
completedPayout réussi
failedPayout échoué
cancelledPayout annulé

Codes d’erreur

CodeDescription
invalid_recipientBénéficiaire invalide
insufficient_balanceSolde insuffisant (votre compte)
provider_errorErreur du provider
limit_exceededLimite de payout dépassée
account_blockedCompte bénéficiaire bloqué