Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nomba Virtual Accounts API

Endpoints for creating, fetching, filtering, updating, and expiring virtual bank accounts used for payment collection.

Nomba Virtual Accounts API is one of 14 APIs that Nomba publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Virtual Accounts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.nomba.com, https://sandbox.nomba.com.

5 operations 4 paths 5 schemas 1 DELETE1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.nomba.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Nomba Virtual Accounts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth2 bearer token obtained from the Nomba Authentication API.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Virtual Accounts 5

Endpoints for creating, fetching, filtering, updating, and expiring virtual bank accounts used for payment collection.

POST
/v1/accounts/virtual
Create a virtual account
createVirtualAccount 1 param body → 200400401
POST
/v1/accounts/virtual/filter
Filter virtual accounts
filterVirtualAccounts 1 param body → 200401
GET
/v1/accounts/virtual/{accountRef}
Fetch a virtual account
fetchVirtualAccount 2 params → 200401404
PUT
/v1/accounts/virtual/{accountRef}
Update a virtual account
updateVirtualAccount 2 params body → 200400401404
DELETE
/v1/accounts/virtual/{identifier}
Expire a virtual account
expireVirtualAccount 2 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are VirtualAccount (7 properties), VirtualAccountResponse (3 properties), VirtualAccountListResponse (3 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
3 properties
VirtualAccountListResponse
object
3 properties
VirtualAccount
object
7 properties
SuccessResponse
object
2 properties
VirtualAccountResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nomba-virtual-accounts-api-openapi.yml Raw ↑

Other APIs Nomba publishes across the network.

Nomba Checkout SDK
Nomba Accounts API
Nomba Authentication API
Nomba Card Charge API
Nomba Checkout Orders API
Nomba Corridors API
Nomba Exchange Rates API
Nomba Order Management API
Nomba Payouts API
Nomba Saved Cards API
Nomba Tokenized Cards API
Nomba Transactions API