My App
Virements

Obtenir un virement par ID

Récupère un virement par son ID, incluant le statut actuel et les détails de la transaction. **Authentification :** - Nécessite les en-têtes de clé API `X-API-KEY` et `X-API-KEY-ID` **Contrôle d'accès :** - Ne retourne que les virements qui appartiennent à l'entreprise authentifiée

GET
/partner_api/transfers/{id}

Récupère un virement par son ID, incluant le statut actuel et les détails de la transaction.

Authentification :

  • Nécessite les en-têtes de clé API X-API-KEY et X-API-KEY-ID

Contrôle d'accès :

  • Ne retourne que les virements qui appartiennent à l'entreprise authentifiée

Authorization

X-API-KEY<token>

Clé API pour les requêtes de l'API Partenaire

In: header

Path Parameters

id*string

Transfer identifier

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/partner_api/transfers/wth_abc123def456"
{
  "id": "wth_abc123def456",
  "storeId": "59ae202a-f583-4a15-970f-9e99bd1e0baa",
  "contactId": "29f81706-03a6-492f-92ee-5f0b2e9b18e7",
  "amount": {
    "amount": 10000,
    "currency": "XOF"
  },
  "fees": {
    "amount": 10000,
    "currency": "XOF"
  },
  "status": "success",
  "paymentMethod": "wave",
  "beneficiary": "+2250701234567",
  "description": "Monthly salary payment",
  "reference": "PAYROLL-APR-001",
  "createdAt": "2024-01-15T14:30:25.000Z",
  "transaction": {
    "id": "txn_1234567890",
    "status": "success"
  }
}
{
  "id": "unauthorized",
  "message": "Unauthorized",
  "extras": "Détails supplémentaires de l'erreur"
}
{
  "id": "transfer_not_found",
  "message": "This transfer doesn't exist",
  "extras": "Transfer not found"
}
{
  "id": "internal_error",
  "message": "Une erreur inattendue s'est produite",
  "extras": "Détails supplémentaires de l'erreur"
}

Créer un virement POST

Crée un nouveau virement depuis le portefeuille d'un magasin vers un contact bénéficiaire. **Flux de virement :** 1. Spécifiez le magasin depuis lequel transférer les fonds 2. Spécifiez le contact (bénéficiaire) qui recevra les fonds 3. Spécifiez le montant en centimes 4. Le système déduit automatiquement les frais et traite le virement **Méthodes de virement prises en charge :** - **Mobile Money** : Wave, Orange Money, MTN Mobile Money, Moov Money, DJAMO - **Compte bancaire** : Virements bancaires via RIB **Cas d'usage :** - Paiements de salaires - Paiements aux fournisseurs - Demandes de retrait d'espèces des clients - Virements entre entreprises **Notes importantes :** - Le magasin doit appartenir à l'entreprise authentifiée - Le contact doit appartenir à l'entreprise authentifiée - Un solde suffisant doit être disponible dans le portefeuille du magasin - Les frais de virement sont automatiquement calculés et déduits - Si vous envoyez un champ `reference`, utilisez une valeur unique par tentative de transfert ; une valeur déjà utilisée renvoie `409 Conflict` - La `reference` est renvoyée dans les réponses de l’API Partenaire et dans les payloads webhook de transaction lorsqu’elle a été fournie à la création