Skip to main content
POST
Pay 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.

Path Parameters

shortCode
string
required
Pattern: ^[A-Za-z0-9]{8,12}$

Body

application/json
customer_phone
string
required
Example:

"237670000000"

transaction_uuid
string<uuid>
required
customer_name
string
customer_email
string<email>
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
channel
enum<string>
Available options:
PROVIDER,
WALLET,
AUTO
otp
integer
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"

currency
string

Currency of the selected payment; the link currency is used if this field is omitted.

Example:

"USD"

source_amount
number

Link amount in source_currency before conversion. Follows root-level amount_unit.

source_currency
string

Source currency of the link amount before conversion.

Example:

"EUR"

Response

Transaction retournee

code
integer
Example:

200

success
boolean
Example:

true

locale
string
Example:

"fr"

message
string
meta
object
data
object