My App
Liens de paiement

Obtenir un lien de paiement par ID

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

GET
/partner_api/payment_links/{id}

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

Authorization

X-API-KEY<token>

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

In: header

Path Parameters

id*string

Payment link identifier

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/partner_api/payment_links/d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc"
{
  "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": "unauthorized",
  "message": "Unauthorized",
  "extras": "Détails supplémentaires de l'erreur"
}
{
  "id": "payment_link_not_found",
  "message": "Payment link not found",
  "extras": "Payment link not found"
}
{
  "id": "internal_error",
  "message": "Une erreur inattendue s'est produite",
  "extras": "Détails supplémentaires de l'erreur"
}

Créer un lien de paiement POST

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

Lister les magasins GET

Retourne la liste des magasins pour l'entreprise authentifiée. **Pourquoi les magasins sont importants :** - Chez Jeko, les entreprises peuvent avoir plusieurs magasins (emplacements physiques, boutiques en ligne, etc.) - Toutes les opérations de paiement (demandes de paiement, liens de paiement) doivent être associées à un magasin spécifique - Chaque magasin a sa propre configuration, paramètres et historique de transactions - Les IDs de magasin sont requis pour créer des demandes de paiement et des liens de paiement **Cas d'usage :** - Obtenir les magasins disponibles avant de créer des opérations de paiement - Afficher les options de magasin dans l'interface de votre application - Valider les IDs de magasin avant d'effectuer des appels API de paiement **Authentification :** Nécessite les en-têtes de clé API.