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

Nestcoin ledger-cash deposits API

The ledger-cash deposits API from Nestcoin — 5 operation(s) for ledger-cash deposits.

Nestcoin ledger-cash deposits API is one of 23 APIs that Nestcoin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ledger-cash deposits. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.0.3, at version 3.0.2.

Requests are made against a single base URL, https://external.dev.onboardpay.co.

6 operations 5 paths 15 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.2
Base URL
https://external.dev.onboardpay.co
Authentication
API Key, API Key
License
UNLICENSED
Resource Areas
1

Authentication & Security 2

Nestcoin ledger-cash deposits API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-signature (authSignature). An API key is passed in the header as x-auth-token (authToken).

  • authToken — Auth Token header for inter-service communication

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.

ledger-cash deposits 6
GET
/ledger/cash-deposits/rates
Get reference rate
getCashDepositRates 2 params → 200400401
POST
/ledger/cash-deposits/quotes
Create deposit quote
createDepositQuote body → 200400401
GET
/ledger/cash-deposits
Retrieve list of cash deposits
getCashDeposits 4 params → 200401
POST
/ledger/cash-deposits
Create cash deposit
createCashDeposit body → 200400401
GET
/ledger/cash-deposits/{reference}
Get specific cash deposit
getCashDepositByReference 1 param → 200401404
GET
/ledger/cash-deposits/currencies
Get supported pay-in currencies
getCashDepositPayinCurrencies → 200401

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are CashDepositTransaction (12 properties), CashDepositQuote (9 properties), CreateCashDepositRequest (7 properties), Paging (5 properties). Each schema is shown below with its type and property counts.

CashDepositTransactionList
ErrorMessageDto
object
Default error object for services. This gives consistent error object that all services may use.
3 properties 2 required
CashPaymentCurrency
object
5 properties 5 required
TransferRate
object
3 properties 3 required
CashDepositTransaction
object
Details of a cash deposit transaction.
12 properties 9 required
TransactionStatus
string
Status of the transaction, indicating its current state in the processing lifecycle. - PENDING: The transaction has been created but not yet processed. - INPRO…
CashPaymentCurrenciesList
object
1 property 1 required
Paging
object
Base object for paginated list
5 properties
CashPaymentChannel
object
3 properties 3 required
CashDepositPaymentDetails
object
Destination account details the customer must pay into to fund the deposit. Mirrors a Beneficiary (without an id). Carries only the account details needed to m…
2 properties 2 required
CreateCashDepositRequest
object
Details required to create a cash deposit. The amount and currency must align with an existing quote.
7 properties 4 required
DepositSenderInfo
object
Identifies the party sending fiat for the deposit. When omitted on a deposit request, it is constructed from the business details.
4 properties 3 required
CashAccountDetails
object
4 properties 3 required
CashDepositQuote
object
9 properties 7 required
CreateDepositQuoteRequest
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nestcoin-ledger-cash-deposits-api-openapi.yml Raw ↑

Other APIs Nestcoin publishes across the network.

Nestcoin auth-oauth API
Nestcoin auth-userauth API
Nestcoin exchange-external-api API
Nestcoin exchange-orders API
Nestcoin ledger-account activity API
Nestcoin ledger-accounts API
Nestcoin ledger-beneficiaries API
Nestcoin ledger-offramp accounts API
Nestcoin ledger-payments API
Nestcoin ledger-sub-accounts API
Nestcoin ledger-transfer API
Nestcoin offers-offers API