POST
/
v2
/
payment-pages

Request Body Parameters

name
string
required

The name of the Payment Page.

amount
integer
required

Amount to charge customer.

currency
string
default:
"NGN"
required

The currency of the amount. The only currency currently supported is NGN.

slug
string

The preferred page URL. If none is provided, it generates a slug based on the name.

paymentMethod
array

The allowed payment methods to be used for payment. Possible values include: Flutterwave.

callbackUrl
string

The URL to redirect user to after a payment attempt.

activeAt
datetime

The date and time the payment page should become active. If not provided, the payment page is immediately active.

expiresAt
datetime

The date and time the payment page should expire. If not provided, the payment page will never expire.

settlementAccounts
array

The Settlement Account IDs that payments received should go into. Multiple settlement account ids can be added alongside the amount to be settled. The key for each array index should be: settlementAccountId (for the settlement account id) and splitAmount (for the amounts)

additionalFields
array

If you want users to provide additional information before making payment, specify them here. If none is specified, the defaults (First name, Last name, Email, Phone number) are used.

Response Data

id
string
required

The ID of the Payment Page

name
string
required

Name of the Payment Page

amount
string
required

Amount

currency
string
required

Currency

description
string

Description of the Payment Page

slug
string
required

Payment Page Slug

Payment Page link.

paymentMethods
array
callbackUrl
string

Callback URL

meta
array

More information about the payment page

settlementAccounts
array
activeAt
datetime

Payment Page active date.

expiresAt
datetime

Payment Page expiry date.

createdAt
datetime
required

Payment Page created time.

updatedAt
datetime
required

Payment Page updated time.