Create direct Wave charge
Create direct Wave charge
Aperçu
Create direct Wave charge
Starts a payer-facing Wave mobile-money charge. Redirect the customer to wave_launch_url or checkout_url in the response.
Quand l’utiliser
Utilisez pour un encaissement mobile money initié serveur lorsque vous n’utilisez pas une session checkout hébergée.
À savoir
Suivez les instructions du fournisseur dans la réponse ; l’UX dépend du rail (USSD, redirection app, etc.).
Voir aussi
Mobile money · Encaissements directs · Créer une session checkout · Transactions
Authentification
Les routes marchandes nécessitent une clé API dans l’en-tête X-API-KEY (voir Vue d’ensemble). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.
Endpoint
POST /charge/wave
URLs de base :
https://sandbox.api.lomi.africahttps://api.lomi.africa
Requête
Paramètres d’URL
Pas d’autre paramètre dans l’URL.
Paramètres de requête
Aucun paramètre de requête.
En-têtes
| Nom | Emplacement | Obligatoire | Schéma | Description |
|---|---|---|---|---|
Lomi-Account | header | Non | - | Optional lomi. Network account id (acct_...). When present, the API key acts as the Operator and the request targets the connected Member Account. |
Corps de la requête
Corps JSON.
Schéma: CreateWaveChargeDto
| Champ | Obligatoire | Type | Description |
|---|---|---|---|
amount | Oui | number | Amount in XOF (minimum 100) |
currency | Oui | string | Must be XOF for Wave |
organizationId | Non | string | - |
merchantId | Non | string | - |
customer | Oui | CustomerDto | - |
description | Non | string | - |
successUrl | Non | string | - |
errorUrl | Non | string | - |
environment | Non | enum ("live", "test") | - |
Exemple de corps :
{
"amount": 1000,
"currency": "XOF",
"customer": {
"name": "...",
"phoneNumber": "..."
}
}Réponses
| Statut | Description |
|---|---|
201 | Wave charge initiated |
400 | Invalid input or Wave API error |
Erreurs
Les erreurs suivent un format JSON standard. 401 : clé manquante ou invalide. 404 : ressource introuvable. 429 : trop de requêtes. Pour les créations, envoyez une clé d’idempotence si votre flux le permet.
Exemple
curl -sS -X POST "https://sandbox.api.lomi.africa/charge/wave" \
-H "X-API-KEY: $LOMI_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"amount":1000,"currency":"XOF","customer":{"name":"...","phoneNumber":"..."}}'OpenAPI
- operationId:
ChargesController_createWaveCharge - Operation:
POST /charge/wave
Schémas complets et Try it : référence API.