Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB
Virtual Accounts

Update a virtual account

You can use this endpoint to update a virtual account.

put/v1/accounts/virtual/{identifier}

Path parameters

identifierstring required
Example:INVOICE-20230823-0000 or 0107841806

The account reference or 10 digit Virtual account number of the VA to be updated.

Headers

accountIdstring uuid required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

newAccountRefstring

The new accountReference you want to issue to the Virtual account. This will be the value advised in webhook post update

accountNamestring

Account holder's name you want to update to

expectedAmountstring

If provided, the virtual account will only accept payments that exactly match the specified amount.

Once expectedAmount is set, the virtual account will no longer accept arbitrary payment amounts. You can, however, update the expectedAmount value at any time to change the accepted amount.

Example request

{
  "newAccountRef": "INVOICE_20230908_0001",
  "accountName": "Daniel Scorsese",
  "expectedAmount": "100.0"
}

Response

OK - your request was successful.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "updated": true
  }
}