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
canReceivePaymentsreflè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-KEYetX-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
Authorizations
Clé API pour les requêtes de l'API Partenaire
Path Parameters
Payment link identifier
"d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc"
Response
Lien de paiement récupéré avec succès
Response schema for payment link operations
Payment link identifier
"d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc"
Identifiant du magasin
"59ae202a-f583-4a15-970f-9e99bd1e0baa"
Payment link title
"Payment for services"
Fixed amount in cents
{ "amount": 10000, "currency": "XOF" }Whether the payment link allows multiple payments.
false: One-time use link (becomes unavailable once payment is completed)true: Reusable link (can accept multiple payments)
false
Indicates whether the payment link can currently accept new payments.
Returns true when:
- The link allows multiple payments (
allowMultiplePayments: true), OR - There are no completed payment requests associated with this link
Important: Always check this field before directing customers to the payment link.
Attempting to pay through a link with canReceivePayments: false will result in an error.
true
Shareable payment link URL
"https://pay.jeko.africa/c/abc123def456"