Skip to main content
POST
Initier un paiement softpay
checkout_url est vide ("") dans l’immense majorité des cas — softpay pousse directement la demande de paiement, sans redirection. Une valeur non vide n’apparaît que si le réseau/gateway choisi retombe exceptionnellement sur un flux de redirection.

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:

"2500.00"

currency
string
required
Required string length: 3
Example:

"XOF"

country
string
required
Required string length: 2
Example:

"BJ"

customer
object
required
network
string
required

Code réseau, cf. référentiel pays/réseaux

Example:

"mtn_bj"

merchant
string<uuid>

UUID du marchand visé. Ignoré pour une clé API (toujours vous-même) ; pour un token dashboard gérant plusieurs marchands, résout la boutique visée si le header X-Merchant-Id n'est pas fourni.

description
string
Example:

"Abonnement mensuel"

metadata
object
fee_charge_mode
enum<string> | null

ADD_ON : les frais s'ajoutent au montant débité au client. DEDUCTED : les frais sont déduits du montant net reversé au marchand. Défaut : configuration du marchand.

Available options:
ADD_ON,
DEDUCTED
preferred_gateway
string

Code gateway à privilégier si plusieurs sont éligibles pour ce réseau

Response

Paiement poussé avec succès