The response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — refundable, refundDestinationRequired, latestRefund, refundAddress and refundedTxnHash — without paginating the whole list. That matters because a refund’s progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See Refunds.
Orders of a deactivated customer are not returned.
Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.
Path Parameters
orderId
string<uuid>
required
Unique identifier for the order.
Response
The off-ramp order.
Details of an off-ramp transaction.
transactionId
string<uuid>
required
Unique identifier for the off-ramp transaction.
createdAt
string<date-time>
required
Date and time the off-ramp transaction was created.
customerId
string<uuid>
required
Customer's unique identifier.
quoteId
string<uuid>
required
Reference to the original quote used for this transaction.
fromCurrency
string
required
The source cryptocurrency being off-ramped.
Example:
"USDC"
toCurrency
string
required
The target fiat currency received.
Example:
"ARS"
amount
string
required
The amount of the target currency transferred or to be transferred, after fees. It can be zero or negative when the fees exceed the amount sold: the order is then cancelled before the trade with failureReason: AMOUNT_LIMIT_EXCEEDED (status CANCELLED, or REFUNDED once the crypto is returned), nothing is paid out, and the crypto stays refundable.
chain
string
required
The cryptocurrency blockchain for the deposit address.
Example:
"ETHEREUM"
metadata
object
Additional metadata associated with the transaction.
Example:
{}
txnHash
string | null
The transaction hash of the customer's incoming crypto deposit. null until the deposit is detected on-chain.
Example:
null
providerId
string
The fiat withdrawal provider's transaction identifier. Available for completed Argentine off-ramp orders.
finishedAt
string
Date and time the fiat withdrawal was completed by the provider. Available for completed Argentine off-ramp orders.
fiatAccountId
string<uuid>
Identifier of the fiat account the payout is sent to.
refundAddress
string | null
The effective on-chain refund address for this order, if any.
refundable
boolean
Whether a crypto refund can be requested for this order right now. Computed per request, so use it to decide whether to call the refund endpoint instead of discovering it through a 400.
Example:
false
refundDestinationRequired
boolean | null
Whether requesting a refund for this order requires naming a refundAddress. false means the crypto is returned to the deposit's on-chain origin address and an address is rejected. null when the order is not in refund territory.
Example:
false
latestRefund
object | null
State of the most recent refund of this order's crypto deposit, or null if there never was one. On this ramp only a completed refund emits an event (OFF-RAMP.ORDER.REFUNDED), so this block is how progress is followed and the only way a rejection is ever read.
Show child attributes
refundedTxnHash
string | null
On-chain hash of the crypto refund, once refunded. null otherwise.
Example:
null
travelRule
object | null
Mexico: the current Travel Rule declaration. Returned by the create endpoints and by the per-ramp retrieve endpoints; not by Retrieve an Order (GET /api/v1/transactions/{orderId}/), list endpoints or the transactions of a session.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ripio B2B API","description":"Ripio B2B APIs for crypto infrastructure and local stablecoins (wFiat) in Latin America: Crypto as a Service and the on/off-ramp Ramps API.","colors":{"primary":"#7908FF","light":"#7908FF","dark":"#7908FF"},"logo":{"light":"https://mintcdn.com/ripio-9dfd4837/wCKCU-escYLNlxWQ/logo/logo_black.svg?fit=max\u0026auto=format\u0026n=wCKCU-escYLNlxWQ\u0026q=85\u0026s=bdf337e5acb2526c20ade218091c4203","dark":"https://mintcdn.com/ripio-9dfd4837/wCKCU-escYLNlxWQ/logo/logo_white.svg?fit=max\u0026auto=format\u0026n=wCKCU-escYLNlxWQ\u0026q=85\u0026s=a68156b523e110deae3eaeb2feac1493"},"favicon":"https://mintcdn.com/ripio-9dfd4837/Z0ROxzVvVQCC2WDt/favicon.png?fit=max\u0026auto=format\u0026n=Z0ROxzVvVQCC2WDt\u0026q=85\u0026s=3763d7144291f35d0088536ef1aae78a","appearance":{"default":"dark"},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Register","href":"https://platform.ripio.com/register"}},"footer":{"socials":{"x":"https://x.com/ripiohq","instagram":"https://www.instagram.com/ripioapp","youtube":"https://www.youtube.com/Ripiotv","telegram":"https://t.me/+J7H4QmPlNIc2NDAx","linkedin":"https://ar.linkedin.com/company/ripio"}},"seo":{"organization":{"name":"Ripio","url":"https://www.ripio.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ripio-9dfd4837","hasAudioNarration":false,"actualSubdomain":"ripio-9dfd4837","customDomains":["docs.ripio.com"],"gitSource":{"type":"github","owner":"ripio","repo":"b2b-docs-mintlify","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aff50467fb6886116681108","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Integration","count":167},{"language":"default","tag":"API Reference","count":151},{"language":"default","tag":"Ramps","count":111},{"language":"default","tag":"Crypto as a Service","count":95},{"language":"default","tag":"Overview","count":28},{"language":"default","tag":"Widget integration","count":16},{"language":"default","tag":"Crypto Widget","count":14},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"User flows","count":12},{"language":"default","tag":"Onchain Deposits \u0026 Withdrawals","count":11}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"site-roles","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":"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":"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},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"ramps-api/off-ramp/retrieve-an-off-ramp-order","slug":"/ramps-api/off-ramp/retrieve-an-off-ramp-order","pageMetadata":{"openapi":"ramps-api/openapi.json GET /api/v1/offramp/{orderId}/","title":"Retrieve an Off-Ramp Order","description":"Returns a single off-ramp order by its `orderId`.\n\nThe response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — `refundable`, `refundDestinationRequired`, `latestRefund`, `refundAddress` and `refundedTxnHash` — without paginating the whole list. That matters because a refund's progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See [Refunds](/ramps-api/refunds/overview).\n\nOrders of a deactivated customer are not returned.","href":"/ramps-api/off-ramp/retrieve-an-off-ramp-order"},"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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Returns a single off-ramp order by its \", _jsx(_components.code, {\n children: \"orderId\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — \", _jsx(_components.code, {\n children: \"refundable\"\n }), \", \", _jsx(_components.code, {\n children: \"refundDestinationRequired\"\n }), \", \", _jsx(_components.code, {\n children: \"latestRefund\"\n }), \", \", _jsx(_components.code, {\n children: \"refundAddress\"\n }), \" and \", _jsx(_components.code, {\n children: \"refundedTxnHash\"\n }), \" — without paginating the whole list. That matters because a refund’s progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See \", _jsx(_components.a, {\n href: \"/ramps-api/refunds/overview\",\n children: \"Refunds\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Orders of a deactivated customer are not returned.\"\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":{"openapi":"ramps-api/openapi.json GET /api/v1/offramp/{orderId}/","title":"Retrieve an Off-Ramp Order","description":"Returns a single off-ramp order by its `orderId`.\n\nThe response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — `refundable`, `refundDestinationRequired`, `latestRefund`, `refundAddress` and `refundedTxnHash` — without paginating the whole list. That matters because a refund's progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See [Refunds](/ramps-api/refunds/overview).\n\nOrders of a deactivated customer are not returned.","href":"/ramps-api/off-ramp/retrieve-an-off-ramp-order"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ripio-9dfd4837/e90081465672ce62/seo-jsonld.js"],"openApiReferenceData":{"operation":{"summary":"Retrieve an Off-Ramp Order","description":"Returns a single off-ramp order by its `orderId`.\n\nThe response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — `refundable`, `refundDestinationRequired`, `latestRefund`, `refundAddress` and `refundedTxnHash` — without paginating the whole list. That matters because a refund's progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See [Refunds](/ramps-api/refunds/overview).\n\nOrders of a deactivated customer are not returned.","operationId":"retrieveOffRampOrder","tags":["Off-Ramp"],"parameters":["a5724356-7177-4a95-b6d5-771ebdbecb19"],"responses":{"200":"d0ac15dd-c412-4c91-b232-10de850c7a9d","401":"b69ffeab-d73e-4e99-9063-fe1028e73582","404":"54d088b6-f025-445e-ac87-43f7a03702b2"},"method":"get","type":"path","servers":["6447d3c6-dd4a-4999-adb1-97ae285a6408","8ee58e10-8bb3-4dca-9fb7-4363a852ef91"],"security":["686a544d-e6b8-4128-865f-d9f41f789091"],"path":"/api/v1/offramp/{orderId}/","baseUrlOptions":["https://skala-sandbox.ripio.com","https://skala.ripio.com"],"title":"Retrieve an Off-Ramp Order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a5724356-7177-4a95-b6d5-771ebdbecb19":{"name":"orderId","in":"path","required":true,"description":"Unique identifier for the order.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Unique identifier for the order.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"}},"responses":{"d0ac15dd-c412-4c91-b232-10de850c7a9d":{"description":"The off-ramp order.","content":{"application/json":{"schema":{"type":"object","description":"Details of an off-ramp transaction.","required":["transactionId","createdAt","customerId","quoteId","fromCurrency","toCurrency","amount","chain"],"properties":{"transactionId":{"type":"string","format":"uuid","description":"Unique identifier for the off-ramp transaction.","isRequired":true,"uniqueKey":"transactionId","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Date and time the off-ramp transaction was created.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"customerId":{"type":"string","format":"uuid","description":"Customer's unique identifier.","isRequired":true,"uniqueKey":"customerId","typeLabel":"string\u003cuuid>"},"quoteId":{"type":"string","format":"uuid","description":"Reference to the original quote used for this transaction.","isRequired":true,"uniqueKey":"quoteId","typeLabel":"string\u003cuuid>"},"fromCurrency":{"type":"string","description":"The source cryptocurrency being off-ramped.","example":"USDC","isRequired":true,"uniqueKey":"fromCurrency","typeLabel":"string"},"toCurrency":{"type":"string","description":"The target fiat currency received.","example":"ARS","isRequired":true,"uniqueKey":"toCurrency","typeLabel":"string"},"amount":{"type":"string","description":"The amount of the target currency transferred or to be transferred, after fees. It can be zero or negative when the fees exceed the amount sold: the order is then cancelled before the trade with `failureReason: AMOUNT_LIMIT_EXCEEDED` (status `CANCELLED`, or `REFUNDED` once the crypto is returned), nothing is paid out, and the crypto stays refundable.","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"chain":{"type":"string","description":"The cryptocurrency blockchain for the deposit address.","example":"ETHEREUM","isRequired":true,"uniqueKey":"chain","typeLabel":"string"},"metadata":{"type":"object","description":"Additional metadata associated with the transaction.","additionalProperties":true,"example":{},"uniqueKey":"metadata","typeLabel":"object"},"txnHash":{"oneOf":[{"type":"string","description":"The transaction hash of the customer's incoming crypto deposit. `null` until the deposit is detected on-chain.","example":null,"uniqueKey":"txnHash.oneOf.0","typeLabel":"string"},{"type":"null","description":"The transaction hash of the customer's incoming crypto deposit. `null` until the deposit is detected on-chain.","example":null,"uniqueKey":"txnHash.oneOf.1","typeLabel":"null"}],"uniqueKey":"txnHash","typeLabel":"string | null"},"providerId":{"type":"string","description":"The fiat withdrawal provider's transaction identifier. Available for completed Argentine off-ramp orders.","uniqueKey":"providerId","typeLabel":"string"},"finishedAt":{"type":"string","description":"Date and time the fiat withdrawal was completed by the provider. Available for completed Argentine off-ramp orders.","uniqueKey":"finishedAt","typeLabel":"string"},"fiatAccountId":{"type":"string","format":"uuid","description":"Identifier of the fiat account the payout is sent to.","uniqueKey":"fiatAccountId","typeLabel":"string\u003cuuid>"},"refundAddress":{"oneOf":[{"type":"string","description":"The effective on-chain refund address for this order, if any.","uniqueKey":"refundAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"The effective on-chain refund address for this order, if any.","uniqueKey":"refundAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundAddress","typeLabel":"string | null"},"refundable":{"type":"boolean","description":"Whether a [crypto refund](/ramps-api/refunds/request-crypto-refund) can be requested for this order right now. Computed per request, so use it to decide whether to call the refund endpoint instead of discovering it through a 400.","example":false,"uniqueKey":"refundable","typeLabel":"boolean"},"refundDestinationRequired":{"oneOf":[{"type":"boolean","description":"Whether requesting a refund for this order requires naming a `refundAddress`. `false` means the crypto is returned to the deposit's on-chain origin address and an address is rejected. `null` when the order is not in refund territory.","example":false,"uniqueKey":"refundDestinationRequired.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether requesting a refund for this order requires naming a `refundAddress`. `false` means the crypto is returned to the deposit's on-chain origin address and an address is rejected. `null` when the order is not in refund territory.","example":false,"uniqueKey":"refundDestinationRequired.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundDestinationRequired","typeLabel":"boolean | null"},"latestRefund":{"oneOf":[{"type":"object","description":"State of the most recent refund of this order's crypto deposit, or `null` if there never was one. On this ramp only a **completed** refund emits an event (`OFF-RAMP.ORDER.REFUNDED`), so this block is how progress is followed and the only way a rejection is ever read.","properties":{"refundId":{"type":"string","format":"uuid","description":"Unique identifier of the refund.","uniqueKey":"latestRefund.oneOf.0.refundId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["PENDING","PROCESSING","COMPLETED","REJECTED","FAILED"],"description":"Current state of the refund: `PENDING` (registered, not yet sent to the provider), `PROCESSING` (sent, awaiting confirmation), `COMPLETED` (the money reached its destination), `REJECTED` (the request was declined — see `rejectionReason` — and nothing was sent) or `FAILED` / `CANCELLED` (the attempt did not go through; contact Ripio support).","uniqueKey":"latestRefund.oneOf.0.status","typeLabel":"enum\u003cstring>"},"rejectionReason":{"type":"string","enum":["","DUPLICATE_REQUEST","INVALID_DESTINATION","ALREADY_RESOLVED","NOT_ELIGIBLE","CONTACT_SUPPORT"],"description":"Why the request was declined. Empty unless `status` is `REJECTED`.","uniqueKey":"latestRefund.oneOf.0.rejectionReason","typeLabel":"enum\u003cstring>"},"initiatedBy":{"type":"string","enum":["PARTNER","WIDGET","OPS"],"description":"Which door the request came through: `PARTNER` (your API call), `WIDGET` (the end user, from the widget) or `OPS` (registered by Ripio's support team on the customer's behalf).","uniqueKey":"latestRefund.oneOf.0.initiatedBy","typeLabel":"enum\u003cstring>"},"requestedAt":{"type":"string","format":"date-time","description":"When the refund was requested.","uniqueKey":"latestRefund.oneOf.0.requestedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"latestRefund.oneOf.0","typeLabel":"object"},{"type":"null","description":"State of the most recent refund of this order's crypto deposit, or `null` if there never was one. On this ramp only a **completed** refund emits an event (`OFF-RAMP.ORDER.REFUNDED`), so this block is how progress is followed and the only way a rejection is ever read.","uniqueKey":"latestRefund.oneOf.1","typeLabel":"null"}],"uniqueKey":"latestRefund","typeLabel":"object | null"},"refundedTxnHash":{"oneOf":[{"type":"string","description":"On-chain hash of the crypto refund, once refunded. `null` otherwise.","example":null,"uniqueKey":"refundedTxnHash.oneOf.0","typeLabel":"string"},{"type":"null","description":"On-chain hash of the crypto refund, once refunded. `null` otherwise.","example":null,"uniqueKey":"refundedTxnHash.oneOf.1","typeLabel":"null"}],"uniqueKey":"refundedTxnHash","typeLabel":"string | null"},"travelRule":{"oneOf":[{"type":"object","description":"Mexico: the current Travel Rule declaration. Returned by the create endpoints and by the per-ramp retrieve endpoints; **not** by Retrieve an Order (`GET /api/v1/transactions/{orderId}/`), list endpoints or the `transactions` of a session.","required":["counterpartyIsSelf","fullName","country"],"properties":{"counterpartyIsSelf":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"travelRule.oneOf.0.counterpartyIsSelf","typeLabel":"boolean"},"fullName":{"oneOf":[{"type":"string","example":"María Pérez López","isRequired":true,"uniqueKey":"travelRule.oneOf.0.fullName.oneOf.0","typeLabel":"string"},{"type":"null","example":"María Pérez López","isRequired":true,"uniqueKey":"travelRule.oneOf.0.fullName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travelRule.oneOf.0.fullName","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","example":"MX","isRequired":true,"uniqueKey":"travelRule.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","example":"MX","isRequired":true,"uniqueKey":"travelRule.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"travelRule.oneOf.0.country","typeLabel":"string | null"}},"uniqueKey":"travelRule.oneOf.0","typeLabel":"object"},{"type":"null","description":"Mexico: the current Travel Rule declaration. Returned by the create endpoints and by the per-ramp retrieve endpoints; **not** by Retrieve an Order (`GET /api/v1/transactions/{orderId}/`), list endpoints or the `transactions` of a session.","required":["counterpartyIsSelf","fullName","country"],"properties":{"counterpartyIsSelf":{"type":"boolean","example":false},"fullName":{"oneOf":[{"type":"string","example":"María Pérez López"},{"type":"null","example":"María Pérez López"}]},"country":{"oneOf":[{"type":"string","example":"MX"},{"type":"null","example":"MX"}]}},"uniqueKey":"travelRule.oneOf.1","typeLabel":"null"}],"uniqueKey":"travelRule","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"transactionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","quoteId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","fromCurrency":"USDC","toCurrency":"ARS","amount":"\u003cstring>","chain":"ETHEREUM","metadata":{},"txnHash":null,"providerId":"\u003cstring>","finishedAt":"\u003cstring>","fiatAccountId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","refundAddress":"\u003cstring>","refundable":false,"refundDestinationRequired":false,"latestRefund":{"refundId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"PENDING","rejectionReason":"","initiatedBy":"PARTNER","requestedAt":"2023-11-07T05:31:56Z"},"refundedTxnHash":null,"travelRule":{"counterpartyIsSelf":false,"fullName":"María Pérez López","country":"MX"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b69ffeab-d73e-4e99-9063-fe1028e73582":{"description":"Unauthorized - Invalid or missing access token.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Application-specific error code.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"type":{"type":"string","description":"Type of error or exception.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"oneOf":[{"type":"object","description":"Error details. The shape depends on the error:\n\n- Most business errors return an object with a `message` key.\n- Field validation errors return an object keyed by field name, each holding an array of `{ message, code }`.\n- Request-level validation errors (e.g. a missing query parameter) return a bare array of `{ message, code }`.","properties":{"message":{"type":"string","description":"Detailed error message.","uniqueKey":"detail.oneOf.0.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"object"},{"type":"array","description":"Error details. The shape depends on the error:\n\n- Most business errors return an object with a `message` key.\n- Field validation errors return an object keyed by field name, each holding an array of `{ message, code }`.\n- Request-level validation errors (e.g. a missing query parameter) return a bare array of `{ message, code }`.","properties":{"message":{"type":"string","description":"Detailed error message."}},"additionalProperties":true,"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"array"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"object | array"},"status":{"type":"integer","description":"HTTP status code.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"}},"required":["code","type","detail","status"],"uniqueKey":"","typeLabel":"object"},"example":{"code":40001,"type":"NotAuthenticated","detail":{"message":"Authentication credentials were not provided.","code":"not_authenticated"},"status":401},"examples":{"Example":{"title":"Example","value":{"code":40001,"type":"NotAuthenticated","detail":{"message":"Authentication credentials were not provided.","code":"not_authenticated"},"status":401}}},"exampleType":"examples"}},"exampleType":"examples"},"54d088b6-f025-445e-ac87-43f7a03702b2":{"description":"Not Found - the order does not exist, is not an off-ramp order, belongs to another account, or its customer is deactivated.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Application-specific error code.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"type":{"type":"string","description":"Type of error or exception.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"oneOf":[{"type":"object","description":"Error details. The shape depends on the error:\n\n- Most business errors return an object with a `message` key.\n- Field validation errors return an object keyed by field name, each holding an array of `{ message, code }`.\n- Request-level validation errors (e.g. a missing query parameter) return a bare array of `{ message, code }`.","properties":{"message":{"type":"string","description":"Detailed error message.","uniqueKey":"detail.oneOf.0.message","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"detail.oneOf.0","typeLabel":"object"},{"type":"array","description":"Error details. The shape depends on the error:\n\n- Most business errors return an object with a `message` key.\n- Field validation errors return an object keyed by field name, each holding an array of `{ message, code }`.\n- Request-level validation errors (e.g. a missing query parameter) return a bare array of `{ message, code }`.","properties":{"message":{"type":"string","description":"Detailed error message."}},"additionalProperties":true,"isRequired":true,"uniqueKey":"detail.oneOf.1","typeLabel":"array"}],"isRequired":true,"uniqueKey":"detail","typeLabel":"object | array"},"status":{"type":"integer","description":"HTTP status code.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"}},"required":["code","type","detail","status"],"uniqueKey":"","typeLabel":"object"},"example":{"code":40004,"type":"NotFound","detail":{"message":"Not found.","code":"not_found"},"status":404},"examples":{"Example":{"title":"Example","value":{"code":40004,"type":"NotFound","detail":{"message":"Not found.","code":"not_found"},"status":404}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"686a544d-e6b8-4128-865f-d9f41f789091":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Access token obtained via [/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as `Authorization: Bearer \u003caccess_token>`.","scopes":[],"schemeName":"BearerToken"}}},"servers":{"6447d3c6-dd4a-4999-adb1-97ae285a6408":{"url":"https://skala-sandbox.ripio.com","description":"Sandbox environment"},"8ee58e10-8bb3-4dca-9fb7-4363a852ef91":{"url":"https://skala.ripio.com","description":"Production environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Access token obtained via [/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as `Authorization: Bearer \u003caccess_token>`.","scopes":[],"schemeName":"BearerToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Access token obtained via [/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as `Authorization: Bearer \u003caccess_token>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerToken","name":"Authorization"}],"title":"BearerToken"}]},"originalFileLocation":"ramps-api/openapi.json"},"subdomain":"ripio-9dfd4837","siteName":"Ripio B2B API","title":"Retrieve an Off-Ramp Order - Ripio B2B API","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-20T18:55:01.955Z","originalFileLocation":"ramps-api/off-ramp/retrieve-an-off-ramp-order.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=\"dark\"}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=\"Returns a single off-ramp order by its orderId. The response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — refundable, refundDestinationRequired, latestRefund, refundAddress and refundedTxnHash — without paginating the whole list. That matters because a refund\u0026#x27;s progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See Refunds. Orders of a deactivated customer are not returned.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ripio B2B API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ripio-9dfd4837/LamC5PTKz6kdbzZa/_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/ripio-9dfd4837/LamC5PTKz6kdbzZa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ripio-9dfd4837/LamC5PTKz6kdbzZa/_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/ripio-9dfd4837/LamC5PTKz6kdbzZa/_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/ripio-9dfd4837/LamC5PTKz6kdbzZa/_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/ripio-9dfd4837/LamC5PTKz6kdbzZa/_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/ripio-9dfd4837/LamC5PTKz6kdbzZa/_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/ripio-9dfd4837/LamC5PTKz6kdbzZa/_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/ripio-9dfd4837/LamC5PTKz6kdbzZa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve an Off-Ramp Order - Ripio B2B API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a single off-ramp order by its orderId. The response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — refundable, refundDestinationRequired, latestRefund, refundAddress and refundedTxnHash — without paginating the whole list. That matters because a refund\u0026#x27;s progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See Refunds. Orders of a deactivated customer are not returned.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ripio B2B API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ripio-9dfd4837.mintlify.site/_mintlify/api/og/v2?division=Off-Ramp\u0026amp;title=Retrieve+an+Off-Ramp+Order\u0026amp;description=Returns+a+single+off-ramp+order+by+its+%60orderId%60.%0A%0AThe+response+is+the+same+object+the+listing+returns%2C+so+this+is+the+cheapest+way+to+re-read+the+refund+fields\u0026amp;theme=78128f9583fb0593c455d352\u0026amp;signature=aa4432d565344767d39465e95422e61eb1508348ed0e337c3c900b0f06d041b6\">\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=\"Retrieve an Off-Ramp Order - Ripio B2B API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a single off-ramp order by its orderId. The response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — refundable, refundDestinationRequired, latestRefund, refundAddress and refundedTxnHash — without paginating the whole list. That matters because a refund\u0026#x27;s progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See Refunds. Orders of a deactivated customer are not returned.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ripio-9dfd4837.mintlify.site/_mintlify/api/og/v2?division=Off-Ramp\u0026amp;title=Retrieve+an+Off-Ramp+Order\u0026amp;description=Returns+a+single+off-ramp+order+by+its+%60orderId%60.%0A%0AThe+response+is+the+same+object+the+listing+returns%2C+so+this+is+the+cheapest+way+to+re-read+the+refund+fields\u0026amp;theme=78128f9583fb0593c455d352\u0026amp;signature=aa4432d565344767d39465e95422e61eb1508348ed0e337c3c900b0f06d041b6\">\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/ripio-9dfd4837/LamC5PTKz6kdbzZa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ripio B2B API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7908FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/ramps-api/off-ramp/retrieve-an-off-ramp-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.ripio.com/#organization\",\"name\":\"Ripio\",\"url\":\"https://www.ripio.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ripio-9dfd4837/wCKCU-escYLNlxWQ/logo/logo_black.svg?fit=max\u0026auto=format\u0026n=wCKCU-escYLNlxWQ\u0026q=85\u0026s=bdf337e5acb2526c20ade218091c4203\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ripio.com#website\",\"name\":\"Ripio B2B API\",\"url\":\"https://docs.ripio.com\",\"publisher\":{\"@id\":\"https://www.ripio.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order#webpage\",\"url\":\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order\",\"name\":\"Retrieve an Off-Ramp Order\",\"description\":\"Returns a single off-ramp order by its orderId. The response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — refundable, refundDestinationRequired, latestRefund, refundAddress and refundedTxnHash — without paginating the whole list. That matters because a refund's progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See Refunds. Orders of a deactivated customer are not returned.\",\"dateModified\":\"2026-08-20T18:55:01.955Z\",\"isPartOf\":{\"@id\":\"https://docs.ripio.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Integration\",\"item\":\"https://docs.ripio.com/ramps-api/kyc/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.ripio.com/ramps-api/authentication/acquire-access-token\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Off-Ramp\",\"item\":\"https://docs.ripio.com/ramps-api/off-ramp/list-off-ramp-orders\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Retrieve an Off-Ramp Order\",\"item\":\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order#apireference\",\"headline\":\"Retrieve an Off-Ramp Order\",\"name\":\"Retrieve an Off-Ramp Order\",\"description\":\"Returns a single off-ramp order by its orderId. The response is the same object the listing returns, so this is the cheapest way to re-read the refund fields of one order — refundable, refundDestinationRequired, latestRefund, refundAddress and refundedTxnHash — without paginating the whole list. That matters because a refund's progress and its rejection are only ever reported here: on this ramp only a completed refund emits a webhook event. See Refunds. Orders of a deactivated customer are not returned.\",\"url\":\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order#webpage\"},\"dateModified\":\"2026-08-20T18:55:01.955Z\",\"publisher\":{\"@id\":\"https://www.ripio.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ripio.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ripio B2B API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ripio\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/ramps-api/off-ramp/retrieve-an-off-ramp-order.md","siteName":"Ripio B2B API","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Crypto as a Service","pages":[{"title":"Crypto as a Service","href":"/crypto-as-a-service/overview/introduction"}]},{"tab":"Ramps","groups":[{"group":"Overview","pages":[{"title":"Ripio Ramps API: On-Ramp \u0026 Off-Ramp Integration for Partners","sidebarTitle":"Introduction","href":"/ramps-api/overview/introduction"},{"title":"Choose your integration","href":"/ramps-api/overview/choose-your-integration"},{"group":"Countries \u0026 payment methods","pages":[{"title":"Countries \u0026 payment methods","sidebarTitle":"Overview","href":"/ramps-api/overview/countries/overview"},{"title":"Argentina","href":"/ramps-api/overview/countries/argentina"},{"title":"Mexico","href":"/ramps-api/overview/countries/mexico"},{"title":"Colombia","href":"/ramps-api/overview/countries/colombia"},{"title":"Brazil","href":"/ramps-api/overview/countries/brazil"}]}]},{"group":"Widget integration","pages":[{"title":"Widget integration","sidebarTitle":"Overview","href":"/ramps-api/widget/overview"},{"group":"Get started","pages":[{"title":"Authentication","href":"/ramps-api/widget/get-started/authentication"},{"title":"Launch the widget","href":"/ramps-api/widget/get-started/launch"},{"title":"Returning to your app","href":"/ramps-api/widget/get-started/returning-to-your-app"}]},{"group":"User flows","pages":[{"title":"Sign-in and terms","href":"/ramps-api/widget/flows/identity-and-terms"},{"title":"Identity verification in the widget","href":"/ramps-api/widget/flows/kyc"},{"title":"Investor profile (Brazil)","href":"/ramps-api/widget/flows/investor-profile"},{"title":"Travel Rule (Mexico)","href":"/ramps-api/widget/flows/travel-rule"},{"title":"Buying crypto (on-ramp)","href":"/ramps-api/widget/flows/on-ramp"},{"title":"Selling crypto (off-ramp)","href":"/ramps-api/widget/flows/off-ramp"},{"title":"History and refunds","href":"/ramps-api/widget/flows/history-and-refunds"},{"title":"Recovering a rejected payout","href":"/ramps-api/widget/flows/order-recovery"},{"title":"Emails Ripio sends your users","href":"/ramps-api/widget/flows/emails"}]},{"group":"Configuration","pages":[{"title":"Partner settings","href":"/ramps-api/widget/configuration/partner-settings"},{"title":"Theming","href":"/ramps-api/widget/configuration/theming"}]},{"title":"Troubleshooting and support","href":"/ramps-api/widget/troubleshooting"}]},{"group":"API Integration","pages":[{"group":"Overview","pages":[{"group":"Identity verification (KYC)","pages":[{"title":"Overview \u0026 which model to use","sidebarTitle":"Overview","href":"/ramps-api/kyc/overview"},{"title":"Ripio-hosted KYC (redirect)","sidebarTitle":"Ripio-hosted KYC (redirect)","href":"/ramps-api/kyc/kyc-with-ripio"},{"title":"Partner-submitted KYC (API)","sidebarTitle":"Partner-submitted KYC (API)","href":"/ramps-api/kyc/kyc-via-api-overview"},{"title":"KYC fields by country","sidebarTitle":"KYC fields by country","href":"/ramps-api/kyc/kyc-fields-by-country"},{"title":"Reusable KYC (Sumsub share token)","sidebarTitle":"Reusable KYC (share token)","href":"/ramps-api/kyc/reusable-kyc"}]},{"title":"On-Ramp integration","href":"/ramps-api/guides/on-ramp-integration"},{"title":"Off-Ramp integration","href":"/ramps-api/guides/off-ramp-integration"},{"title":"QR payments integration","href":"/ramps-api/guides/qr-payments-integration"},{"title":"Forwarding end-user context","href":"/ramps-api/guides/end-user-context"}]},{"group":"API Reference","pages":[{"group":"Authentication","pages":[{"openapi":"ramps-api/openapi.json POST /oauth2/token/","title":"Acquire Access Token","href":"/ramps-api/authentication/acquire-access-token"}]},{"group":"Errors","pages":[{"title":"Error Codes","href":"/ramps-api/errors/error-codes"}]},{"group":"Customers","pages":[{"openapi":"ramps-api/openapi.json POST /api/v1/customers/","title":"Create Customer","href":"/ramps-api/customers/create-customer"},{"openapi":"ramps-api/openapi.json PUT /api/v1/customers/{customerId}/","title":"Update Customer","href":"/ramps-api/customers/update-customer"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/fiatAccount/","title":"Create Deposit Account","href":"/ramps-api/customers/create-deposit-account"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/acceptTerms/","title":"Accept Terms and Conditions","href":"/ramps-api/customers/accept-terms"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/deactivate/","title":"Deactivate Customer","href":"/ramps-api/customers/deactivate-customer"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/reactivate/","title":"Reactivate Customer","href":"/ramps-api/customers/reactivate-customer"}]},{"group":"Terms and Conditions","pages":[{"title":"Terms and Conditions","href":"/ramps-api/terms-and-conditions/introduction"},{"openapi":"ramps-api/openapi.json GET /api/v1/termsAndConditions/","title":"Get Terms and Conditions","href":"/ramps-api/terms-and-conditions/get-terms-and-conditions"},{"openapi":"ramps-api/openapi.json GET /api/v1/customers/{customerId}/termsAcceptance/","title":"Get Terms Acceptance Status","href":"/ramps-api/terms-and-conditions/get-terms-acceptance-status"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/termsLink/","title":"Create Terms Acceptance Link","href":"/ramps-api/terms-and-conditions/create-terms-link"}]},{"group":"Investor Profile (Brazil)","pages":[{"title":"Investor Profile (Brazil)","href":"/ramps-api/investor-profile/introduction"},{"openapi":"ramps-api/openapi.json GET /api/v1/investorProfile/questionnaire/","title":"Get Investor Questionnaire","href":"/ramps-api/investor-profile/get-investor-questionnaire"},{"openapi":"ramps-api/openapi.json GET /api/v1/customers/{customerId}/investorProfile/","title":"Get Investor Profile Status","href":"/ramps-api/investor-profile/get-investor-profile-status"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/investorProfile/","title":"Submit Investor Profile","href":"/ramps-api/investor-profile/submit-investor-profile"}]},{"group":"Travel Rule (Mexico)","pages":[{"title":"Travel Rule (Mexico)","href":"/ramps-api/travel-rule/introduction"}]},{"group":"KYC","pages":[{"openapi":"ramps-api/openapi.json GET /api/v1/kycRequirements/","title":"Retrieve KYC Requirements","href":"/ramps-api/kyc/retrieve-kyc-requirements"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/kyc/start/","title":"Start KYC","href":"/ramps-api/kyc/start-kyc"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/kyc/","title":"Submit KYC Information","href":"/ramps-api/kyc/submit-kyc-information"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/kyc/otp/resend/","title":"Resend KYC OTP","href":"/ramps-api/kyc/resend-kyc-otp"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/kyc/otp/validate/","title":"Validate KYC OTP","href":"/ramps-api/kyc/validate-kyc-otp"},{"openapi":"ramps-api/openapi.json GET /api/v1/customers/{customerId}/kycSubmissions/","title":"Retrieve Latest KYC Submission","href":"/ramps-api/kyc/retrieve-kyc-submission"}]},{"group":"Fiat Accounts","pages":[{"title":"Fiat account lifecycle","href":"/ramps-api/fiat-accounts/lifecycle"},{"openapi":"ramps-api/openapi.json GET /api/v1/fiatAccounts/","title":"List Fiat Accounts","href":"/ramps-api/fiat-accounts/list-fiat-accounts"},{"openapi":"ramps-api/openapi.json POST /api/v1/fiatAccounts/","title":"Create Fiat Account","href":"/ramps-api/fiat-accounts/create-fiat-account"},{"openapi":"ramps-api/openapi.json POST /api/v1/fiatAccounts/{fiatAccountId}/confirm/","title":"Confirm Fiat Account","href":"/ramps-api/fiat-accounts/confirm-fiat-account"},{"openapi":"ramps-api/openapi.json GET /api/v1/fiatAccounts/requirements/","title":"Retrieve Fiat Account Requirements","href":"/ramps-api/fiat-accounts/retrieve-fiat-account-requirements"},{"openapi":"ramps-api/openapi.json GET /api/v1/banks/","title":"List Bank Codes","href":"/ramps-api/fiat-accounts/list-banks"}]},{"group":"Quotes","pages":[{"openapi":"ramps-api/openapi.json POST /api/v1/quotes/","title":"Create Quote","href":"/ramps-api/quotes/create-quote"}]},{"group":"On-Ramp","pages":[{"openapi":"ramps-api/openapi.json GET /api/v1/onramp/","title":"List On-Ramp Orders","href":"/ramps-api/on-ramp/list-on-ramp-orders"},{"openapi":"ramps-api/openapi.json POST /api/v1/onramp/","title":"Create On-Ramp Order","href":"/ramps-api/on-ramp/create-on-ramp-order"},{"openapi":"ramps-api/openapi.json GET /api/v1/onramp/{orderId}/","title":"Retrieve an On-Ramp Order","href":"/ramps-api/on-ramp/retrieve-an-on-ramp-order"},{"openapi":"ramps-api/openapi.json GET /api/v1/onrampSession/","title":"List On-Ramp Sessions","href":"/ramps-api/on-ramp/list-on-ramp-sessions"},{"openapi":"ramps-api/openapi.json POST /api/v1/onrampSession/","title":"Create On-Ramp Session","href":"/ramps-api/on-ramp/create-on-ramp-session"},{"openapi":"ramps-api/openapi.json GET /api/v1/onrampSession/{sessionId}/","title":"Retrieve an On-Ramp Session","href":"/ramps-api/on-ramp/retrieve-an-on-ramp-session"},{"openapi":"ramps-api/openapi.json GET /api/v1/customers/{customerId}/onrampSession/","title":"Retrieve a Customer's On-Ramp Session","href":"/ramps-api/on-ramp/retrieve-a-customer-on-ramp-session"}]},{"group":"Off-Ramp","pages":[{"openapi":"ramps-api/openapi.json GET /api/v1/offramp/","title":"List Off-Ramp Orders","href":"/ramps-api/off-ramp/list-off-ramp-orders"},{"openapi":"ramps-api/openapi.json POST /api/v1/offramp/","title":"Create Off-Ramp Order","description":"Initiates a single crypto-to-fiat off-ramp transaction based on a previously obtained quote and the customer's destination fiat account. Returns the transaction id and the crypto deposit address the customer must send funds to. The order executes automatically once the crypto deposit is confirmed. Use this for one-off withdrawals; to reuse a destination account across many spontaneous deposits, create an Off-Ramp Session instead.","href":"/ramps-api/off-ramp/create-off-ramp-order"},{"openapi":"ramps-api/openapi.json GET /api/v1/offramp/{orderId}/","title":"Retrieve an Off-Ramp Order","href":"/ramps-api/off-ramp/retrieve-an-off-ramp-order"},{"openapi":"ramps-api/openapi.json GET /api/v1/offrampSession/","title":"List Off-Ramp Sessions","description":"Retrieves a list of all off-ramp sessions. Results are limited to active customers — sessions belonging to deactivated customers are excluded.","href":"/ramps-api/off-ramp/list-off-ramp-sessions"},{"openapi":"ramps-api/openapi.json POST /api/v1/offrampSession/","title":"Create Off-Ramp Session","href":"/ramps-api/off-ramp/create-off-ramp-session"},{"openapi":"ramps-api/openapi.json GET /api/v1/offrampSession/{sessionId}/","title":"Retrieve an Off-Ramp Session","href":"/ramps-api/off-ramp/retrieve-an-off-ramp-session"},{"openapi":"ramps-api/openapi.json POST /api/v1/offramp/{orderId}/changeFiatAccount/","title":"Change Fiat Account and Reprocess","href":"/ramps-api/off-ramp/change-fiat-account"}]},{"group":"Refunds","pages":[{"title":"Refunds","sidebarTitle":"Overview","href":"/ramps-api/refunds/overview"},{"group":"Fiat Refunds","pages":[{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/transactions/onramp/{orderId}/refund/","title":"Request a Fiat Refund","href":"/ramps-api/refunds/request-fiat-refund"},{"openapi":"ramps-api/openapi.json GET /api/v1/customers/{customerId}/refundableDeposits/","title":"List Refundable Deposits","href":"/ramps-api/refunds/list-refundable-deposits"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/refundableDeposits/{depositUuid}/refund/","title":"Refund a Deposit","href":"/ramps-api/refunds/refund-deposit"}]},{"group":"Crypto Refunds","pages":[{"openapi":"ramps-api/openapi.json POST /api/v1/offramp/{orderId}/refund/","title":"Request a Crypto Refund","href":"/ramps-api/refunds/request-crypto-refund"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/transactions/offramp/{orderId}/refund/","title":"Request a Customer's Crypto Refund","href":"/ramps-api/refunds/request-customer-crypto-refund"},{"openapi":"ramps-api/openapi.json GET /api/v1/customers/{customerId}/refundableCryptoDeposits/","title":"List Refundable Crypto Deposits","href":"/ramps-api/refunds/list-refundable-crypto-deposits"},{"openapi":"ramps-api/openapi.json POST /api/v1/customers/{customerId}/refundableCryptoDeposits/{depositId}/refund/","title":"Refund a Crypto Deposit","href":"/ramps-api/refunds/refund-crypto-deposit"}]}]},{"group":"Sell and Pay","pages":[{"openapi":"ramps-api/openapi.json POST /api/v1/sellAndPays/fiatAccounts/","title":"Create fiat account for sell and pay","href":"/ramps-api/sell-and-pay/create-fiat-account"},{"openapi":"ramps-api/openapi.json POST /api/v1/sellAndPays/","title":"Create Sell and Pay transaction","href":"/ramps-api/sell-and-pay/create-sell-and-pay"},{"openapi":"ramps-api/openapi.json PUT /api/v1/sellAndPays/{sell_and_pay_id}/","title":"Update Sell and Pay transaction","href":"/ramps-api/sell-and-pay/update-sell-and-pay"},{"openapi":"ramps-api/openapi.json POST /api/v1/sellAndPays/{sell_and_pay_id}/execute/","title":"Execute Sell and Pay transaction","href":"/ramps-api/sell-and-pay/execute-sell-and-pay"},{"openapi":"ramps-api/openapi.json GET /api/v1/sellAndPays/","title":"List Sell and Pay transactions","href":"/ramps-api/sell-and-pay/list-sell-and-pay"},{"openapi":"ramps-api/openapi.json GET /api/v1/sellAndPays/{sell_and_pay_id}/","title":"Retrieve Sell and Pay transaction","href":"/ramps-api/sell-and-pay/retrieve-sell-and-pay"},{"openapi":"ramps-api/openapi.json DELETE /api/v1/sellAndPays/{sell_and_pay_id}/","title":"Delete Sell and Pay transaction","href":"/ramps-api/sell-and-pay/delete-sell-and-pay"},{"openapi":"ramps-api/openapi.json POST /api/v1/sellAndPays/validateQrCode/","title":"Validate QR Code","href":"/ramps-api/sell-and-pay/validate-qr-code"}]},{"group":"Transactions","pages":[{"openapi":"ramps-api/openapi.json GET /api/v1/transactions/","title":"List All Orders (On-Ramp \u0026 Off-Ramp)","href":"/ramps-api/transactions/list-all-orders-on-ramp-\u0026-off-ramp"},{"openapi":"ramps-api/openapi.json GET /api/v1/transactions/{orderId}/","title":"Retrieve an Order (On-Ramp or Off-Ramp)","href":"/ramps-api/transactions/retrieve-an-order"},{"group":"Customer Transactions","pages":[{"openapi":"ramps-api/openapi.json GET /api/v1/customers/{customerId}/transactions/onramp/","title":"List Customer's On-Ramp Transaction History","href":"/ramps-api/transactions/list-customer-onramp-transactions"},{"openapi":"ramps-api/openapi.json GET /api/v1/customers/{customerId}/transactions/offramp/","title":"List Customer's Off-Ramp Transaction History","href":"/ramps-api/transactions/list-customer-offramp-transactions"}]}]},{"group":"Networks","pages":[{"openapi":"ramps-api/openapi.json GET /api/v1/depositNetworks/","title":"Get Deposit Networks","href":"/ramps-api/networks/get-deposit-networks"},{"openapi":"ramps-api/openapi.json GET /api/v1/withdrawalNetworks/","title":"Get Withdrawal Networks","href":"/ramps-api/networks/get-withdrawal-networks"}]},{"group":"Rates","pages":[{"openapi":"ramps-api/openapi.json GET /api/v1/rates/","title":"Get Market Rates","href":"/ramps-api/rates/get-market-rates"}]},{"group":"Transaction Limits","pages":[{"openapi":"ramps-api/openapi.json GET /api/v1/transactionLimits/","title":"Get Transaction Limits","href":"/ramps-api/transaction-limits/get-transaction-limits"}]},{"group":"Sandbox","pages":[{"title":"KYC in sandbox","href":"/ramps-api/sandbox/kyc-in-sandbox"},{"openapi":"ramps-api/openapi.json POST /api/v1/simulateDeposit/","title":"Simulate Deposit for On-Ramp (Sandbox)","href":"/ramps-api/sandbox/simulate-deposit-for-on-ramp-sandbox"}]},{"group":"Support Tickets","pages":[{"openapi":"ramps-api/openapi.json POST /api/v1/supportTickets/","title":"Create Support Ticket","href":"/ramps-api/support-tickets/create-support-ticket"},{"openapi":"ramps-api/openapi.json GET /api/v1/supportTickets/{ticketId}/","title":"Retrieve Support Ticket","href":"/ramps-api/support-tickets/retrieve-support-ticket"}]},{"group":"Webhooks","pages":[{"group":"Introduction","pages":[{"title":"Webhooks Introduction","href":"/ramps-api/webhooks/introduction"}]},{"group":"On-Ramp Events","pages":[{"title":"On-Ramp Webhook Events","href":"/ramps-api/webhooks/on-ramp-events"}]},{"group":"Off-Ramp Events","pages":[{"title":"Off-Ramp Webhook Events","href":"/ramps-api/webhooks/off-ramp-events"}]},{"group":"Sell and Pay Events","pages":[{"title":"Sell and Pay Webhook Events","href":"/ramps-api/webhooks/sell-and-pay-events"}]},{"group":"KYC Events","pages":[{"title":"KYC Webhook Events","href":"/ramps-api/webhooks/kyc-events"}]},{"group":"Account Events","pages":[{"title":"Account Webhook Events","href":"/ramps-api/webhooks/account-events"}]},{"group":"Support Ticket Events","pages":[{"title":"Support Ticket Webhook Events","href":"/ramps-api/webhooks/support-ticket-events"}]}]}]}]}]},{"tab":"wFiat Stablecoins","pages":[{"title":"wFiat Stablecoins","href":"/wfiat/overview"}]}]},"basePath":"","title":"Retrieve an Off-Ramp Order - Ripio B2B API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}