Skip to main content
POST
Créer une session
Essayez avec une clé sandbox (mp_sandbox_…) : aucun argent réel ne bouge. Voir Test et production.
La session dure 30 minutes. Votre client choisit sur la page son moyen de paiement : carte, ou mobile money dans n’importe quel pays proposé, avec conversion automatique. Voir Accepter un paiement pour le parcours complet.

Authorizations

Authorization
string
header
required

Votre clé API. Utilisez une clé sandbox (mp_sandbox_…) pour essayer : aucun argent réel ne bouge.

Headers

Idempotency-Key
string

Une clé unique par opération : la rejouer pendant 24 heures renvoie la même réponse sans rien créer de plus. Voir Idempotence.

Maximum string length: 255

Body

application/json
amount
integer
required

Montant en unités mineures, au moins 1. Voir Montants et devises.

Required range: x >= 1
currency
string
required

Code devise ISO 4217 de 3 lettres, par exemple XAF.

Required string length: 3
description
string

Affichée au client. 500 caractères maximum.

Maximum string length: 500
payer_name
string

Nom du payeur, prérempli

Maximum string length: 255
payer_email
string<email>

E-mail du payeur, prérempli

Maximum string length: 255
payer_phone
string

Téléphone du payeur, prérempli

Maximum string length: 20
success_url
string<uri>

Retour après paiement réussi {CHECKOUT_SESSION_ID} y est remplacé par l'identifiant de la session (cs_…) au retour du client.

Maximum string length: 2048
cancel_url
string<uri>

Retour si le client abandonne {CHECKOUT_SESSION_ID} y est remplacé par l'identifiant de la session (cs_…) au retour du client.

Maximum string length: 2048
payment_method_types
enum<string>[]

Ne proposer que ces moyens. Par exemple ["mobile_money"] si vous encaissez déjà la carte ailleurs. Absent : tous les moyens ouverts.

Minimum array length: 1
Available options:
mobile_money,
card
allowed_countries
string[]

Ne proposer que ces pays mobile money (codes à 3 lettres, pays ouverts uniquement). Absent : tous les pays ouverts.

Minimum array length: 1
metadata
object

Vos données libres, renvoyées dans les réponses et les webhooks.

Response

Session créée

data
object