Get Order by 3rd-party Order ID - Onboard Developer Documentation

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>'

import requests

url = "https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}"

headers = {"x-auth-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};

fetch('https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-auth-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-auth-token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

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>'

import requests

url = "https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}"

headers = {"x-auth-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};

fetch('https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-auth-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-auth-token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://external.dev.onboardpay.co/exchange/api/business/orders/{cexOrderId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

{
  "code": "UNKNOWN_ERROR",
  "message": "Request could not be completed due to an error",
  "data": {}
}

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

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

Show child attributes

escrowAddress

string

Escrow address

Example:

1.2869144918162796e+48

paymentChannelId

string

Example:

"BANK_TRANSFER_NIGERIA"

paymentMethod

object

buyerPaymentMethod

object

customerWallet

object

Show child attributes

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