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

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

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

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

8 operations 4 paths 10 schemas 2 DELETE4 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-beneficiaries 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 8

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

ledger-beneficiaries 8
POST
/ledger/fiat-beneficiaries
Customer beneficiary
saveBeneficiary body → 201400401403default
GET
/ledger/fiat-beneficiaries
Fetch all bank account beneficiaries and bank transfer type
fetchBeneficiaries 4 params → 200400401403default
GET
/ledger/fiat-beneficiaries/{beneficiaryId}
Fetch Beneficiary by Id
getBeneficiaryById 1 param → 200400401403default
DELETE
/ledger/fiat-beneficiaries/{beneficiaryId}
Delete Beneficiary by Id
deleteBeneficiary 1 param → 200400401403default
POST
/ledger/crypto-beneficiaries
Crypto Customer beneficiary
saveCryptoBeneficiary body → 200400401403default
GET
/ledger/crypto-beneficiaries
Fetch crypto beneficiaries
fetchCryptoBeneficiary 3 params → 200400401403default
GET
/ledger/crypto-beneficiaries/{beneficiaryId}
Fetch crypto Beneficiary by Id
getCryptoBeneficiaryById 1 param → 200400401403default
DELETE
/ledger/crypto-beneficiaries/{beneficiaryId}
Delete crypto Beneficiary by Id
deleteCryptoBeneficiary 1 param → 200400401403default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are CreateBeneficiaryRequest (7 properties), Beneficiary (7 properties), CryptoBeneficiary (5 properties), Paging (5 properties). Each schema is shown below with its type and property counts.

CryptoBeneficiaryList
ErrorMessageDto
object
Default error object for services. This gives consistent error object that all services may use.
3 properties 2 required
CreateCryptoBeneficiaryRequest
object
create crypto beneficiary for customer
4 properties 2 required
Beneficiary
object
Fiat beneficiary object
7 properties 5 required
BeneficiaryList
Paging
object
Base object for paginated list
5 properties
CryptoBeneficiary
object
5 properties 3 required
CreateBeneficiaryRequest
object
create beneficiary for customer
7 properties 6 required
StatusDto
object
Status data, check additional message field.
4 properties 1 required
AccountHolderType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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