Skip to main content
POST
Create a payment session

Authorizations

Authorization
string
header
required

API key for /api/v1/* endpoints

Body

application/json
amount
number
required

Amount in the given currency

Example:

50000

currency
string
required

ISO currency code

Example:

"NGN"

title
string

Session title shown on the checkout page

Example:

"Payment for Order #1234"

description
string

Session description shown on the checkout page

Example:

"Complete your order payment"

crypto_asset
enum<string>

Crypto asset (locks asset for this session)

Available options:
BTC,
TRX,
BNB,
TON,
USDT,
ETH,
USDC,
SOL
network
enum<string>

Blockchain network (locks chain for this session)

Available options:
Bitcoin,
Binance_Smart_Chain,
Ethereum,
Solana,
Tron,
Base,
Arbitrum,
TON
customer_email
string

Customer email to link this session to

Example:

"hansen@gmail.com"

first_name
string

Customer first name

Example:

"Billy"

last_name
string

Customer last name

Example:

"James"

expires_in_minutes
number

Minutes until this session expires (default: 30)

Example:

30

success_url
string

Redirect URL on successful payment

cancel_url
string

Redirect URL on cancelled payment

metadata
object

Arbitrary key-value data

Example:

Response

Payment session created successfully.