Skip to main content
POST
Create a checkout

Authorizations

x-api-key
string
header
required

Your secret key. fpay_test_… keys use the sandbox; fpay_live_… keys move real money.

Body

application/json
amount
number
required

The amount to charge, in currency.

Example:

25000

currency
enum<string>
required

The currency you price in.

Available options:
USD,
NGN,
GHS,
KES,
UGX,
TZS,
XOF-BEN,
XOF-CIV
Example:

"NGN"

email
string

Your customer's email, for their receipt.

Example:

"ada@example.com"

memo
string

What the payment is for. Shown on the checkout page.

Example:

"Order #1042"

reference
string

Your own ID for the payment, such as an order ID. It comes back in the webhook.

Example:

"order_1042"

redirectUrl
string

Where the customer goes after paying.

Example:

"https://shop.example.com/thanks"

theme
enum<string>
default:light

The checkout page's colour scheme.

Available options:
light,
dark
Example:

"light"

Response

Payment session created.

message
string
Example:

"Transaction initialized successfully"

status
string
Example:

"success"

statusCode
number
Example:

201

data
object