My App
Liens de paiement

Créer un lien de paiement

Crée un nouveau lien de paiement pour l'entreprise authentifiée. **Fonctionnalités :** - URL partageable : Retourne un lien qui peut être partagé avec les clients - Contrôle des paiements : Configurez des liens à usage unique ou réutilisables via `allowMultiplePayments` - Statut en temps réel : La réponse inclut `canReceivePayments` pour vérifier la disponibilité du lien **Champs de réponse :** - `canReceivePayments` : Toujours `true` pour les liens nouvellement créés - `allowMultiplePayments` : Contrôle si le lien peut accepter plusieurs paiements - `link` : URL partageable à envoyer aux clients

POST
/partner_api/payment_links

Crée un nouveau lien de paiement pour l'entreprise authentifiée.

Fonctionnalités :

  • URL partageable : Retourne un lien qui peut être partagé avec les clients
  • Contrôle des paiements : Configurez des liens à usage unique ou réutilisables via allowMultiplePayments
  • Statut en temps réel : La réponse inclut canReceivePayments pour vérifier la disponibilité du lien

Champs de réponse :

  • canReceivePayments : Toujours true pour les liens nouvellement créés
  • allowMultiplePayments : Contrôle si le lien peut accepter plusieurs paiements
  • link : URL partageable à envoyer aux 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

application/json

application/json

curl -X POST "https://example.com/partner_api/payment_links" \  -H "Content-Type: application/json" \  -d '{    "storeId": "59ae202a-f583-4a15-970f-9e99bd1e0baa",    "title": "Payment for services",    "amountCents": 10000,    "currency": "XOF"  }'
{
  "id": "d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc",
  "storeId": "59ae202a-f583-4a15-970f-9e99bd1e0baa",
  "title": "Payment for services",
  "amount": {
    "amount": 10000,
    "currency": "XOF"
  },
  "allowMultiplePayments": false,
  "canReceivePayments": true,
  "link": "https://pay.jeko.africa/c/abc123def456"
}
{
  "id": "internal_error",
  "message": "Une erreur inattendue s'est produite",
  "extras": "Détails supplémentaires de l'erreur"
}
{
  "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": "internal_error",
  "message": "Une erreur inattendue s'est produite",
  "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 villes et municipalités (API Fournisseur de services) GET

Retourne la liste des villes et leurs municipalités. Ce point de terminaison est équivalent à `/static/locations` mais filtre les localisations désactivées. **Utilisez ce point de terminaison pour :** - Obtenir les codes de ville et municipalité valides pour l'enregistrement des entreprises - Afficher les options de localisation dans votre application - Valider les informations de localisation avant de créer des entreprises **Informations sur les localisations :** - Seules les villes et municipalités activées sont retournées - Chaque ville contient une liste de ses municipalités - Les localisations sont triées par ordre alphabétique **Authentification :** Nécessite les en-têtes de clé API. L'entreprise authentifiée doit être un fournisseur de services.

Obtenir un lien de paiement par ID GET

Récupère un lien de paiement par son ID avec le statut de disponibilité des paiements en temps réel. **Informations clés :** - Retourne la même structure que le point de terminaison de création - Le champ `canReceivePayments` reflète le statut actuel du lien - Utilisez ce point de terminaison pour vérifier si un lien peut accepter de nouveaux paiements avant de diriger les clients **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 liens de paiement qui appartiennent à l'entreprise authentifiée **Cas d'usage :** - Vérifier la disponibilité du lien avant de le partager avec les clients - Vérifier le statut du lien de paiement dans votre application - Valider les liens à usage unique avant réutilisation