My App
Contacts

Créer un contact bénéficiaire

Crée un nouveau contact bénéficiaire pour les virements. **Types de contacts pris en charge :** - **Mobile Money** : Wave, Orange Money, MTN Mobile Money, Moov Money, DJAMO - **Compte bancaire** : Virements bancaires via RIB (Relevé d'Identité Bancaire) **Contact Mobile Money :** Nécessite un numéro de téléphone dans l'objet identifier. **Contact bancaire :** Nécessite les détails bancaires complets incluant le nom de la banque, les codes, le numéro de compte et la clé RIB. **Cas d'usage :** - Ajouter des bénéficiaires de paie - Enregistrer les détails de paiement des fournisseurs - Sauvegarder les informations de retrait d'espèces des clients

POST
/partner_api/contacts

Crée un nouveau contact bénéficiaire pour les virements.

Types de contacts pris en charge :

  • Mobile Money : Wave, Orange Money, MTN Mobile Money, Moov Money, DJAMO
  • Compte bancaire : Virements bancaires via RIB (Relevé d'Identité Bancaire)

Contact Mobile Money : Nécessite un numéro de téléphone dans l'objet identifier.

Contact bancaire : Nécessite les détails bancaires complets incluant le nom de la banque, les codes, le numéro de compte et la clé RIB.

Cas d'usage :

  • Ajouter des bénéficiaires de paie
  • Enregistrer les détails de paiement des fournisseurs
  • Sauvegarder les informations de retrait d'espèces des clients

Authorization

X-API-KEY<token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/partner_api/contacts" \  -H "Content-Type: application/json" \  -d '{    "name": "John Doe",    "paymentMethod": "wave",    "identifier": {      "number": "+2250701234567"    }  }'

{
  "id": "59ae202a-f583-4a15-970f-9e99bd1e0baa",
  "name": "John Doe",
  "paymentMethod": "wave",
  "identifier": {
    "number": "+2250701234567"
  }
}

{
  "id": "unauthorized",
  "message": "Unauthorized",
  "extras": "Détails supplémentaires de l'erreur"
}
{
  "id": "forbidden_action",
  "message": "Action interdite",
  "extras": "Détails supplémentaires de l'erreur"
}
{
  "id": "validation_error",
  "message": "Échec de la validation",
  "extras": {
    "errors": [
      {
        "field": "paymentDetails.data.paymentMethod",
        "rule": "in",
        "message": "The paymentDetails.data.paymentMethod must be one of the following: orange, wave, mtn, moov, djamo"
      },
      {
        "field": "paymentDetails.data.deviceId",
        "rule": "required",
        "message": "The paymentDetails.data.deviceId field is required when paymentDetails.type is soundbox"
      }
    ]
  }
}
{
  "id": "internal_error",
  "message": "Une erreur inattendue s'est produite",
  "extras": "Détails supplémentaires de l'erreur"
}

Lister les banques prises en charge GET

Retourne la liste des banques prises en charge pour les virements bancaires. **Utilisez ce point de terminaison pour :** - Obtenir les codes bancaires valides pour créer des contacts bancaires - Afficher les options bancaires dans votre application - Valider les informations bancaires avant de créer des contacts **Les informations bancaires incluent :** - Nom de la banque (nom légal complet) - Code banque (code à 5 caractères utilisé dans le RIB) - Code SWIFT/BIC (8-11 caractères pour les virements internationaux) - Code pays (ISO 3166-1 alpha-2) **Note :** Ce point de terminaison ne nécessite pas d'authentification car il retourne des données statiques publiques.

Lister les contacts bénéficiaires GET

Retourne la liste de tous les contacts bénéficiaires pour l'entreprise authentifiée. Inclut à la fois les contacts mobile money et les contacts de comptes bancaires.