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 Instant Pay API

APIs for interacting with Instant Pay functionality

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

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

This API exposes 3 operations across 2 paths, and defines 9 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 9 schemas 2 GET1 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 Instant Pay 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 — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Instant Pay 3

APIs for interacting with Instant Pay functionality

PUT
/v1/persons/{personId}/ipSetting
Update instant pay setting
updatePersonIPSetting 2 params body → 2044004045XX
GET
/v1/persons/{personId}/ipSetting
Get instant pay setting
getPersonIPSetting 2 params → 2004045XX
GET
/v1/persons/{personId}/instantPays
Get instant pay transactions
getPersonIPTransactions 3 params → 2005XX

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are instantPay (4 properties), Error (2 properties), amount (2 properties), instantPaySetting (1 property). Each schema is shown below with its type and property counts.

amount
object
2 properties 2 required
UpdatePersonIPSettingRequest
object
Update person instant pay settings payload
uuid
string
NotFoundError
Not Found
InternalError
Internal server error
instantPaySetting
object
Person's instant pay setting
1 property
BadRequestError
Bad input provided by client
Error
object
2 properties
instantPay
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-instant-pay-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 Invoices API
Cadana Jurisdictions API