Virements

L’API Payouts permet de retirer des fonds du solde marchand vers votre compte bancaire ou Mobile Money.

Progression des statuts, frais et sémantique de clôture : Cycle de vie des virements.

Les virements sont traités de façon asynchrone. Utilisez les webhooks pour suivre le statut (payout.completed ou payout.failed).

Initier un virement

Retire des fonds du solde de votre compte.

Corps de la requête

Champ	Type	Obligatoire	Description
`amount`	`number`	Oui	Montant à retirer
`currency_code`	`string`	Oui	Devise (`XOF`, `USD`, etc.)
`payout_method_id`	`string`	Oui	Votre moyen de virement (banque / Mobile Money)
`description`	`string`	Non	Libellé du virement
`metadata`	`object`	Non	Paires clé-valeur

import { LomiSDK } from '@lomi./sdk';

const lomi = new LomiSDK({
  apiKey: process.env.LOMI_API_KEY!,
  environment: 'live',
});

const payout = await lomi.payouts.create({
  amount: 100000,
  currency_code: 'XOF',
  payout_method_id: 'pm_abc123...',
  description: 'Retrait mensuel',
});

console.log(`Payout initiated: ${payout.id}, Status: ${payout.status}`);

from lomi import LomiClient
import os

client = LomiClient(
    api_key=os.environ["LOMI_API_KEY"],
    environment="test"
)

payout = client.payouts.create({
    "amount": 100000,
    "currency_code": "XOF",
    "payout_method_id": "pm_abc123...",
    "description": "Retrait mensuel"
})

print(f"Payout initiated: {payout['id']}")

curl -X POST "https://api.lomi.africa/payouts" \
  -H "X-API-KEY: $LOMI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 100000,
    "currency_code": "XOF",
    "payout_method_id": "pm_abc123...",
    "description": "Retrait mensuel"
  }'

Lister les virements

Récupère les virements avec filtrage optionnel.

Paramètres de requête

Paramètre	Type	Description
`statuses`	`string`	Statuts séparés par des virgules : `pending`, `completed`, `failed`
`startDate`	`string`	À partir de cette date (ISO 8601)
`endDate`	`string`	Jusqu’à cette date (ISO 8601)
`limit`	`number`	Résultats par page (défaut : `50`)
`offset`	`number`	Décalage (défaut : `0`)

const payouts = await lomi.payouts.list({
  statuses: 'completed',
  startDate: '2024-01-01T00:00:00Z',
  limit: 20,
});

payouts = client.payouts.list(
    statuses="completed",
    startDate="2024-01-01T00:00:00Z",
    limit=20
)

curl -X GET "https://api.lomi.africa/payouts?statuses=completed&limit=20" \
  -H "X-API-KEY: $LOMI_API_KEY"

Obtenir un virement

Récupère le détail d’un virement.

const payout = await lomi.payouts.get('po_abc123...');
console.log(`Status: ${payout.status}`);

payout = client.payouts.get('po_abc123...')

curl -X GET "https://api.lomi.africa/payouts/po_abc123..." \
  -H "X-API-KEY: $LOMI_API_KEY"

Objet Payout

Champ	Type	Description
`id`	`string`	Identifiant du virement
`amount`	`number`	Montant
`currency_code`	`string`	Devise
`status`	`string`	`pending`, `completed`, `failed`
`payout_method_id`	`string`	Moyen de destination
`description`	`string`	Description
`failure_reason`	`string`	Motif d’échec (si échec)
`provider_code`	`string`	Prestataire
`metadata`	`object`	Métadonnées
`created_at`	`string`	Horodatage de création

Webhooks

Événement	Description
`payout.pending`	Virement initié
`payout.completed`	Virement traité avec succès
`payout.failed`	Virement en échec

Réponses d’erreur

Statut	Description
`400`	Entrée invalide ou solde insuffisant
`401`	Clé API invalide ou manquante
`404`	Virement introuvable

Virements

Sur cette page