Skip to main content
POST
Create a payment link

Amount unit

Send amount in major units by default: 4.01 for 4.01 USD/EUR. API clients that already send cents can set amount_unit: "MINOR" at the root of the JSON body, alongside amount and currency, rather than in metadata. Public responses return major units even when the request uses MINOR. See amounts and currencies.

Authorizations

x-sp-auth-token
string
header
required

Bearer token obtained with the client_id and client_secret of the application created in SoleasPay. Format: Bearer <access_token>.

Body

application/json
currency
string
required
Example:

"XAF"

amount
number

Amount in major units by default: 4.01 for 4.01 USD/EUR. With root-level amount_unit MINOR, send integer cents (401).

provider
string
Example:

"mtn_cmr"

channel
enum<string>
Available options:
PROVIDER,
WALLET,
AUTO
feeBearer
enum<string>

Indique qui supporte les fees du lien.

Available options:
CUSTOMER,
MERCHANT
fee_bearer
enum<string>
deprecated
Available options:
CUSTOMER,
MERCHANT
customerPaysFees
boolean
deprecated
customer_pays_fees
boolean
deprecated
title
string
description
string
expires_at
string<date-time>
max_usage
integer
Required range: x >= 1
metadata
object
amount_unit
enum<string>
default:MAJOR

Unit of request amounts. Optional, MAJOR by default. Put this field at the root of the JSON body, not in metadata. MINOR preserves amounts already expressed in the smallest unit.

Available options:
MAJOR,
MINOR
Example:

"MAJOR"

Response

Payment link created

code
integer
Example:

200

success
boolean
Example:

true

locale
string
Example:

"fr"

message
string
meta
object
data
object