Skip to main content
GET
/
exchange
/
api
/
business
/
orders
/
{cexOrderId}
Retrieve an exchange order by cexOrderId
curl --request GET \
  --url https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId} \
  --header 'x-auth-token: <api-key>'
{
  "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"
}

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.

Retrieves detailed information about a specific order using the ID provided by the 3rd party application when initiating the trade.

Authorizations

​
x-auth-token
string
header
required

Path Parameters

​
cexOrderId
integer
required

Response

Success

​
id
string<uuid>
​
cexOrderId
integer
Required range: x >= 1
​
apiKey
string
​
lastWebhookSentAt
string<date-time>

Timestamp field.

​
orderId
string<uuid>
​
reference
string
Example:

"0165359005113074501885"

​
customerId
string<uuid>
​
customerName
string
Example:

"John Doe"

​
offer
object
​
escrowAddress
string

Escrow address

Example:

1.2869144918162796e+48

​
paymentChannelId
string
Example:

"BANK_TRANSFER_NIGERIA"

​
paymentMethod
object
​
buyerPaymentMethod
object
​
customerWallet
object
​
tokenAddress
string
Example:

0

​
status
enum<string>
Available options:
INITIATED,
DEPOSITED,
CONFIRMED,
COMPLETED,
PENDING,
CANCELLED,
IN_DISPUTE,
AWAITING_ACCEPTANCE
​
createdAt
string<date-time>

Timestamp field.

​
initiatedAt
string<date-time>

Timestamp field.

​
depositedAt
string<date-time>

Timestamp field.

​
confirmedAt
string<date-time>

Timestamp field.

​
completedAt
string<date-time>

Timestamp field.

​
cancelledAt
string<date-time>

Timestamp field.

​
lockHash
string
default:null
​
confirmationHash
string
default:null
​
cancellationHash
string
default:null