Skip to main content
PUT
Update a virtual account

Authorizations

Authorization
string
header
required

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

accountId
string<uuid>
required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Path Parameters

identifier
string
required

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

Example:

"INVOICE-20230823-0000 or 0107841806"

Body

application/json

The request payload required to update a virtual account. Please note that it might take a few seconds for the update to reflect in other banks depending on the bank's notification system.

newAccountRef
string

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

Required string length: 8 - 64
Example:

"INVOICE_20230908_0001"

accountName
string

Account holder's name you want to update to

Required string length: 8 - 64
Example:

"Daniel Scorsese"

expectedAmount
string

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:

"100.0"

Response

OK - your request was successful.

code
string
required

Response Code

Example:

"00"

description
string
required

Response description

Example:

"Success"

data
object
required