Get order by transaction ID - Onboard Developer Documentation

Retrieve a particular transaction

curl --request GET \
  --url https://external.dev.onboardpay.co/transactions/{id} \
  --header 'x-auth-token: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference": "0165359005113074501885",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "INITIATED",
  "fee": {
    "asToken": "1000.0",
    "asFiat": 123
  },
  "customerName": "John Doe",
  "offer": {
    "partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transactionType": "ONRAMP",
    "rate": 0.32,
    "networkId": "TRC20",
    "token": "USDT",
    "tokenAmount": 120.5,
    "instantPayEnabled": true,
    "offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fiatSymbol": "NGN",
    "fiatAmount": 120.5,
    "usdAmount": 120.5,
    "partnerDisplayName": "John Doe",
    "adNote": "Guaranteed fast payment",
    "instantPayPaymentAccountId": "<string>",
    "tradeMode": "P2P"
  },
  "escrowAddress": 1.2869144918162796e+48,
  "paymentChannelId": "BANK_TRANSFER_NIGERIA",
  "paymentMethod": {},
  "buyerPaymentMethod": {},
  "customerWallet": {
    "walletAddress": 0,
    "networkId": "bsc_testnet",
    "walletName": "My Trust Wallet"
  },
  "tokenAddress": 0,
  "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",
  "cancellationReason": "<string>",
  "disputeId": "null",
  "timeout": {
    "name": "APPROVE_TRANSACTION",
    "startTime": "2023-11-07T05:31:56Z",
    "duration": 123,
    "timeLeft": 123
  },
  "lockHash": "null",
  "confirmationHash": "null",
  "cancellationHash": "null",
  "isPartnerAcknowledged": false,
  "defaultingParty": "CUSTOMER",
  "rating": 3,
  "isCexOrder": false,
  "instantPayProcessingStatus": "PENDING_IP_REPORT",
  "tradeValue": 123,
  "merchantTokenValue": 123,
  "customerTokenValue": 123,
  "payableAmount": 123,
  "thirdpartyOrderInfo": {
    "businessId": "<string>",
    "tradeId": "<string>",
    "product": "<string>",
    "blockchainOrderId": 123,
    "externalOrderReference": "<string>"
  },
  "isNoKyc": true,
  "paymentReceiptUploadId": "null",
  "suppressCustomerNotifications": false,
  "chatUnavailable": false,
  "tradeContext": "STANDARD_TRADE"
}

GET

transactions

{id}

Retrieve a particular transaction

curl --request GET \
  --url https://external.dev.onboardpay.co/transactions/{id} \
  --header 'x-auth-token: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference": "0165359005113074501885",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "INITIATED",
  "fee": {
    "asToken": "1000.0",
    "asFiat": 123
  },
  "customerName": "John Doe",
  "offer": {
    "partnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transactionType": "ONRAMP",
    "rate": 0.32,
    "networkId": "TRC20",
    "token": "USDT",
    "tokenAmount": 120.5,
    "instantPayEnabled": true,
    "offerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fiatSymbol": "NGN",
    "fiatAmount": 120.5,
    "usdAmount": 120.5,
    "partnerDisplayName": "John Doe",
    "adNote": "Guaranteed fast payment",
    "instantPayPaymentAccountId": "<string>",
    "tradeMode": "P2P"
  },
  "escrowAddress": 1.2869144918162796e+48,
  "paymentChannelId": "BANK_TRANSFER_NIGERIA",
  "paymentMethod": {},
  "buyerPaymentMethod": {},
  "customerWallet": {
    "walletAddress": 0,
    "networkId": "bsc_testnet",
    "walletName": "My Trust Wallet"
  },
  "tokenAddress": 0,
  "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",
  "cancellationReason": "<string>",
  "disputeId": "null",
  "timeout": {
    "name": "APPROVE_TRANSACTION",
    "startTime": "2023-11-07T05:31:56Z",
    "duration": 123,
    "timeLeft": 123
  },
  "lockHash": "null",
  "confirmationHash": "null",
  "cancellationHash": "null",
  "isPartnerAcknowledged": false,
  "defaultingParty": "CUSTOMER",
  "rating": 3,
  "isCexOrder": false,
  "instantPayProcessingStatus": "PENDING_IP_REPORT",
  "tradeValue": 123,
  "merchantTokenValue": 123,
  "customerTokenValue": 123,
  "payableAmount": 123,
  "thirdpartyOrderInfo": {
    "businessId": "<string>",
    "tradeId": "<string>",
    "product": "<string>",
    "blockchainOrderId": 123,
    "externalOrderReference": "<string>"
  },
  "isNoKyc": true,
  "paymentReceiptUploadId": "null",
  "suppressCustomerNotifications": false,
  "chatUnavailable": false,
  "tradeContext": "STANDARD_TRADE"
}

