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 Platform API

Platform APIs for interacting with businesses

Cadana Platform API is one of 30 APIs that Cadana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 5 paths, and defines 27 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.

6 operations 5 paths 27 schemas 4 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 Platform 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 6

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

Platform 6

Platform APIs for interacting with businesses

POST
/v1/platform/businesses
Create
createBusiness body → 2004005XX
GET
/v1/platform/businesses
List
retrieveBusinesses 4 params → 200400
GET
/v1/platform/disbursements
List Disbursements
getPlatformDisbursements 10 params → 2004005XX
GET
/v1/platform/disbursements/{disbursementId}
Get Disbursement
getPlatformDisbursement 1 param → 2004004045XX
POST
/v1/platform/transfers
Create Transfer
createPlatformTransfer body → 2004004035XX
GET
/v1/permissions/roles
Custom Roles
getRoles 1 param → 2005XX

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are PlatformDisbursement (23 properties), bankDetails (15 properties), businessMinimalDetailsEntry (11 properties), CreateBusinessRequest (11 properties). Each schema is shown below with its type and property counts.

PlatformDisbursement
object
23 properties
operation
object
3 properties
businessMinimalDetailsEntry
object
11 properties
swiftDetails
object
7 properties 7 required
permission
object
2 properties
role
object
5 properties
CreateTransferRequest
object
4 properties 3 required
phoneNumber
object
Person's phone number
2 properties
uuid
string
NotFoundError
Not Found
walletDetails
object
3 properties
InternalError
Internal server error
CreateBusinessRequest
object
Create business request payload
11 properties 7 required
BadRequestError
Bad input provided by client
nodePagination
object
Node pagination
2 properties
ForbiddenError
Forbidden
beneficiaryId
object
ID details for the beneficiary
2 properties
Amount
object
2 properties 2 required
wireDetails
object
Wire transfer payment details
5 properties
node
object
Node pagination
2 properties
paymentMethods
object
7 properties 1 required
bankDetails
object
15 properties
momoDetails
object
5 properties
achDetails
object
7 properties
RevenueShare
object
2 properties
address
object
Address
6 properties 1 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-platform-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