Skip to main content
GET
/
exchange
/
api
/
orders
Retrieve list of exchange orders
curl --request GET \
  --url https://external.dev.onboardpay.co/exchange/api/orders \
  --header 'x-auth-token: <api-key>'
{
  "orders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cexOrderId": 2,
      "apiKey": "<string>",
      "lastWebhookSentAt": "2023-11-07T05:31:56Z",
      "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reference": "0165359005113074501885",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerName": "John Doe",
      "offer": {
        "partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "transactionType": "ONRAMP",
        "rate": 0.32,
        "networkId": "TRC20",
        "token": "USDT",
        "tokenAmount": 120.5,
        "offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "fiatSymbol": "NGN",
        "fiatAmount": 120.5,
        "partnerDisplayName": "John Doe"
      },
      "escrowAddress": 1.2869144918162796e+48,
      "paymentChannelId": "BANK_TRANSFER_NIGERIA",
      "paymentMethod": {},
      "buyerPaymentMethod": {},
      "customerWallet": {
        "walletAddress": 0,
        "networkId": "bsc_testnet",
        "walletName": "My Trust Wallet"
      },
      "tokenAddress": 0,
      "status": "INITIATED",
      "createdAt": "2023-11-07T05:31:56Z",
      "initiatedAt": "2023-11-07T05:31:56Z",
      "depositedAt": "2023-11-07T05:31:56Z",
      "confirmedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "lockHash": "null",
      "confirmationHash": "null",
      "cancellationHash": "null"
    }
  ],
  "pageNumber": 123,
  "pageSize": 123,
  "totalPages": 123,
  "totalOrders": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.onboard.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Fetches a paginated list of all orders associated with a user or account, providing visibility into historical and ongoing trades.

Authorizations

​
x-auth-token
string
header
required

Query Parameters

​
from
string<date>

15-04-2022

​
to
string<date>

15-08-2022

​
size
integer
default:20
Required range: x <= 100
​
page
integer
default:1
​
transactionType
enum<string>
Available options:
ONRAMP,
OFFRAMP
​
statuses
enum<string>[]
Available options:
INITIATED,
DEPOSITED,
CONFIRMED,
COMPLETED,
PENDING,
CANCELLED,
IN_DISPUTE,
AWAITING_ACCEPTANCE
​
token
string
​
fiat
string
​
network
string

Response

Success

​
orders
object[]
​
pageNumber
integer
​
pageSize
integer
​
totalPages
integer
​
totalOrders
integer