Skip to main content
POST
Créer une session de checkout hébergé
Idempotency-Key n’est pas pris en charge sur cet endpoint — un double-clic ou un retry réseau peut créer deux sessions distinctes. Sans conséquence financière : une session ne débite rien tant qu’elle n’est pas payée.

Rediriger votre client après paiement

Le champ return_url est optionnel — sans lui, votre client reste sur la page de succès AlphaPay après avoir payé, sans retour automatique vers votre site. Il n’apparaît pas dans les champs requis ci-dessus (dépliez “6 champs optionnels” pour le voir dans le testeur), mais vous pouvez l’envoyer dès la création :
Si vous le renseignez, la page de checkout hébergée redirige automatiquement le navigateur du client vers cette URL 3 secondes après confirmation d’un paiement réussi. Ce délai laisse le temps au client de voir la confirmation avant de quitter la page.
Ce comportement ne s’applique qu’au succès. Sur un paiement échoué ou annulé, return_url n’est actuellement pas utilisée : le client voit un bouton “Réessayer” sur place et doit fermer l’onglet lui-même s’il veut abandonner. Si votre intégration dépend d’un retour systématique vers votre site (succès ou échec), prévoyez ce cas de votre côté pour l’instant.

Authorizations

Authorization
string
header
required

Clé API secrète du marchand — header Authorization: Bearer sk_live_xxx (ou sk_test_xxx en environnement de test).

Body

application/json
amount
string<decimal>
required
Example:

"5000.00"

currency
string
required
Required string length: 3
Example:

"XOF"

customer_email
string<email>
required
Example:

"client@example.com"

customer_name
string
required
Example:

"Awa Sossou"

description
string
Example:

"Facture #1042"

country
string

Code ISO2, optionnel — présélectionne le pays sur la page de paiement

Required string length: 2
Example:

"BJ"

customer_phone
string
Example:

""

return_url
string<uri>

URL vers laquelle rediriger le client une fois le paiement terminé

metadata
object
expires_at
string<date-time>

Response

Session de checkout créée