Skip to main content
POST
Créer un lien de paiement

Authorizations

X-API-KEY
string
header
required

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

Body

application/json
storeId
string<uuid>
required

Identifiant du magasin

Example:

"59ae202a-f583-4a15-970f-9e99bd1e0baa"

title
string
required

Payment link title

Required string length: 10 - 255
Example:

"Payment for services"

amountCents
integer
required

Fixed amount in cents

Required range: x >= 10000
Example:

10000

currency
string
default:XOF
required

Code devise (ISO 4217)

Required string length: 3
Example:

"XOF"

allowMultiplePayments
boolean
default:false

Whether the payment link allows multiple payments

Example:

false

Response

Lien de paiement créé avec succès

Response schema for payment link operations

id
string
required

Payment link identifier

Example:

"d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc"

storeId
string
required

Identifiant du magasin

Example:

"59ae202a-f583-4a15-970f-9e99bd1e0baa"

title
string
required

Payment link title

Example:

"Payment for services"

amount
object
required

Fixed amount in cents

Example:
allowMultiplePayments
boolean
required

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)
Example:

false

canReceivePayments
boolean
required

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.

Example:

true

Shareable payment link URL

Example:

"https://pay.jeko.africa/c/abc123def456"