Skip to content

Retrieve a specific order

Request

Retrieves details for single order.

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.

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

Responses

200

Bodyapplication/json
createdAtstring
Example:"2022-08-22T09:10:43.724Z"
updatedAtstring
Example:"2022-08-22T09:13:56.165Z"
idstring
Example:"191fa5b4b1f45e1cf784422e09317d56"
externalIdstring
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"
processingFeestring
Example:"0.30"
networkFeestring
Example:"1.67"
transactionHashstring
Example:"0x5ea06c4724e8119704a1b57c918acf31742eb06cdf3f8678fdb17f41bbaf968e"
walletAddressstring
Example:"0x75b8d4d81377d4b0f11798779563462264914a24"
walletAddressTagstring
Example:"1651352"
statusstring
Example:"completed"
metadatastring
Example:"{'tracking_id': 'HSKJDGHKSJG0393LJKJF'}"
Response
{
  "createdAt": "2022-08-22T09:10:43.724Z",
  "updatedAt": "2022-08-22T09:13:56.165Z",
  "id": "191fa5b4b1f45e1cf784422e09317d56",
  "externalId": "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": "completed",
  "metadata": "{'tracking_id': 'HSKJDGHKSJG0393LJKJF'}"
}
© Banxa 2026