Skip to main content
POST
Start a payment

Authorizations

Authorization
string
header
default:ACCESS_TOKEN
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
amount
number
required
Example:

4000

currency
enum<string>
required
Available options:
NGN,
USD
Example:

"NGN"

provider
string

Omit to use the default enabled gateway.

purpose
string
Example:

"subscription"

Response

200 - application/json

Payment initialized with a reference and checkout details.

success
boolean
required
Example:

true

message
string
required
Example:

"Done"

data
any
required

Payload; shape depends on the endpoint.