Create a payment request

post

https://api-payment-sandbox.vertofx.com/payments/create

Creates a new payment request based on the specified payment type. Supports wallet-to-business transfers, wallet payouts to bank accounts, and transfers within wallets. The payment type determines the required fields and validation rules applied.

Body Params

Request for wallet payout to a bank account.

customPaymentReference

string | null

Custom reference label for the payment.

isSplitPayment

boolean

Defaults to false

Indicates whether this is a split payment.

paymentType

string

enum

required

Type of payment - wallet payout to bank account.

Allowed:

purposeId

string

Purpose identifier for the payment.

paymentId

string

Uniquey identifier for the payment.

recurFrequency

string

enum

Recurrence frequency for scheduled payments. Required when scheduledDate is provided for recurring payments.

Allowed:

scheduledDate

date-time | null

Scheduled execution date in ISO 8601 format (UTC).

sender

object

Sender information for the payment.

sourceAmount

float

≥ 0.01

Amount to transfer from source wallet.

sourceWalletId

string

Source wallet identifier.

supportingDocS3Key

string | null

S3 key for supporting document.

targetAccountId

string

Target bank account identifier.

usageToken

string | null

Usage token for fee calculation.

payoutFeeToken

string | null

Payout fee token for fee calculation.

verificationOTP

string | null

OTP for payment verification.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Payment request created successfully.

400Bad Request - Invalid input or validation error.

401Unauthorized - Authentication required.

403Forbidden - Insufficient permissions to create payments.

500Internal Server Error - An unexpected error occurred on the server.