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

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

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

This API exposes 6 operations across 4 paths, and defines 19 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 4 paths 19 schemas 1 DELETE4 GET1 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-offramp 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 6

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

ledger-offramp accounts 6
GET
/ledger/offramp-accounts
Get a list of offramp accounts
getOfframpAccounts 3 params → 200401
POST
/ledger/offramp-accounts
Create offramp account
createOfframpAccount body → 200400401
GET
/ledger/offramp-accounts/{offrampAccountId}
Get offramp account
getOfframpAccount 1 param → 200401404
DELETE
/ledger/offramp-accounts/{offrampAccountId}
Delete offramp account
deleteOfframpAccount 1 param → 200401404
GET
/ledger/offramp-accounts/{id}/funding-address
Get address for offramp account
getOfframpAccountFundingAddress 2 params → 200401404
GET
/ledger/offramp-accounts/{id}/transactions
Get transactions for offramp account
getOfframpAccountTransactions 3 params → 200401404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are CashPaymentTransaction (12 properties), LedgerSvcBlockchainNetwork (10 properties), TokenNetwork (8 properties), TransactionBlockchainInfo (8 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
OfframpAccountList
OfframpAccountTransaction
LedgerSvcBlockchainNetwork
object
Details of blockchain network
10 properties 6 required
OfframpAccount
object
5 properties 3 required
TokenNetwork
object
8 properties 5 required
TokenDetails
object
Details of supported funding token object.
4 properties 4 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…
CreateOfframpAccountRequest
object
2 properties 2 required
OfframpAccountStatus
string
Status of the offramp account.
TransactionBlockchainInfo
object
Blockchain transaction data, present on Crypto-backed transactions.
8 properties 4 required
Beneficiary
object
Fiat beneficiary object
7 properties 5 required
OfframpAccountTransactionList
Paging
object
Base object for paginated list
5 properties
TransactionBlockchainAddress
object
Address data
2 properties 1 required
CashPaymentTransaction
object
Details of a cash payment transaction.
12 properties 10 required
AccountHolderType
string
OfframpAccountFundingAddress
object
4 properties 3 required
BasicBeneficiaryInfo
object
Basic information about a beneficiary as at the time of transaction.
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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