Create a Payment Request (v2.2)

This service is used to create a payment withdrawal request by specifying a walletID, amount, beneficiaryID, paymentId and a purposeID. You can also provide a custom client reference if needed and paymentId is unique uuid for unique reference.

Body Params
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.

number
required

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

number
required

The amount you want to transfer.

number
required

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

string

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

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.

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

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json