az54
Ouvrir le tableau de bord
API docsAPI ReferenceDashboard docs

Lister vos transactions

Pay-in et pay-out confondus, triés par `createdAt` décroissant. Le filtre `orderId` sert de rattrapage quand une notification a été manquée.

GET
/v1/transactions

Authorization

AuthorizationBearer <token>

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

Query Parameters

page?integer

Page 1-indexée.

Range0 < value
limit?integer

Taille de page, de 1 à 100.

Range1 <= value <= 100
status?string

Filtre exact sur le statut courant de la transaction.

Value in

  • "created"
  • "pending_approval"
  • "initiated"
  • "pending"
  • "processing"
  • "completed"
  • "failed"
  • "cancelled"
type?string

payin ou payout.

Value in

  • "payin"
  • "payout"
orderId?string

Filtre exact sur votre order_id. Le moyen de retrouver une transaction sans connaître son identifiant technique az54 (id).

failureCategory?string

Filtre par cause d'échec normalisée (catalogue causes d'échec). UNKNOWN ramène aussi les échecs sans catégorie enregistrée.

Value in

  • "INSUFFICIENT_FUNDS"
  • "INVALID_RECIPIENT"
  • "LIMIT_EXCEEDED"
  • "PROVIDER_ERROR"
  • "TIMEOUT"
  • "CANCELLED_BY_USER"
  • "UNKNOWN"
  • "PROVIDER_UNAVAILABLE"
  • "PROVIDER_NOT_AUTHORIZED"
  • "PROVIDER_INSUFFICIENT_LIQUIDITY"
dateFrom?|

Borne basse sur createdAt (incluse), en ISO 8601 ou AAAA-MM-JJ.

dateTo?|

Borne haute sur createdAt (incluse), en ISO 8601 ou AAAA-MM-JJ.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/transactions"
{  "success": true,  "data": {    "transactions": [      {        "id": "string",        "orderId": "string",        "amount": 0,        "fee": 0,        "netAmount": 0,        "phoneNumber": "string",        "currencyCode": "string",        "countryCode": "string",        "status": "string",        "type": "string",        "operatorName": "string",        "description": "string",        "payerName": "string",        "failureCategory": "INSUFFICIENT_FUNDS",        "failureReason": "string",        "failureCode": "string",        "failedAt": "2019-08-24T14:15:22Z",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "pagination": {      "page": 0,      "limit": 0,      "total": 0,      "totalPages": 0    }  }}

Connaître le plafond de pay-out de votre compte GET

Plus gros pay-out que `POST /v1/pay-out` accepterait maintenant dans une devise, et la règle qui le fixe. Lecture indicative : le plafond est vérifié de nouveau à la création du pay-out, et un autre pay-out peut le consommer entre les deux appels. Mêmes gardes d'autorisation que `GET /v1/pay-out/preview` : `PAYOUT_INITIATE` est exigé quel que soit l'appelant.

Consulter une transaction par son identifiant GET

Rattrapage recommandé après une notification manquée : contrairement au reçu public (`GET /v1/transactions/{orderId}`), scopé à votre organisation et porte le détail complet (frais, `netAmount`, cause d'échec, journal des notifications webhook). Un `id` d'une autre organisation rend `404`, au même titre qu'un `id` inexistant.