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

APIs for interacting with Business

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

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

This API exposes 6 operations across 6 paths, and defines 16 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 6 paths 16 schemas 2 GET2 POST2 PUT

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 Businesses 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 6 paths, the API surfaces 6 operations — 2 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Businesses 6

APIs for interacting with Business

GET
/v1/businesses/{businessId}
Get Business
getBusiness 2 params → 2004045XX
GET
/v1/me
Get Current Identity
getMe 1 param → 2005XX
POST
/v1/businesses/{businessId}/departments
Create Department
createDepartment 2 params body → 2005XX
PUT
/v1/businesses/{businessId}/departments/{departmentId}
Update Department
updateDepartment 3 params body → 2044005XX
POST
/v1/businesses/{businessId}/customFields
Create Custom Field
createCustomField 2 params body → 2005XX
PUT
/v1/businesses/{businessId}/customFields/{customFieldId}
Update Custom Field
updateCustomField 3 params body → 2044005XX

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are business (13 properties), address (6 properties), instantPaySettings (4 properties), customField (3 properties). Each schema is shown below with its type and property counts.

instantPaySettings
object
4 properties
department
object
2 properties
phoneNumber
object
Person's phone number
2 properties
UpdateDepartmentRequest
object
1 property
business
object
13 properties
uuid
string
AddDepartmentsRequest
object
1 property
NotFoundError
Not Found
InternalError
Internal server error
BadRequestError
Bad input provided by client
payrollSettings
object
2 properties
UpdateCustomFieldRequest
object
1 property
AddCustomFieldsRequest
object
1 property
customField
object
3 properties
address
object
Address
6 properties 1 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-businesses-api-openapi.yml Raw ↑

Other APIs Cadana publishes across the network.

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