Retrieves detailed information about a specific order using its internal ID.

Authorizations

x-auth-token

string

header

required

Path Parameters

string<uuid>

required

Response

Success

string<uuid>

required

reference

string

required

Example:

"0165359005113074501885"

customerId

string<uuid>

required

status

enum<string>

required

Order transaction status

Available options:

INITIATED,

DEPOSITED,

CONFIRMED,

COMPLETED,

PENDING,

CANCELLED,

IN_DISPUTE,

AWAITING_ACCEPTANCE

fee

object

required

Show child attributes

fee.asToken

string

required

Example:

"1000.0"

fee.asFiat

number

required

customerName

string

Example:

"John Doe"

offer

object

Show child attributes

offer.partnerId

string<uuid>

required

offer.transactionType

enum<string>

required

Transaction order type, can be ONRAMP or OFFRAMP

Available options:

ONRAMP,

OFFRAMP

offer.rate

number

required

Example:

0.32

offer.networkId

string

required

Example:

"TRC20"

offer.token

string

required

Example:

"USDT"

offer.tokenAmount

number

required

Example:

120.5

offer.instantPayEnabled

boolean

required

offer.offerId

string<uuid>

offer.fiatSymbol

string

Example:

"NGN"

offer.fiatAmount

number

Example:

120.5

offer.usdAmount

number

Example:

120.5

offer.partnerDisplayName

string

Example:

"John Doe"

offer.adNote

string

Example:

"Guaranteed fast payment"

offer.instantPayPaymentAccountId

string

offer.tradeMode

enum<string>

Available options:

P2P,

IP,

OTC

escrowAddress

string

Escrow address

Example:

1.2869144918162796e+48

paymentChannelId

string

Example:

"BANK_TRANSFER_NIGERIA"

paymentMethod

object

buyerPaymentMethod

object

customerWallet

object

Show child attributes

customerWallet.walletAddress

string

Example:

0

customerWallet.networkId

string

Example:

"bsc_testnet"

customerWallet.walletName

string

Example:

"My Trust Wallet"

tokenAddress

string

Example:

0

createdAt

string<date-time>

initiatedAt

string<date-time>

depositedAt

string<date-time>

confirmedAt

string<date-time>

completedAt

string<date-time>

cancelledAt

string<date-time>

cancellationReason

string

disputeId

string

default:null

timeout

object

Show child attributes

timeout.name

enum<string>

Available options:

APPROVE_TRANSACTION,

MAKE_DEPOSIT,

CONFIRM_DEPOSIT,

FLAG_DISPUTE,

ACKNOWLEDGE_TRANSACTION

timeout.startTime

string<date-time>

timeout.duration

number

timeout.timeLeft

integer<int64>

lockHash

string

default:null

confirmationHash

string

default:null

cancellationHash

string

default:null

isPartnerAcknowledged

boolean

default:false

defaultingParty

enum<string>

Type of user/role of user in transaction

Available options:

CUSTOMER,

PARTNER

rating

number

Example:

3

isCexOrder

boolean

Example:

false

instantPayProcessingStatus

enum<string>

Available options:

PENDING_IP_REPORT,

IN_PROGRESS,

FAILURE,

SUCCESS

tradeValue

number

deprecated

Actual token amount that is to be traded

merchantTokenValue

number

Actual token value that is to be traded by merchant less any fees

customerTokenValue

number

Actual token value that is to be traded by customer less any fees

payableAmount

number

Actual fiat amount that is to be paid.

thirdpartyOrderInfo

object

Show child attributes

thirdpartyOrderInfo.businessId

string

required

The thirdparty business the customer is trading via

thirdpartyOrderInfo.tradeId

string

Tracking trade Id

thirdpartyOrderInfo.product

string

Product name, typically custodial or web

thirdpartyOrderInfo.blockchainOrderId

integer

thirdpartyOrderInfo.externalOrderReference

string

isNoKyc

boolean

Flag showing if order is a no kyc order

paymentReceiptUploadId

string

default:null

Upload ID for receipt uploaded on storage bucket

suppressCustomerNotifications

boolean

default:false

Flag to indicate if notifications should be sent to the customer or not during the lifetime of this transaction

chatUnavailable

boolean

default:false

Flag to indicate if chat is unavailable for this transaction

tradeContext

enum<string>

Available options:

STANDARD_TRADE,

INTERNAL_RAIL

Get a User's Orders Get Order by 3rd-party Order ID

⌘I

Onboard Connect APIs

Authorizations

Path Parameters

Response