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

Cadana Virtual Accounts API

APIs for managing virtual accounts

Cadana Virtual Accounts API is one of 30 APIs that Cadana 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 3 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.cadanapay.com, https://dev-api.cadanapay.com.

3 operations 2 paths 14 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 3

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

Virtual Accounts 3

APIs for managing virtual accounts

POST
/v1/users/{userId}/virtual-accounts
Create Virtual Account
2 params body → 2044005XX
GET
/v1/users/{userId}/virtual-accounts
Get Virtual Accounts
2 params → 2004005XX
POST
/v1/sandbox/users/{userId}/virtual-accounts/{virtualAccountId}/deposit
Simulate virtual account deposit
3 params body → 2044005XX

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are JobInformation (9 properties), AccountInformation (8 properties), VirtualAccount (6 properties), address (6 properties). Each schema is shown below with its type and property counts.

JobInformation
object
9 properties 7 required
VirtualAccount
object
6 properties 5 required
SimulateVirtualAccountDepositRequest
object
Simulate virtual account deposit payload
3 properties 3 required
uuid
string
InternalError
Internal server error
CustomIdentification
object
2 properties 2 required
BadRequestError
Bad input provided by client
amount
object
2 properties 2 required
AccountInformation
object
8 properties 8 required
Amount
object
2 properties 2 required
CreateVirtualAccountRequest
object
4 properties 2 required
node
object
Node pagination
2 properties
address
object
6 properties 5 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Cadana publishes across the network.

Cadana Balances API
Cadana Beneficiaries API
Cadana Businesses API
Cadana Contracts API
Cadana Custom Auth API
Cadana Entities API
Cadana Events API
Cadana Files API
Cadana Filings API
Cadana FX API
Cadana Instant Pay API
Cadana Invoices API