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-sub-accounts API

The ledger-sub-accounts API from Nestcoin — 4 operation(s) for ledger-sub-accounts.

Nestcoin ledger-sub-accounts 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-sub-accounts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 4 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.

9 operations 4 paths 15 schemas 1 DELETE4 GET3 POST1 PUT

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-sub-accounts 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 9

Across 4 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ledger-sub-accounts 9
POST
/ledger/subaccounts
Create sub-account for a customer.
createSubAccount body → 201400401403404default
GET
/ledger/subaccounts
Fetch all sub-accounts belonging to the customer.
fetchSubAccounts 3 params → 200400401403default
GET
/ledger/subaccounts/{subAccountIdRef}
Fetch sub-account details by sub-account ID.
fetchSubAccountById 1 param → 200400401403404default
PUT
/ledger/subaccounts/{subAccountIdRef}
Update sub-account details by sub-account ID.
updateSubAccountById 1 param body → 200400401403404default
DELETE
/ledger/subaccounts/{subAccountIdRef}
Delete sub-account by sub-account ID.
deleteSubAccountById 1 param → 200400401403404default
GET
/ledger/subaccounts/{subAccountIdRef}/funding-address
Check funding address for a sub-account.
getSubAccountFundingAddress 2 params → 200400401403default
POST
/ledger/subaccounts/{subAccountIdRef}/funding-address
Create Funding Address for a sub-account using token network.
createSubAccountFundingAddress 3 params → 201400401403409default
GET
/ledger/subaccounts/{subAccountIdRef}/account-details
Get the bank account number for a sub-account.
getSubAccountNumber 2 params → 200400401403404default
POST
/ledger/subaccounts/{subAccountIdRef}/account-details
Create a bank account number for a sub-account.
createSubAccountNumber 2 params body → 201400401403409default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are LedgerSvcBlockchainNetwork (10 properties), SubAccount (8 properties), TokenNetwork (8 properties), Paging (5 properties). Each schema is shown below with its type and property counts.

ErrorMessageDto
object
Default error object for services. This gives consistent error object that all services may use.
3 properties 2 required
CreateSubAccountRequest
object
Request to create a sub-account under a main account.
3 properties 2 required
SubAccount
object
8 properties 7 required
LedgerSvcBlockchainNetwork
object
Details of blockchain network
10 properties 6 required
TokenNetwork
object
8 properties 5 required
UpdateSubAccountRequest
object
2 properties 1 required
CreateSubAccountNumberRequest
object
Request to generate a bank account number for a sub-account.
1 property 1 required
SubAccountList
Paging
object
Base object for paginated list
5 properties
FundingAddressResponse
object
2 properties 1 required
StatusDto
object
Status data, check additional message field.
4 properties 1 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
CashAccountDetails
object
4 properties 3 required
FundingAddress
object
3 properties 2 required
AccountBalanceDetails
object
Account balance details
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nestcoin-ledger-sub-accounts-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-cash deposits API
Nestcoin ledger-offramp accounts API
Nestcoin ledger-payments API
Nestcoin ledger-transfer API
Nestcoin offers-offers API