Offramp

Get an offramp order

Changed on Nov 6, 2026

By the order id. A customer bearer reads that customer's orders; an API key with deposits:read, the project's.

get/offramp/orders/{id}

Request

Base URL
https://v1.orchestrator.rhinestone.dev/deposit-processor
Auth
- API key in header x-api-key
- or HTTP bearer
- or HTTP bearer
TypeScript
https://skmtc.dev/rhinestonewtf/apis/deposit-service-api/docs/offramp/orders/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Headers

x-api-keystring

Integrator API key: the project’s orders

authorizationstring

Customer bearer from POST /compliance/sessions, or a project-scoped platform bearer where the route permits tenant access

Example:Bearer eyJhbGciOi...

Response

The order

idstring uuid required

provider'noah' | 'swapped' required

status'pending' | 'processing' | 'completed' | 'failed' | 'refunded' required

terminalboolean required

No stage will change again

providerStatusstring required

The provider’s own status of its latest leg, else ours (reserved, opened, refused, unknown, expired); informational

createdAtstring date-time required

When the provider says the order began

updatedAtstring date-time required

senderstring required

The address the provider takes the crypto from: source.address, or the withdrawal account it pays into

expiresAtstring date-time required

Send the payment before this

Example response

{
  "sender": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
  "payment": {
    "from": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "to": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "token": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "amount": "100000000"
  }
}

Changes

Nov 6, 2026aa1767d704fa Revision changes
- breaking
  added to the //// response property oneOf list for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_FORBIDDEN enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_REJECTED enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new PROVIDER_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- warning
  added the new READ_ONLY_SESSION enum value to the response property for the response status
- info
  the endpoint scheme security complianceSessionBearer was added to the API
- info
  the endpoint scheme security internalProjectBearer was added to the API
- info
  the endpoint scheme security tenantApiKey was added to the API
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added withdrawal_account discriminator mapping keys to the //// response property for the response status
Oct 16, 2026816f78ba036e Revision changes
- info
  endpoint added

Operation history