POST
Create link

Authorizations

x-api-key
string
header
required

Your secret key. It starts with sk_test_ or sk_live_.

Body

application/json
title
string
required

Shown to the payer on the checkout page.

currency
string
required
Example:

"NGN"

description
string
amount
integer

Fixed amount in minor units. Leave it out to let the payer enter an amount.

Required range: x >= 1
expiresAt
string<date-time>
metadata
object
overpaymentTolerance
integer

How far above amount a payment may be and still be accepted, in minor units.

Required range: x >= 0
underpaymentTolerance
integer

How far below amount a payment may be and still be accepted, in minor units.

Required range: x >= 0
redirectUrl
string

Where the checkout sends the payer afterwards.

allowedMethods
enum<string>[]
Available options:
bank_transfer,
card,
mobile_money

Response

201

Payment link created