Skip to content

Retrieve a specific order

Request

Returns one order by its Banxa order ID: its status, crypto and fiat amounts, fees, payment method, and the asset, blockchain and wallet address. Use it to check an order's status, for example after a webhook arrives. See Order statuses for what each status means.

Path
partnerstringrequired

This is the partner code provided to you during onboarding. e.g. metamask.

orderIdstringrequired

The Banxa Order ID to be retrieved.

Headers
Acceptstring
Default:"application/json"
x-api-keystring

This is the API Key that has been provided to you during onboarding.

Example:YOUR_API_KEY
curl -i -X GET \
  'https://docs.banxa.com/_mock/products/hosted-checkout/openapi/{partner}/v2/orders/{orderId}' \
  -H 'Accept: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

Responses

Order details.

Bodyapplication/json
createdAtstring
Example:"2022-08-22T09:10:43.724Z"
updatedAtstring
Example:"2022-08-22T09:13:56.165Z"
idstring
Example:"191fa5b4b1f45e1cf784422e09317d56"
referenceinteger

Banxa’s internal numeric reference for the order. Quote this to Banxa Support.

Example:12345678
externalOrderIdstring
Example:"a4b427ccb872a1744b317456bd0d165f"
externalCustomerIdstring
Example:"testing123"
countrystring
Example:"US"
orderStatusUrlstring
Example:"https://banxa.status/a4b427ccb872a1744b317456bd0d165f"
orderTypestring
Example:"BUY"
cryptoobject
fiatstring
Example:"CAD"
fiatAmountstring
Example:"1000.00"
cryptoAmountstring
Example:"696.63"
paymentMethodIdstring
Example:"apple-pay"
paymentMethodNamestring
Example:"Apple Pay"
originalPaymentMethodIdstring or null

If the customer switched payment method during checkout (for example after a failed payment), the payment method ID they started with. null otherwise.

Example:null
isRetryboolean

true if this order is a retry after the customer switched payment method.

Example:false
processingFeestring
Example:"0.30"
networkFeestring
Example:"1.67"
partnerFeestring
Example:"0.03"
discountobject

Present when a discountCode was applied to the order.

transactionHashstring or null

On-chain transaction hash. For sell orders, the hash of the customer’s deposit transaction; null until the deposit is confirmed.

Example:"0x5ea06c4724e8119704a1b57c918acf31742eb06cdf3f8678fdb17f41bbaf968e"
walletAddressstring or null

For buy orders, the customer’s receiving wallet. For sell orders: before checkout, the customer’s own sending wallet (the walletAddress sent on POST /v2/sell); once status is waitingPayment, Banxa’s deposit address for the order. Don’t send crypto to it until status is waitingPayment.

Example:"0x75b8d4d81377d4b0f11798779563462264914a24"
walletAddressTagstring or null

Memo or tag for walletAddress, on chains that use one. For sell orders, include it with the deposit.

Example:"1651352"
statusstring

Order status. See Order statuses.

Example:"complete"
metadataArray of any or object or null

Metadata you attached to the order, returned as parsed JSON (an object or array). null when none was sent.

Example:
{
  "tracking_id": "HSKJDGHKSJG0393LJKJF"
}
Response
{
  "createdAt": "2022-08-22T09:10:43.724Z",
  "updatedAt": "2022-08-22T09:13:56.165Z",
  "id": "191fa5b4b1f45e1cf784422e09317d56",
  "externalOrderId": "a4b427ccb872a1744b317456bd0d165f",
  "externalCustomerId": "testing123",
  "country": "US",
  "orderStatusUrl": "https://banxa.status/a4b427ccb872a1744b317456bd0d165f",
  "orderType": "BUY",
  "crypto": {
    "id": "USDC",
    "blockchain": "TRON",
    "address": "0x0000000000000000000000000000000000000000",
    "network": "1"
  },
  "fiat": "CAD",
  "fiatAmount": "1000.00",
  "cryptoAmount": "696.63",
  "paymentMethodId": "apple-pay",
  "paymentMethodName": "Apple Pay",
  "processingFee": "0.30",
  "networkFee": "1.67",
  "transactionHash": "0x5ea06c4724e8119704a1b57c918acf31742eb06cdf3f8678fdb17f41bbaf968e",
  "walletAddress": "0x75b8d4d81377d4b0f11798779563462264914a24",
  "walletAddressTag": "1651352",
  "status": "complete",
  "metadata": {
    "tracking_id": "HSKJDGHKSJG0393LJKJF"
  }
}
© Banxa 2026