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

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

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

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

4 operations 4 paths 12 schemas 2 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-transfer 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 4

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

ledger-transfer 4
POST
/ledger/internal-transfers
Create internal transfer
createInternalTransfer body → 201400401403default
GET
/ledger/internal-transfers/{referenceId}
Get internal transfer by reference
getInternalTransferByReference 1 param → 200400401403404default
POST
/ledger/crypto-transfer
Performs crypto transfer
cryptoTransfer body → 201400401403default
GET
/ledger/crypto-transfer/{transferReference}
Get crypto transfer by reference
getCryptoTransferByReference 1 param → 200400401403404default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AccountTransaction (14 properties), InternalTransfer (10 properties), TransactionBlockchainInfo (8 properties), InternalTransferRequest (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
AccountTransaction
object
14 properties 7 required
InternalTransferRequest
object
Internal request to transfer funds between two sub-accounts of between main account and sub-account. The accounts must have the same currency.
5 properties 3 required
TransactionType
string
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…
TransactionBlockchainInfo
object
Blockchain transaction data, present on Crypto-backed transactions.
8 properties 4 required
User2FAMethod
string
TransferResponse
object
The payment initiation response
4 properties 3 required
TransactionBlockchainAddress
object
Address data
2 properties 1 required
CryptoTransferDestination
object
The destination details of the transfer. Either beneficiaryId or address must be provided.
4 properties 1 required
CryptoTransferRequest
object
Request object for crypto payment initiation request. The sourceAccountId can be a main account or sub-account.
4 properties 3 required
InternalTransfer
object
10 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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