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

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

Nestcoin orders-orders API is one of 23 APIs that Nestcoin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include orders-orders. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 5 paths, and defines 16 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 16 schemas 2 GET4 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 orders-orders 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 — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

orders-orders 6
POST
/orders/clients/orders
Create order
createClientOrder body → 200401403404default
GET
/orders/clients/orders
Get orders
getClientOrders 4 params → 200401403404default
POST
/orders/clients/orders/sell
Create SELL order (alias, returns OrderResponse)
createClientSellOrder body → 200401403404default
POST
/orders/clients/orders/buy
Create BUY order (returns OrderResponse with pay-in details)
createClientBuyOrder body → 200401403404default
GET
/orders/clients/orders/{orderRef}
Get order
getClientOrder 1 param → 200401403404default
POST
/orders/clients/orders/{orderRef}/cancel
Cancel a BUY order
cancelClientBuyOrder 1 param → 200400401403404default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are BaseOrderResponse (16 properties), Recipient (6 properties), BaseCreateOrderRequest (5 properties), PayinPaymentDetails (5 properties). Each schema is shown below with its type and property counts.

CreateOrderRequest
SELL order request. Canonical payload accepted by POST /clients/orders (and the /sell alias). The order side is implied by the endpoint — type is kept for back…
ErrorMessageDto
object
Default error object for services. This gives consistent error object that all services may use.
3 properties 2 required
BaseOrderResponse
object
16 properties 8 required
OrderType
string
CreateBuyOrderRequest
BUY order request accepted by POST /clients/orders/buy. Carries buyer (sender) information for the pay-in and an optional creditAccountId for where the asset s…
PaymentMode
string
How the buyer is paying fiat for a BUY order. Chosen at quote time on POST /quotes and persisted on the resulting quote; the BUY order then inherits the value…
BaseCreateOrderRequest
object
Fields shared between SELL and BUY order creation requests. Not used directly as a request body — see CreateOrderRequest (SELL) and CreateBuyOrderRequest (BUY).
5 properties 4 required
OrderQueryStatus
string
SenderInfo
object
Information identifying the party sending fiat for a pay-in (BUY order). Mirrors the SenderInfo used by the onboard-payouts pay-in endpoints — the order servic…
4 properties 2 required
OrderTransactionList
OrderResponse
Order response displayed to merchants and clients. They have different views of the order object.
Paging
object
Base object for paginated list
5 properties
ProviderPaymentChannel
string
Payment channel a provider is used for
Recipient
object
Details of the recipient of the transfer. Should be one of - BankAccountRecipient - P2PWalletRecipient - MobileMoneyRecipient
6 properties 4 required
StatusDto
object
Status data, check additional message field.
4 properties 1 required
PayinPaymentDetails
object
Buyer-facing payment details for a BUY order. Surfaced on the create-order response and on GET /clients/orders/{orderRef} for BUY orders so the buyer can re-fe…
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nestcoin-orders-orders-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 ledger-transfer API