Fetch information about an Order once its completed
The status of an Order can be one of the following
Draft - This is an open or ongoing order
Processed* - The payment has been completed.
Declined* - The transacation was declined, due to payment method issues
UserCustody - Crypto purchased for user but is in Sardine’s custodied wallet
Complete - The payment is complete and the crypto has been delivered to the user’s wallet. A txHash will be present to denote successful on chain settlement.
Expired - Order expired before execution
Events marked with an * can also be captured via event handlers on the frontend
Fetching Orders
Full list of Orders is obtained by making a call to the endpoint with no filters.
This order_id can then be used as a filter on this endpoint
E.g. /v1/orders/491c113c-4485-47cd-b011-252068b753dc
2. Filtering by referenceId
If a referenceId was passed in the call to create the clientToken for this call, it can now be used to filter for Orders that were created then.
E.g. /v1/orders?referenceId=42ead95db5aeb6c
3. Filtering by externalUserId
If a externalUserId was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user
3. Filtering by startDate and endDate
If startDate or endDate are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range
E.g. /v1/orders?startDate=2022-08-01&endDate=2022-08-15
paymentStatus field within the payment object in the response can be
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Sardine Payments","colors":{"primary":"#2D29D7","light":"#A09EED","dark":"#2D29D7"},"favicon":"https://mintcdn.com/sardine-payments/xaOaWQltc1g9zE_Z/favicon.svg?fit=max\u0026auto=format\u0026n=xaOaWQltc1g9zE_Z\u0026q=85\u0026s=fed6c9309f39bc0ac5929a9ba82977fa","logo":{"light":"https://mintcdn.com/sardine-payments/xaOaWQltc1g9zE_Z/logo/light.svg?fit=max\u0026auto=format\u0026n=xaOaWQltc1g9zE_Z\u0026q=85\u0026s=0f19e6244a4ae82cd0f46baf0fe1fe76","dark":"https://mintcdn.com/sardine-payments/xaOaWQltc1g9zE_Z/logo/dark.svg?fit=max\u0026auto=format\u0026n=xaOaWQltc1g9zE_Z\u0026q=85\u0026s=50ef9fd772da513ce447cc0ea28a85c6"},"appearance":{"default":"light","strict":null},"background":{"decoration":null,"color":{"light":null,"dark":"#0B0C0E"}},"navbar":{"primary":{"type":"button","label":"Get Started","href":"https://www.sardine.ai/contact"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Security Portal","href":"https://security.sardine.ai","icon":{"name":"shield-halved","style":"light"}},{"anchor":"Contact Us","href":"https://www.sardine.ai/contact","icon":{"name":"envelope","style":"light"}}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sardine-payments","hasAudioNarration":false,"actualSubdomain":"sardine-payments","customDomains":["docs.payments.sardine.ai"],"gitSource":{"type":"github","owner":"sardine-ai","repo":"payment-doc","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a7f5f2ff52eb3400ddd6800","collectionId":"e8cafca8-631a-4c66-910f-2660fbf04056","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a7f5f2ff52eb3400ddd6800"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a7f5f2ff52eb3400ddd6800:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Integration Guides","count":16},{"language":"default","tag":"API Reference (Onramp/Offramp)","count":16},{"language":"default","tag":"API Reference (NFT)","count":15},{"language":"default","tag":"Getting Started","count":11},{"language":"default","tag":"API Reference","count":8},{"language":"default","tag":"Coverage","count":7},{"language":"default","tag":"On/Off Ramps","count":7},{"language":"default","tag":"Payment Method","count":5},{"language":"default","tag":"Identity","count":4},{"language":"default","tag":"Products","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api_reference/onramp/order/get-an-order-by-id","slug":"/api_reference/onramp/order/get-an-order-by-id","pageMetadata":{"title":"Get an Order by ID","description":"Fetch information about an Order once its completed\n\nThe `status` of an Order can be one of the following\n\n`Draft` - This is an open or ongoing order\n\n`Processed`* - The payment has been completed.\n\n`Declined`* - The transacation was declined, due to payment method issues\n\n`UserCustody` - Crypto purchased for user but is in Sardine's custodied wallet\n\n`Complete` - The payment is complete and the crypto has been delivered to the user's wallet. A `txHash` will be present to denote successful on chain settlement. \n\n`Expired` - Order expired before execution\n\nEvents marked with an * can also be captured via event handlers on the frontend\n\n\n### Fetching Orders\n\nFull list of Orders is obtained by making a call to the endpoint with no filters. \n\n\nYou have multiple options of filtering orders\n\n**1. Filtering by `order_id`**\n\nIf a `redirect_url` was passed to the Sardine checkout (e.g. https://crytpoapp.com\"), when then transaction is completed, Sardine will redirect the user to this url with an `order_id` appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313\n\nThis `order_id` can then be used as a filter on this endpoint\n\nE.g. `/v1/orders/491c113c-4485-47cd-b011-252068b753dc`\n\n**2. Filtering by `referenceId`**\nIf a `referenceId` was passed in the call to create the `clientToken` for this call, it can now be used to filter for Orders that were created then. \n\nE.g. `/v1/orders?referenceId=42ead95db5aeb6c`\n\n**3. Filtering by `externalUserId`**\n\nIf a `externalUserId` was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user\n\n\n\n\n**3. Filtering by `startDate` and `endDate`**\nIf `startDate` or `endDate` are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range\n\nE.g. `/v1/orders?startDate=2022-08-01\u0026endDate=2022-08-15`\n\n\n\n`paymentStatus` field within the `payment` object in the response can be\n\n- Draft\n- Pending\n\nFor bank transfers, the value could be\n\n- Sent\n- Complete\n- Returned\n- Failed\n\nFor card transactions, the value can be\n\n- Authorized\n- Captured\n- Declined\n- Pending3DS\n- Failure3DS\n- Voided","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /orders/{orderId}","href":"/api_reference/onramp/order/get-an-order-by-id","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n h3: \"h3\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Fetch information about an Order once its completed\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.code, {\n children: \"status\"\n }), \" of an Order can be one of the following\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"Draft\"\n }), \" - This is an open or ongoing order\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"Processed\"\n }), \"* - The payment has been completed.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"Declined\"\n }), \"* - The transacation was declined, due to payment method issues\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"UserCustody\"\n }), \" - Crypto purchased for user but is in Sardine’s custodied wallet\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"Complete\"\n }), \" - The payment is complete and the crypto has been delivered to the user’s wallet. A \", _jsx(_components.code, {\n children: \"txHash\"\n }), \" will be present to denote successful on chain settlement.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"Expired\"\n }), \" - Order expired before execution\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Events marked with an * can also be captured via event handlers on the frontend\"\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Fetching Orders\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Full list of Orders is obtained by making a call to the endpoint with no filters.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"You have multiple options of filtering orders\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsxs(_components.strong, {\n children: [\"1. Filtering by \", _jsx(_components.code, {\n children: \"order_id\"\n })]\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If a \", _jsx(_components.code, {\n children: \"redirect_url\"\n }), \" was passed to the Sardine checkout (e.g. \", _jsx(_components.a, {\n href: \"https://crytpoapp.com\",\n children: \"https://crytpoapp.com\"\n }), \"”), when then transaction is completed, Sardine will redirect the user to this url with an \", _jsx(_components.code, {\n children: \"order_id\"\n }), \" appended i.e. \", _jsx(_components.a, {\n href: \"https://cryptoapp.com?order_id=73103-erhed-317313\",\n children: \"https://cryptoapp.com?order_id=73103-erhed-317313\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This \", _jsx(_components.code, {\n children: \"order_id\"\n }), \" can then be used as a filter on this endpoint\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"E.g. \", _jsx(_components.code, {\n children: \"/v1/orders/491c113c-4485-47cd-b011-252068b753dc\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsxs(_components.strong, {\n children: [\"2. Filtering by \", _jsx(_components.code, {\n children: \"referenceId\"\n })]\n }), \"\\nIf a \", _jsx(_components.code, {\n children: \"referenceId\"\n }), \" was passed in the call to create the \", _jsx(_components.code, {\n children: \"clientToken\"\n }), \" for this call, it can now be used to filter for Orders that were created then.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"E.g. \", _jsx(_components.code, {\n children: \"/v1/orders?referenceId=42ead95db5aeb6c\"\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsxs(_components.strong, {\n children: [\"3. Filtering by \", _jsx(_components.code, {\n children: \"externalUserId\"\n })]\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If a \", _jsx(_components.code, {\n children: \"externalUserId\"\n }), \" was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsxs(_components.strong, {\n children: [\"3. Filtering by \", _jsx(_components.code, {\n children: \"startDate\"\n }), \" and \", _jsx(_components.code, {\n children: \"endDate\"\n })]\n }), \"\\nIf \", _jsx(_components.code, {\n children: \"startDate\"\n }), \" or \", _jsx(_components.code, {\n children: \"endDate\"\n }), \" are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"E.g. \", _jsx(_components.code, {\n children: \"/v1/orders?startDate=2022-08-01\u0026endDate=2022-08-15\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"paymentStatus\"\n }), \" field within the \", _jsx(_components.code, {\n children: \"payment\"\n }), \" object in the response can be\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Draft\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Pending\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"For bank transfers, the value could be\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Sent\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Complete\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Returned\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Failed\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"For card transactions, the value can be\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Authorized\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Captured\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Declined\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Pending3DS\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Failure3DS\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Voided\"\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get an Order by ID","description":"Fetch information about an Order once its completed\n\nThe `status` of an Order can be one of the following\n\n`Draft` - This is an open or ongoing order\n\n`Processed`* - The payment has been completed.\n\n`Declined`* - The transacation was declined, due to payment method issues\n\n`UserCustody` - Crypto purchased for user but is in Sardine's custodied wallet\n\n`Complete` - The payment is complete and the crypto has been delivered to the user's wallet. A `txHash` will be present to denote successful on chain settlement. \n\n`Expired` - Order expired before execution\n\nEvents marked with an * can also be captured via event handlers on the frontend\n\n\n### Fetching Orders\n\nFull list of Orders is obtained by making a call to the endpoint with no filters. \n\n\nYou have multiple options of filtering orders\n\n**1. Filtering by `order_id`**\n\nIf a `redirect_url` was passed to the Sardine checkout (e.g. https://crytpoapp.com\"), when then transaction is completed, Sardine will redirect the user to this url with an `order_id` appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313\n\nThis `order_id` can then be used as a filter on this endpoint\n\nE.g. `/v1/orders/491c113c-4485-47cd-b011-252068b753dc`\n\n**2. Filtering by `referenceId`**\nIf a `referenceId` was passed in the call to create the `clientToken` for this call, it can now be used to filter for Orders that were created then. \n\nE.g. `/v1/orders?referenceId=42ead95db5aeb6c`\n\n**3. Filtering by `externalUserId`**\n\nIf a `externalUserId` was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user\n\n\n\n\n**3. Filtering by `startDate` and `endDate`**\nIf `startDate` or `endDate` are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range\n\nE.g. `/v1/orders?startDate=2022-08-01\u0026endDate=2022-08-15`\n\n\n\n`paymentStatus` field within the `payment` object in the response can be\n\n- Draft\n- Pending\n\nFor bank transfers, the value could be\n\n- Sent\n- Complete\n- Returned\n- Failed\n\nFor card transactions, the value can be\n\n- Authorized\n- Captured\n- Declined\n- Pending3DS\n- Failure3DS\n- Voided","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /orders/{orderId}","href":"/api_reference/onramp/order/get-an-order-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Order"],"summary":"Get an Order by ID","description":"Fetch information about an Order once its completed\n\nThe `status` of an Order can be one of the following\n\n`Draft` - This is an open or ongoing order\n\n`Processed`* - The payment has been completed.\n\n`Declined`* - The transacation was declined, due to payment method issues\n\n`UserCustody` - Crypto purchased for user but is in Sardine's custodied wallet\n\n`Complete` - The payment is complete and the crypto has been delivered to the user's wallet. A `txHash` will be present to denote successful on chain settlement. \n\n`Expired` - Order expired before execution\n\nEvents marked with an * can also be captured via event handlers on the frontend\n\n\n### Fetching Orders\n\nFull list of Orders is obtained by making a call to the endpoint with no filters. \n\n\nYou have multiple options of filtering orders\n\n**1. Filtering by `order_id`**\n\nIf a `redirect_url` was passed to the Sardine checkout (e.g. https://crytpoapp.com\"), when then transaction is completed, Sardine will redirect the user to this url with an `order_id` appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313\n\nThis `order_id` can then be used as a filter on this endpoint\n\nE.g. `/v1/orders/491c113c-4485-47cd-b011-252068b753dc`\n\n**2. Filtering by `referenceId`**\nIf a `referenceId` was passed in the call to create the `clientToken` for this call, it can now be used to filter for Orders that were created then. \n\nE.g. `/v1/orders?referenceId=42ead95db5aeb6c`\n\n**3. Filtering by `externalUserId`**\n\nIf a `externalUserId` was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user\n\n\n\n\n**3. Filtering by `startDate` and `endDate`**\nIf `startDate` or `endDate` are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range\n\nE.g. `/v1/orders?startDate=2022-08-01\u0026endDate=2022-08-15`\n\n\n\n`paymentStatus` field within the `payment` object in the response can be\n\n- Draft\n- Pending\n\nFor bank transfers, the value could be\n\n- Sent\n- Complete\n- Returned\n- Failed\n\nFor card transactions, the value can be\n\n- Authorized\n- Captured\n- Declined\n- Pending3DS\n- Failure3DS\n- Voided","operationId":"get-order-order_id","parameters":["81428d44-16a8-4339-b13c-2e0dccb7d78c","158d1565-f6a6-44fc-a841-9c9aed5240ca","53b1d046-e4f3-43c5-a5f5-a2f56b9c3992","d2d286f0-6f83-4756-a236-0b3941134b5b","3eb5f9df-841b-4b10-8a42-d6479f53ccd0","1e5d2898-8926-475b-adaa-8ba21258f202"],"responses":{"200":"082739f9-d999-4c93-82c9-7fc9732d3a1f"},"security":["39ac77ed-4328-4cb1-852d-9cd68790311a"],"servers":["fc8e01cc-8899-4464-8f9a-9c8f78a87fbe","bd55c4d8-0440-4af9-bf3f-681662a1f5e0"],"x-stoplight":{"id":"eg8e6vpyxx951"},"method":"get","type":"path","path":"/orders/{orderId}","baseUrlOptions":["https://api.sandbox.sardine.ai/v1","https://api.sardine.ai/v1"],"title":"Get an Order by ID","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"81428d44-16a8-4339-b13c-2e0dccb7d78c":{"name":"referenceId","in":"query","description":"If a `referenceId` is passed when creating the `clientToken`, it can be used as a filter","schema":{"type":"string","format":"uuid","description":"If a `referenceId` is passed when creating the `clientToken`, it can be used as a filter","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"158d1565-f6a6-44fc-a841-9c9aed5240ca":{"name":"limit","in":"query","description":"Number of results returned","schema":{"type":"string","description":"Number of results returned","uniqueKey":"","typeLabel":"string"}},"53b1d046-e4f3-43c5-a5f5-a2f56b9c3992":{"name":"startDate","in":"query","description":"Date in YYYY-MM-DD","schema":{"type":"string","description":"Date in YYYY-MM-DD","uniqueKey":"","typeLabel":"string"}},"d2d286f0-6f83-4756-a236-0b3941134b5b":{"name":"endDate","in":"query","description":"Date in YYYY-MM-DD","schema":{"type":"string","description":"Date in YYYY-MM-DD","uniqueKey":"","typeLabel":"string"}},"3eb5f9df-841b-4b10-8a42-d6479f53ccd0":{"name":"externalUserId","in":"query","description":"Filter using `externalUserId` to obtain all Orders associated with a particular user","schema":{"type":"string","format":"uuid","description":"Filter using `externalUserId` to obtain all Orders associated with a particular user","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"1e5d2898-8926-475b-adaa-8ba21258f202":{"name":"orderId","in":"path","description":"ID of Order","required":true,"schema":{"type":"string","isRequired":true,"description":"ID of Order","uniqueKey":"","typeLabel":"string"}}},"responses":{"082739f9-d999-4c93-82c9-7fc9732d3a1f":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"createdAt","typeLabel":"string"},"confirmedAt":{"type":"string","uniqueKey":"confirmedAt","typeLabel":"string"},"referenceId":{"type":"string","uniqueKey":"referenceId","typeLabel":"string"},"status":{"type":"string","uniqueKey":"status","typeLabel":"string"},"fiatCurrency":{"type":"string","uniqueKey":"fiatCurrency","typeLabel":"string"},"transactionId":{"type":"string","uniqueKey":"transactionId","typeLabel":"string"},"walletAddress":{"type":"string","uniqueKey":"walletAddress","typeLabel":"string"},"expiresAt":{"type":"string","uniqueKey":"expiresAt","typeLabel":"string"},"userId":{"type":"string","uniqueKey":"userId","typeLabel":"string"},"total":{"type":"integer","uniqueKey":"total","typeLabel":"integer"},"subtotal":{"type":"integer","uniqueKey":"subtotal","typeLabel":"integer"},"processingFees":{"type":"object","properties":{"transactionFee":{"type":"integer","uniqueKey":"processingFees.transactionFee","typeLabel":"integer"},"networkFee":{"type":"number","uniqueKey":"processingFees.networkFee","typeLabel":"number"}},"uniqueKey":"processingFees","typeLabel":"object"},"payment":{"type":"object","properties":{"amountCents":{"type":"integer","uniqueKey":"payment.amountCents","typeLabel":"integer"},"currency":{"type":"string","uniqueKey":"payment.currency","typeLabel":"string"},"paymentMethodId":{"type":"string","uniqueKey":"payment.paymentMethodId","typeLabel":"string"},"paymentMethodType":{"type":"string","uniqueKey":"payment.paymentMethodType","typeLabel":"string"}},"uniqueKey":"payment","typeLabel":"object"},"withdrawal":{"type":"object","properties":{"txHash":{"type":"string","uniqueKey":"withdrawal.txHash","typeLabel":"string"},"walletAddress":{"type":"string","uniqueKey":"withdrawal.walletAddress","typeLabel":"string"},"quantity":{"type":"number","uniqueKey":"withdrawal.quantity","typeLabel":"number"}},"uniqueKey":"withdrawal","typeLabel":"object"},"withdrawals":{"type":"array","description":"Sample","items":{"type":"object","properties":{"walletAddress":{"type":"string","uniqueKey":"withdrawals.items.[INDEX].walletAddress","typeLabel":"string"},"holdAmount":{"type":"integer","uniqueKey":"withdrawals.items.[INDEX].holdAmount","typeLabel":"integer"},"holdUntil":{"type":"string","uniqueKey":"withdrawals.items.[INDEX].holdUntil","typeLabel":"string"},"quantity":{"type":"number","uniqueKey":"withdrawals.items.[INDEX].quantity","typeLabel":"number"},"isHold":{"type":"boolean","uniqueKey":"withdrawals.items.[INDEX].isHold","typeLabel":"boolean"},"status":{"type":"string","uniqueKey":"withdrawals.items.[INDEX].status","typeLabel":"string"},"txHash":{"type":"string","uniqueKey":"withdrawals.items.[INDEX].txHash","typeLabel":"string"},"withdrawnAt":{"type":"string","uniqueKey":"withdrawals.items.[INDEX].withdrawnAt","typeLabel":"string"}},"uniqueKey":"withdrawals.items.[INDEX]","typeLabel":"object"},"uniqueKey":"withdrawals","typeLabel":"object[]"}},"x-examples":{"Example 1":{"id":"0113e40a-7406-4036-a882-745a3275e614","createdAt":"2023-03-10T20:46:29Z","confirmedAt":"2023-03-10T20:46:33Z","referenceId":"test-0.7142516498128628","status":"Complete","fiatCurrency":"USD","transactionId":"7b47afca-4a6d-4cd3-a756-03db3281b932","walletAddress":"0x3d0babc12ac0b08f933a837dbb7a9943be35b0fc","expiresAt":"2023-03-10T20:51:29Z","userId":"afceb64d-2d0b-4e52-8b99-a6a4eafc8515","total":10,"subtotal":0,"processingFees":{"transactionFee":0,"networkFee":1.05},"payment":{"amountCents":1000,"currency":"USD","paymentMethodId":"cfb30490-62da-4bcb-8179-5e18953d0117","paymentMethodType":"Bank"},"withdrawal":{"txHash":"0xbb45ae53e0ca10e598cf9d0ffedf554e8a72ca4a611a3f883474e0d6864eda5a","walletAddress":"0x3d0babc12ac0b08f933a837dbb7a9943be35b0fc"},"withdrawals":[{"walletAddress":"0x3d0babc12ac0b08f933a837dbb7a9943be35b0fc","holdAmount":5,"holdUntil":"2023-03-14T20:46:14.675+00:00","quantity":0.003091455,"isHold":true,"status":"HOLD"},{"txHash":"0xbb45ae53e0ca10e598cf9d0ffedf554e8a72ca4a611a3f883474e0d6864eda5a","walletAddress":"0x3d0babc12ac0b08f933a837dbb7a9943be35b0fc","quantity":0.003091455,"isHold":false,"status":"SETTLED","withdrawnAt":"2023-03-10T20:46:58Z"}]}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","createdAt":"\u003cstring>","confirmedAt":"\u003cstring>","referenceId":"\u003cstring>","status":"\u003cstring>","fiatCurrency":"\u003cstring>","transactionId":"\u003cstring>","walletAddress":"\u003cstring>","expiresAt":"\u003cstring>","userId":"\u003cstring>","total":123,"subtotal":123,"processingFees":{"transactionFee":123,"networkFee":123},"payment":{"amountCents":123,"currency":"\u003cstring>","paymentMethodId":"\u003cstring>","paymentMethodType":"\u003cstring>"},"withdrawal":{"txHash":"\u003cstring>","walletAddress":"\u003cstring>","quantity":123},"withdrawals":[{"walletAddress":"\u003cstring>","holdAmount":123,"holdUntil":"\u003cstring>","quantity":123,"isHold":true,"status":"\u003cstring>","txHash":"\u003cstring>","withdrawnAt":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"39ac77ed-4328-4cb1-852d-9cd68790311a":{"ClientToken":{"type":"http","scheme":"basic","scopes":[]}}},"servers":{"fc8e01cc-8899-4464-8f9a-9c8f78a87fbe":{"url":"https://api.sandbox.sardine.ai/v1","description":"Sandbox"},"bd55c4d8-0440-4af9-bf3f-681662a1f5e0":{"url":"https://api.sardine.ai/v1","description":"Prod Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"ClientToken","name":"Authorization"}],"title":"ClientToken"}]},"originalFileLocation":"api_reference/onramp.yaml"},"subdomain":"sardine-payments","siteName":"Sardine Payments","title":"Get an Order by ID - Sardine Payments","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api_reference/onramp/order/get-an-order-by-id.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Fetch information about an Order once its completed The status of an Order can be one of the following Draft - This is an open or ongoing order Processed - The payment has been completed. Declined - The transacation was declined, due to payment method issues UserCustody - Crypto purchased for user but is in Sardine\u0026#x27;s custodied wallet Complete - The payment is complete and the crypto has been delivered to the user\u0026#x27;s wallet. A txHash will be present to denote successful on chain settlement. Expired - Order expired before execution Events marked with an * can also be captured via event handlers on the frontend ### Fetching Orders Full list of Orders is obtained by making a call to the endpoint with no filters. You have multiple options of filtering orders 1. Filtering by order_id If a redirect_url was passed to the Sardine checkout (e.g. https://crytpoapp.com\u0026quot;), when then transaction is completed, Sardine will redirect the user to this url with an order_id appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313 This order_id can then be used as a filter on this endpoint E.g. /v1/orders/491c113c-4485-47cd-b011-252068b753dc 2. Filtering by referenceId If a referenceId was passed in the call to create the clientToken for this call, it can now be used to filter for Orders that were created then. E.g. /v1/orders?referenceId=42ead95db5aeb6c 3. Filtering by externalUserId If a externalUserId was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user 3. Filtering by startDate and endDate If startDate or endDate are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range E.g. /v1/orders?startDate=2022-08-01\u0026amp;endDate=2022-08-15 paymentStatus field within the payment object in the response can be - Draft - Pending For bank transfers, the value could be - Sent - Complete - Returned - Failed For card transactions, the value can be - Authorized - Captured - Declined - Pending3DS - Failure3DS - Voided\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sardine Payments\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an Order by ID - Sardine Payments\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch information about an Order once its completed The status of an Order can be one of the following Draft - This is an open or ongoing order Processed - The payment has been completed. Declined - The transacation was declined, due to payment method issues UserCustody - Crypto purchased for user but is in Sardine\u0026#x27;s custodied wallet Complete - The payment is complete and the crypto has been delivered to the user\u0026#x27;s wallet. A txHash will be present to denote successful on chain settlement. Expired - Order expired before execution Events marked with an * can also be captured via event handlers on the frontend ### Fetching Orders Full list of Orders is obtained by making a call to the endpoint with no filters. You have multiple options of filtering orders 1. Filtering by order_id If a redirect_url was passed to the Sardine checkout (e.g. https://crytpoapp.com\u0026quot;), when then transaction is completed, Sardine will redirect the user to this url with an order_id appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313 This order_id can then be used as a filter on this endpoint E.g. /v1/orders/491c113c-4485-47cd-b011-252068b753dc 2. Filtering by referenceId If a referenceId was passed in the call to create the clientToken for this call, it can now be used to filter for Orders that were created then. E.g. /v1/orders?referenceId=42ead95db5aeb6c 3. Filtering by externalUserId If a externalUserId was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user 3. Filtering by startDate and endDate If startDate or endDate are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range E.g. /v1/orders?startDate=2022-08-01\u0026amp;endDate=2022-08-15 paymentStatus field within the payment object in the response can be - Draft - Pending For bank transfers, the value could be - Sent - Complete - Returned - Failed For card transactions, the value can be - Authorized - Captured - Declined - Pending3DS - Failure3DS - Voided\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sardine Payments\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sardine-payments.mintlify.app/_mintlify/api/og/v2?division=Order\u0026amp;title=Get+an+Order+by+ID\u0026amp;description=Fetch+information+about+an+Order+once+its+completed%0A%0AThe+%60status%60+of+an+Order+can+be+one+of+the+following%0A%0A%60Draft%60+-+This+is+an+open+or+ongoing+order%0A%0A%60Processe\u0026amp;theme=afc8939af6e2d78a57ff9fb2\u0026amp;signature=21aad664677ffe9eb2ed49d8cc6c09269f56c7d1083646a460cfe21d06e54041\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get an Order by ID - Sardine Payments\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch information about an Order once its completed The status of an Order can be one of the following Draft - This is an open or ongoing order Processed - The payment has been completed. Declined - The transacation was declined, due to payment method issues UserCustody - Crypto purchased for user but is in Sardine\u0026#x27;s custodied wallet Complete - The payment is complete and the crypto has been delivered to the user\u0026#x27;s wallet. A txHash will be present to denote successful on chain settlement. Expired - Order expired before execution Events marked with an * can also be captured via event handlers on the frontend ### Fetching Orders Full list of Orders is obtained by making a call to the endpoint with no filters. You have multiple options of filtering orders 1. Filtering by order_id If a redirect_url was passed to the Sardine checkout (e.g. https://crytpoapp.com\u0026quot;), when then transaction is completed, Sardine will redirect the user to this url with an order_id appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313 This order_id can then be used as a filter on this endpoint E.g. /v1/orders/491c113c-4485-47cd-b011-252068b753dc 2. Filtering by referenceId If a referenceId was passed in the call to create the clientToken for this call, it can now be used to filter for Orders that were created then. E.g. /v1/orders?referenceId=42ead95db5aeb6c 3. Filtering by externalUserId If a externalUserId was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user 3. Filtering by startDate and endDate If startDate or endDate are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range E.g. /v1/orders?startDate=2022-08-01\u0026amp;endDate=2022-08-15 paymentStatus field within the payment object in the response can be - Draft - Pending For bank transfers, the value could be - Sent - Complete - Returned - Failed For card transactions, the value can be - Authorized - Captured - Declined - Pending3DS - Failure3DS - Voided\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sardine-payments.mintlify.app/_mintlify/api/og/v2?division=Order\u0026amp;title=Get+an+Order+by+ID\u0026amp;description=Fetch+information+about+an+Order+once+its+completed%0A%0AThe+%60status%60+of+an+Order+can+be+one+of+the+following%0A%0A%60Draft%60+-+This+is+an+open+or+ongoing+order%0A%0A%60Processe\u0026amp;theme=afc8939af6e2d78a57ff9fb2\u0026amp;signature=21aad664677ffe9eb2ed49d8cc6c09269f56c7d1083646a460cfe21d06e54041\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sardine-payments/cONXdfsFZR7DqgZ5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sardine Payments\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2D29D7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api_reference/onramp/order/get-an-order-by-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.payments.sardine.ai/#organization\",\"name\":\"Sardine Payments\",\"url\":\"https://docs.payments.sardine.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sardine-payments/xaOaWQltc1g9zE_Z/logo/light.svg?fit=max\u0026auto=format\u0026n=xaOaWQltc1g9zE_Z\u0026q=85\u0026s=0f19e6244a4ae82cd0f46baf0fe1fe76\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.payments.sardine.ai#website\",\"name\":\"Sardine Payments\",\"url\":\"https://docs.payments.sardine.ai\",\"publisher\":{\"@id\":\"https://docs.payments.sardine.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id#webpage\",\"url\":\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id\",\"name\":\"Get an Order by ID\",\"description\":\"Fetch information about an Order once its completed The status of an Order can be one of the following Draft - This is an open or ongoing order Processed - The payment has been completed. Declined - The transacation was declined, due to payment method issues UserCustody - Crypto purchased for user but is in Sardine's custodied wallet Complete - The payment is complete and the crypto has been delivered to the user's wallet. A txHash will be present to denote successful on chain settlement. Expired - Order expired before execution Events marked with an * can also be captured via event handlers on the frontend ### Fetching Orders Full list of Orders is obtained by making a call to the endpoint with no filters. You have multiple options of filtering orders 1. Filtering by order_id If a redirect_url was passed to the Sardine checkout (e.g. https://crytpoapp.com\\\"), when then transaction is completed, Sardine will redirect the user to this url with an order_id appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313 This order_id can then be used as a filter on this endpoint E.g. /v1/orders/491c113c-4485-47cd-b011-252068b753dc 2. Filtering by referenceId If a referenceId was passed in the call to create the clientToken for this call, it can now be used to filter for Orders that were created then. E.g. /v1/orders?referenceId=42ead95db5aeb6c 3. Filtering by externalUserId If a externalUserId was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user 3. Filtering by startDate and endDate If startDate or endDate are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range E.g. /v1/orders?startDate=2022-08-01\u0026endDate=2022-08-15 paymentStatus field within the payment object in the response can be - Draft - Pending For bank transfers, the value could be - Sent - Complete - Returned - Failed For card transactions, the value can be - Authorized - Captured - Declined - Pending3DS - Failure3DS - Voided\",\"isPartOf\":{\"@id\":\"https://docs.payments.sardine.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sardine Payments\",\"item\":\"https://docs.payments.sardine.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an Order by ID\",\"item\":\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id#apireference\",\"headline\":\"Get an Order by ID\",\"name\":\"Get an Order by ID\",\"description\":\"Fetch information about an Order once its completed The status of an Order can be one of the following Draft - This is an open or ongoing order Processed - The payment has been completed. Declined - The transacation was declined, due to payment method issues UserCustody - Crypto purchased for user but is in Sardine's custodied wallet Complete - The payment is complete and the crypto has been delivered to the user's wallet. A txHash will be present to denote successful on chain settlement. Expired - Order expired before execution Events marked with an * can also be captured via event handlers on the frontend ### Fetching Orders Full list of Orders is obtained by making a call to the endpoint with no filters. You have multiple options of filtering orders 1. Filtering by order_id If a redirect_url was passed to the Sardine checkout (e.g. https://crytpoapp.com\\\"), when then transaction is completed, Sardine will redirect the user to this url with an order_id appended i.e. https://cryptoapp.com?order_id=73103-erhed-317313 This order_id can then be used as a filter on this endpoint E.g. /v1/orders/491c113c-4485-47cd-b011-252068b753dc 2. Filtering by referenceId If a referenceId was passed in the call to create the clientToken for this call, it can now be used to filter for Orders that were created then. E.g. /v1/orders?referenceId=42ead95db5aeb6c 3. Filtering by externalUserId If a externalUserId was passed in /auth/client-tokens, it can be used to filter for Orders with that ID. This is useful for associating transactions with a user 3. Filtering by startDate and endDate If startDate or endDate are passed in YYYY-MM-DD format, the list of Orders will be filtered to those that were created in this range E.g. /v1/orders?startDate=2022-08-01\u0026endDate=2022-08-15 paymentStatus field within the payment object in the response can be - Draft - Pending For bank transfers, the value could be - Sent - Complete - Returned - Failed For card transactions, the value can be - Authorized - Captured - Declined - Pending3DS - Failure3DS - Voided\",\"url\":\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.payments.sardine.ai/api_reference/onramp/order/get-an-order-by-id#webpage\"},\"publisher\":{\"@id\":\"https://docs.payments.sardine.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.payments.sardine.ai#website\"}}]}\u003c/script>","siteName":"Sardine Payments","nav":{"global":{"anchors":[{"anchor":"Security Portal","href":"https://security.sardine.ai","icon":{"name":"shield-halved","style":"light"}},{"anchor":"Contact Us","href":"https://www.sardine.ai/contact","icon":{"name":"envelope","style":"light"}}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/overview/intro"}]},{"tab":"Integration Guides","pages":[{"title":"Integration Guides","href":"/integration_guides/onboarding_and_testing/client_onboarding"}]},{"tab":"API Reference (Onramp/Offramp)","groups":[{"group":"User Onboarding","pages":[{"title":"Get Client Token","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /auth/client-tokens","href":"/api_reference/onramp/user-onboarding/get-client-token"},{"title":"Get Customers","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /customers","href":"/api_reference/onramp/user-onboarding/get-customers"},{"title":"Post Customer Information","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /customers","href":"/api_reference/onramp/user-onboarding/post-customer-information"},{"title":"Get KYC Widget URL","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /kyc/widgetUrl","href":"/api_reference/onramp/user-onboarding/get-kyc-widget-url"}]},{"group":"Quote","pages":[{"title":"Get Quote","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /quotes","href":"/api_reference/onramp/quote/get-quote"}]},{"group":"Coverage","pages":[{"title":"Get Supported Tokens","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /supported-tokens","href":"/api_reference/onramp/coverage/get-supported-tokens"},{"title":"Get Enabled Tokens","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /enabled-tokens","href":"/api_reference/onramp/coverage/get-enabled-tokens"},{"title":"Get Geocoverage","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /geo-coverage","href":"/api_reference/onramp/coverage/get-geocoverage"},{"title":"Get Fiat Currencies","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /fiat-currencies","href":"/api_reference/onramp/coverage/get-fiat-currencies"}]},{"group":"Payment Method","pages":[{"title":"Get Payment Method information","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /payment-methods","href":"/api_reference/onramp/payment-method/get-payment-method-information"},{"title":"Get Add Fiat Account Widget URL","description":"This endpoint returns a URL where users can be redirected to connect external fiat payment methods, including credit/debit cards, bank accounts, and SEPA.","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /payment-methods/widgetUrl","href":"/api_reference/onramp/payment-method/get-add-fiat-account-widget-url"}]},{"group":"Order","pages":[{"title":"Get an Order by ID","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /orders/{orderId}","href":"/api_reference/onramp/order/get-an-order-by-id"},{"title":"Get User Orders","description":"This endpoint retrieves the list of orders placed by the user, with optional filtering based on specific query parameters like userId.","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml get /orders","href":"/api_reference/onramp/order/get-user-orders"}]},{"group":"Support","pages":[{"title":"Create Support Ticket","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /supportTickets","href":"/api_reference/onramp/support/create-support-ticket"}]},{"group":"Order Execution","pages":[{"title":"Create Onramp Order","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /onramp","href":"/api_reference/onramp/order-execution/create-onramp-order"},{"title":"Create Offramp Order","deprecated":null,"version":null,"openapi":"/api_reference/onramp.yaml post /offramp","href":"/api_reference/onramp/order-execution/create-offramp-order"}]}]},{"tab":"API Reference (NFT)","pages":[{"title":"API Reference (NFT)","href":"/api_reference/nft/post-client-token"}]},{"tab":"API Reference (Identity)","pages":[{"title":"API Reference (Identity)","href":"/api_reference/identity/customer-management/create-customer"}]}]},"basePath":"","title":"Get an Order by ID - Sardine Payments","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}