Passer au contenu principal
POST
Creer une intention de disbursement

Unité du montant

Envoyez amount en valeur réelle par défaut : 4.01 pour 4,01 USD/EUR. Les clients API qui envoient déjà des centimes peuvent préciser amount_unit: "MINOR" à la racine du corps JSON, au même niveau que amount et currency, et non dans metadata. Les réponses publiques reviennent en valeur réelle même si la requête utilise MINOR. Consultez les montants et devises. Déclarez amount_unit lors de la création de l’intent. Les requêtes execute et status suivantes utilisent transaction_reference et ne redéfinissent pas le montant.

Exemple USD

Cet exemple d’intent utilise la valeur réelle. Choisissez un provider autorisé pour l’opération et la devise.
Si votre client stocke des centimes, remplacez les champs monétaires par "amount": 401 et "amount_unit": "MINOR". Les deux représentations ciblent 4,01 USD ; les réponses publiques restent en valeur réelle.

Autorisations

x-sp-auth-token
string
header
requis

Token Bearer obtenu avec le client_id et le client_secret de l'application creee dans SoleasPay. Format: Bearer <access_token>.

Corps

application/json
amount
number
requis

Montant en valeur réelle par défaut : 4.01 pour 4,01 USD/EUR. Avec amount_unit MINOR à la racine, envoyez des centimes entiers (401).

Exemple:

2500

currency
string
requis
Exemple:

"XAF"

transaction_uuid
string<uuid>
requis
provider
string
requis
Exemple:

"mtn_cmr"

channel
enum<string>
requis
Options disponibles:
PROVIDER,
WALLET,
AUTO
Exemple:

"PROVIDER"

customer_wallet
string
requis
Exemple:

"670000000"

description
string
metadata
object
settlement_mode
enum<string>
Options disponibles:
DIRECT,
SPLIT
distribution
object[]
amount_unit
enum<string>
défaut:MAJOR

Unité des montants de la requête. Facultatif, MAJOR par défaut. Placez ce champ à la racine du corps JSON, pas dans metadata. MINOR conserve les montants déjà exprimés dans la plus petite unité.

Options disponibles:
MAJOR,
MINOR
Exemple:

"MAJOR"

Réponse

Transaction retournee

code
integer
Exemple:

200

success
boolean
Exemple:

true

locale
string
Exemple:

"fr"

message
string
meta
object
data
object