Update a virtual account

You can use this endpoint to 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

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"

callbackUrl · string<url>

Callback url you want to update to

Example:

"https://webhook.site/98ef100f-5adc-4434-800a-0808h60bd8d7"

expectedAmount · string

If passed, the virtual account will only accept payments for this amount. Be careful as once being set this Virtual account can never take any amount again, thou you can always update the expected amount

Example:

"100.0"

Response

200

application/json

OK - your request was successful.

code · string · required

Response Code

Example:

"00"

description · string · required

Response description

Example:

"Success"

data · object · required

Show child attributes