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

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

Nestcoin ledger-payments 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-payments. 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-payments 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-payments 6
GET
/ledger/cash-payments/rates
Get reference rate
getCashPaymentRates 2 params → 200400401
POST
/ledger/cash-payments/quotes
Create transfer quote
createTransferQuote body → 200400401
GET
/ledger/cash-payments
Retrieve list of cash payments
getCashPayments 4 params → 200401
POST
/ledger/cash-payments
Create cash payment
createCashPayment body → 200400401
GET
/ledger/cash-payments/{reference}
Get specific cash payment
getCashPaymentByReference 1 param → 200401404
GET
/ledger/cash-payments/currencies
Get supported payout currencies
getCashPaymentPayoutCurrencies → 200401

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are CashPaymentTransaction (12 properties), CashPaymentQuote (9 properties), CreateCashPaymentRequest (8 properties), BasicBeneficiaryInfo (7 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
CashPaymentCurrency
object
5 properties 5 required
TransferRate
object
3 properties 3 required
CreateCashPaymentRequest
object
Details required to create a cash payment. The amount and currency must align with an existing quote.
8 properties 6 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
User2FAMethod
string
Paging
object
Base object for paginated list
5 properties
CashPaymentChannel
object
3 properties 3 required
TransferResponse
object
The payment initiation response
4 properties 3 required
CashPaymentTransactionList
CreateTransferQuoteRequest
object
4 properties 3 required
CashPaymentTransaction
object
Details of a cash payment transaction.
12 properties 10 required
BasicBeneficiaryInfo
object
Basic information about a beneficiary as at the time of transaction.
7 properties 5 required
CashPaymentQuote
object
9 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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