{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/hosted-checkout/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Order Lookup","description":"Official Banxa API documentation – on-ramp and off-ramp transfers with identity verification and compliance.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"order-lookup","__idx":0},"children":["Order Lookup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve order details and status programmatically. Use this to check individual order status, build order history views, or reconcile transactions."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-orders","__idx":1},"children":["List orders"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve a list of orders for your partner account, with optional filtering."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /{partnerRef}/v2/orders\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-parameters","__idx":2},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start date filter (ISO 8601 date, e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2024-03-01"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["End date filter (ISO 8601 date, e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2024-03-31"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by order status (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["complete"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},"). See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/transaction-lifecycle/order-statuses"},"children":["Order Statuses"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalCustomerId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter orders for a specific customer by your internal ID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number for pagination."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results per page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skip"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of records to skip."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example","__idx":3},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.banxa-sandbox.com/{partnerRef}/v2/orders\" \\\n  -H \"x-api-key: YOUR_API_KEY\" \\\n  -G \\\n  --data-urlencode \"start=2024-03-01\" \\\n  --data-urlencode \"end=2024-03-31\" \\\n  --data-urlencode \"status=complete\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":4},"children":["Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"orders\": [\n    {\n      \"id\": \"191fa5b4b1f45e1cf784422e09317d56\",\n      \"externalId\": \"a4b427ccb872a1744b317456bd0d165f\",\n      \"externalCustomerId\": \"testing123\",\n      \"country\": \"US\",\n      \"orderType\": \"BUY\",\n      \"orderStatusUrl\": \"https://banxa.status/a4b427ccb872a1744b317456bd0d165f\",\n      \"status\": \"complete\",\n      \"createdAt\": \"2022-08-22T09:10:43.724Z\",\n      \"updatedAt\": \"2022-08-22T09:13:56.165Z\",\n      \"crypto\": {\n        \"id\": \"USDC\",\n        \"blockchain\": \"TRON\",\n        \"address\": \"0x0000000000000000000000000000000000000000\",\n        \"network\": \"1\"\n      },\n      \"fiat\": \"CAD\",\n      \"fiatAmount\": \"1000.00\",\n      \"cryptoAmount\": \"696.63\",\n      \"paymentMethodId\": \"aabkd8792kd\",\n      \"paymentMethodName\": \"debit-credit-card\",\n      \"processingFee\": \"0.30\",\n      \"networkFee\": \"1.67\",\n      \"partnerFee\": \"\",\n      \"walletAddress\": \"0x75b8d4d81377d4b0f11798779563462264914a24\",\n      \"walletAddressTag\": \"1651352\",\n      \"transactionHash\": \"0x5ea06c4724e8119704a1b57c918acf31742eb06cdf3f8678fdb17f41bbaf968e\",\n      \"metadata\": \"{'tracking_id': 'HSKJDGHKSJG0393LJKJF'}\"\n    }\n  ],\n  \"pageTotal\": 10,\n  \"total\": 2654\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orders"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of order objects."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageTotal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of orders on this page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["total"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total number of orders matching the query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fiat"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fiat currency code (string)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["crypto"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nested object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["blockchain"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["network"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-a-specific-order","__idx":5},"children":["Get a specific order"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve full details for a single order by ID."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /{partnerRef}/v2/orders/{orderId}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"path-parameters","__idx":6},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orderId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Banxa order ID."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-1","__idx":7},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api.banxa-sandbox.com/{partnerRef}/v2/orders/191fa5b4b1f45e1cf784422e09317d56\" \\\n  -H \"x-api-key: YOUR_API_KEY\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-1","__idx":8},"children":["Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"191fa5b4b1f45e1cf784422e09317d56\",\n  \"externalId\": \"a4b427ccb872a1744b317456bd0d165f\",\n  \"externalCustomerId\": \"testing123\",\n  \"country\": \"US\",\n  \"orderType\": \"BUY\",\n  \"orderStatusUrl\": \"https://banxa.status/a4b427ccb872a1744b317456bd0d165f\",\n  \"status\": \"complete\",\n  \"createdAt\": \"2022-08-22T09:10:43.724Z\",\n  \"updatedAt\": \"2022-08-22T09:13:56.165Z\",\n  \"crypto\": {\n    \"id\": \"USDC\",\n    \"blockchain\": \"TRON\",\n    \"address\": \"0x0000000000000000000000000000000000000000\",\n    \"network\": \"1\"\n  },\n  \"fiat\": \"CAD\",\n  \"fiatAmount\": \"1000.00\",\n  \"cryptoAmount\": \"696.63\",\n  \"paymentMethodId\": \"apple-pay\",\n  \"paymentMethodName\": \"Apple Pay\",\n  \"processingFee\": \"0.30\",\n  \"networkFee\": \"1.67\",\n  \"walletAddress\": \"0x75b8d4d81377d4b0f11798779563462264914a24\",\n  \"walletAddressTag\": \"1651352\",\n  \"transactionHash\": \"0x5ea06c4724e8119704a1b57c918acf31742eb06cdf3f8678fdb17f41bbaf968e\",\n  \"metadata\": \"{'tracking_id': 'HSKJDGHKSJG0393LJKJF'}\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-responses","__idx":9},"children":["Error responses"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid parameter format. Response includes an error message describing the issue."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Order not found."]}]}]}]}]}]},"headings":[{"value":"Order Lookup","id":"order-lookup","depth":1},{"value":"List orders","id":"list-orders","depth":2},{"value":"Query parameters","id":"query-parameters","depth":3},{"value":"Example","id":"example","depth":3},{"value":"Response","id":"response","depth":3},{"value":"Get a specific order","id":"get-a-specific-order","depth":2},{"value":"Path parameters","id":"path-parameters","depth":3},{"value":"Example","id":"example-1","depth":3},{"value":"Response","id":"response-1","depth":3},{"value":"Error responses","id":"error-responses","depth":2}],"frontmatter":{"title":"Order Lookup — GET /v2/orders | Banxa Docs","description":"Retrieve Banxa order details and status with GET /v2/orders and GET /v2/orders/{orderId}. Filter by date range, status, or externalCustomerId with examples.","seo":{"title":"Order Lookup"}},"lastModified":"2026-05-19T23:30:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/hosted-checkout/docs/transaction-lifecycle/order-lookup","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}