v1

latestOpenAPI 3.1.02026-07-2656114159.7 KB

Checkout

Initialize Transaction

Initialize a new payment transaction with customer details, amount, and payment channels. This creates a transaction session that can be used for payment processing.

post/pms/transactions/initialize/

Headers

api-keystring required

Your Payvessel public API key

api-secretstring required

Your Payvessel secret

Content-Type'application/json' required

Request content type

Request body

amountstring required

Transaction amount in naira (for NGN) or minor currency units

channelsstring[] required

Payment channels to enable for this transaction

currency'NGN' | 'USD' required

Transaction currency code

metadataobject

Additional information about the transaction

customer_namestring required

Customer's full name

customer_emailstring email required

Customer's email address

customer_phone_numberstring required

Customer's phone number

redirect_urlstring uri

URL to redirect customer after payment completion

referencestring

Unique transaction reference (optional - auto-generated if not provided)

Response

Transaction initialized successfully

statusboolean

Transaction initialization status

messagestring

Response message