Create a Payment Request (v2.2)

post deprecated

https://api-v3-sandbox.vertofx.com/profile/v2.2/request

Create a payout request from a wallet to a beneficiary, prepare for planned sender-detail validation, and track the payout safely.

🗓️
This endpoint is deprecated and will be sunset on January 30, 2027. Migrate to the new service-specific route before then — see the Legacy Endpoint Migration Guide for the full mapping.

Body Params

beneficiaryId

number

required

Id of the beneficiary you want to generate the payment request for. To get the Id use the response path response.body.data[].id Get all Beneficiaries API.

purposeId

number

required

Use purposeId to state the purpose of the transfer of funds. Use the Get Purpose Codes API to get the purpose codes

amount

number

required

The amount you want to transfer.

walletId

number

required

The Id of the wallet, get the wallet id from the wallet list API.

clientReference

string

You can use this to pass a reference that you'd like Verto to store.

paymentId

string

required

This helps us identify a unique payment request. If the same value is sent in a duplicate payment request, it will be rejected.

supportingDocS3Key

string

key obtained in generate an upload link in case client wants to attach supporting document.

sender

object

Company or Individual initiating the transaction

Responses

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error