Offramp

Start a withdrawal to a bank account

Changed on Nov 6, 2026

Prepares the payout with the provider and opens it for one exact amount: the requested amount, or slightly less (one base unit at a time) when another open withdrawal holds it. Then send order.payment exactly. A source holding the token the provider takes, on its chain, pays the provider directly; any other source on a chain that takes deposits pays into the customer’s withdrawal account an amount quoted to deliver it (SOURCE_NOT_SUPPORTED, NO_ROUTE or QUOTE_UNAVAILABLE otherwise, holding nothing). Once the order exists, every error names it (orderId).

post/offramp/orders

Request

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

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...

Request body

methodIdstring uuid required

From GET /offramp/options

amountstring required

In base units of the token the provider takes: what the payout is priced on and the provider receives, exactly. From source.token itself, the ERC-20 transfer’s value; from any other source, order.payment.amount is quoted from it

Example request

{
  "amount": "100000000",
  "source": {
    "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91",
    "chain": "eip155:8453",
    "token": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"
  }
}

Response

The order, the payment to send, and the estimate

Example response

{
  "order": {
    "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 FUNDING_NOT_CONFIGURED enum value to the response property for the response status
- warning
  added the new FUNDING_NOT_CONFIGURED enum value to the response property for the response status
- warning
  added the new FUNDING_NOT_CONFIGURED enum value to the response property for the response status
- warning
  added the new FUNDING_NOT_CONFIGURED enum value to the response property for the response status
- warning
  added the new FUNDING_NOT_CONFIGURED enum value to the response property for the response status
- warning
  added the new FUNDING_NOT_CONFIGURED enum value to the response property for the response status
- warning
  added the new FUNDING_NOT_CONFIGURED enum value to the response property for the response status
- warning
  added the new NO_ROUTE enum value to the response property for the response status
- warning
  added the new NO_ROUTE enum value to the response property for the response status
- warning
  added the new NO_ROUTE enum value to the response property for the response status
- warning
  added the new NO_ROUTE enum value to the response property for the response status
- warning
  added the new NO_ROUTE enum value to the response property for the response status
- warning
  added the new NO_ROUTE enum value to the response property for the response status
- warning
  added the new NO_ROUTE 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_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_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 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 QUOTE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new QUOTE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new QUOTE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new QUOTE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new QUOTE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new QUOTE_UNAVAILABLE enum value to the response property for the response status
- warning
  added the new QUOTE_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
- 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 SOURCE_NOT_SUPPORTED enum value to the response property for the response status
- warning
  added the new SOURCE_NOT_SUPPORTED enum value to the response property for the response status
- warning
  added the new SOURCE_NOT_SUPPORTED enum value to the response property for the response status
- warning
  added the new SOURCE_NOT_SUPPORTED enum value to the response property for the response status
- warning
  added the new SOURCE_NOT_SUPPORTED enum value to the response property for the response status
- warning
  added the new SOURCE_NOT_SUPPORTED enum value to the response property for the response status
- warning
  added the new SOURCE_NOT_SUPPORTED enum value to the response property for the response status
- info
  the endpoint scheme security complianceSessionBearer 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 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
- info
  removed the CROSS_ROUTE_NOT_SUPPORTED enum value from the response property for the response status
- info
  removed the CROSS_ROUTE_NOT_SUPPORTED enum value from the response property for the response status
- info
  removed the CROSS_ROUTE_NOT_SUPPORTED enum value from the response property for the response status
- info
  removed the CROSS_ROUTE_NOT_SUPPORTED enum value from the response property for the response status
- info
  removed the CROSS_ROUTE_NOT_SUPPORTED enum value from the response property for the response status
- info
  removed the CROSS_ROUTE_NOT_SUPPORTED enum value from the response property for the response status
- info
  removed the CROSS_ROUTE_NOT_SUPPORTED enum value from the response property for the response status
Oct 16, 2026816f78ba036e Revision changes
- info
  endpoint added

Operation history