v1

latestOpenAPI 3.0.12026-07-225791279.7 KB

Virtual Accounts

Fund Test Virtual Account

This endpoint funds the test virtual accounts. Please note that this API is just for sandbox collections.

post/merchant-collection/payaza/virtual_account/fund_test_virtual_account

Request body

account_namestring required

The name assigned to the virtual account.

account_numberstring required

The virtual account number.

initiation_transaction_referencestring

Required (for Dynamic Virtual Account). The unique identifier for the transaction. This value is empty for reserved virtual accounts.

transaction_amountstring required

the amount to be paid.

currencystring required

Currency code for the collection. Value is ‟NGN”.

source_account_numberstring required

The payer's account number.

source_account_namestring required

The payer's account name.

source_bank_namestring required

The payer's bank name.

Example request

{
  "account_name": "Payaza(Test DVA)",
  "account_number": "4030904675",
  "initiation_transaction_reference": "Ref1234567890",
  "transaction_amount": "1000",
  "currency": "NGN",
  "source_account_number": "0123456789",
  "source_account_name": "Jill Stones",
  "source_bank_name": "Test Bank"
}

Response

Initiate Payment Successful Response

messagestring

Response message.

successboolean

Request success status.

Example response

{
  "message": "Payment Notification successful"
}