Skip to main content
POST
Create a payment request

Authorizations

Authorization
string
header
required

Enter your API key starting with gtw_sk_

Body

application/json
targetAmount
number
required

Payment target amount

Example:

35000

sourceCurrency
string
required

ISO 4217 source currency code

Example:

"EUR"

targetCurrency
string
required

ISO 4217 target currency code (supported payout currency)

Example:

"NGN"

reference
string
required

Unique payment reference (required).

customerId
string<uuid>
required

Customer ID to associate the payment with a specific customer (required).

description
string
Example:

"Monthly subscription"

payerName
string
payerEmail
string
redirectUrl
string

URL to redirect after payment authorization

provider
string

Pull-transfer provider. Defaults to the PAYMENT_PROVIDER env.

paymentType
string

Optional payment type hint (default DOMESTIC_PAYMENT).

paymentMethods
enum<string>[]

One or more payment methods the payer may use.

Minimum array length: 1
Available options:
bank_transfer,
card,
crypto,
mobile_money
metadata
object

Response

Payment created. Returns a linkToken, checkoutUrl, or hosted paymentLink to share with the payer to authorise the payment.