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

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

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

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

This API exposes 4 operations across 4 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.

4 operations 4 paths 16 schemas 4 GET

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 transactions-transactions 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 — 4 GET. Each is listed below with its method, path, parameters, and response codes.

transactions-transactions 4
GET
/transactions/{id}
Retrieve a particular transaction
getTransactionById 1 param → 200400401500
GET
/transactions/{id}/contacts
Retrieve a particular transaction's contacts. Currently just phone numbers
getTransactionContacts 1 param → 200400401500
GET
/transactions/customers/{id}/history
Retrieve list of customer transactions
getCustomerTransactions 15 params → 200400401500
GET
/transactions/customers/{id}/history-aggregate
Retrieve list of customer transactions
getCustomerTransactionsAggregate 12 params → 200400401500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are TransactionDTO (40 properties), TransactionsSvcOfferDTO (16 properties), TransactionsResponse (5 properties), ThirdpartyOrderInfoDTO (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
TransactionsSvcTradeMode
string
TimeoutDTO
object
4 properties
TradeContext
string
ThirdpartyOrderInfoDTO
object
5 properties 1 required
TransactionHistoryAggregate
object
5 properties 2 required
TransactionsSvcTransactionType
string
Transaction order type, can be ONRAMP or OFFRAMP
TransactionsSvcOfferDTO
object
16 properties 7 required
TransactionOrderStatus
string
Order transaction status
TransactionDTO
object
40 properties 5 required
TransactionContactsDTO
object
2 properties
InstantPayProcessingStatus
string
UserType
string
Type of user/role of user in transaction
TransactionsSvcWalletDTO
object
3 properties
TransactionsResponse
object
5 properties
Fee
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nestcoin-transactions-transactions-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