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

APIs for managing user beneficiaries

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

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

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

10 operations 6 paths 22 schemas 2 DELETE5 GET3 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 Beneficiaries 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 10

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

Beneficiaries 10

APIs for managing user beneficiaries

POST
/v1/users/{userId}/beneficiaries
Create beneficiary
2 params body → 2004005XX
GET
/v1/users/{userId}/beneficiaries
List beneficiaries
2 params → 2004045XX
GET
/v1/users/{userId}/beneficiaries/{beneficiaryId}
Get beneficiary
3 params → 2004045XX
DELETE
/v1/users/{userId}/beneficiaries/{beneficiaryId}
Delete beneficiary
3 params → 2044045XX
POST
/v1/beneficiaries
Create
1 param body → 2004005XX
GET
/v1/beneficiaries
List
1 param → 2004045XX
GET
/v1/beneficiaries/{beneficiaryId}
Get
2 params → 2004045XX
DELETE
/v1/beneficiaries/{beneficiaryId}
Delete
2 params → 2044045XX
POST
/v1/files/upload-url
Create upload URL
1 param body → 2004005XX
GET
/v1/files/{fileId}
Get file details
2 params → 2004045XX

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are bankDetails (15 properties), proxyDetails (9 properties), paymentDetails (8 properties), kycMinimal (8 properties). Each schema is shown below with its type and property counts.

proxyDetails
object
9 properties
cryptoWalletDetails
object
4 properties
swiftDetails
object
7 properties 7 required
CreateBeneficiaryRequest
object
5 properties 4 required
FileDetails
object
6 properties 6 required
phoneNumber
object
2 properties 2 required
paymentDetails
object
8 properties 1 required
NotFoundError
Not Found
walletDetails
object
3 properties
InternalError
Internal server error
BadRequestError
Bad input provided by client
beneficiaryId
object
ID details for the beneficiary
2 properties
Beneficiary
node
object
Node pagination
2 properties
bankDetails
object
15 properties
momoDetails
object
5 properties
achDetails
object
7 properties
CreateBeneficiaryRequest_2
object
6 properties 5 required
UploadUrlRequest
object
2 properties 2 required
address
object
6 properties 5 required
kycMinimal
object
KYC attributes for a beneficiary
8 properties 7 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-beneficiaries-api-openapi.yml Raw ↑

Other APIs Cadana publishes across the network.

Cadana Balances 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
Cadana Jurisdictions API