> ## Documentation Index > Fetch the complete documentation index at: https://docs.rhinestone.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get an offramp session > By the session `id`. A customer bearer reads that customer's sessions; an API key with `deposits:read`, the project's. ## OpenAPI ````yaml https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /offramp/sessions/{id} openapi: 3.1.0 info: title: Deposit Service API version: 1.0.0 description: >- Rhinestone Deposits API: accept deposits from any chain, asset or payment method, and settle them as one token on one chain. servers: - url: https://v1.orchestrator.rhinestone.dev/deposit-processor security: [] paths: /offramp/sessions/{id}: get: tags: - Offramp summary: Get an offramp session description: >- By the session `id`. A customer bearer reads that customer's sessions; an API key with `deposits:read`, the project's. parameters: - schema: type: string format: uuid required: true name: id in: path - schema: type: string description: 'Integrator API key: the project’s orders' required: false description: 'Integrator API key: the project’s orders' name: x-api-key in: header - schema: type: string description: >- Customer bearer from `POST /compliance/sessions`: that customer’s orders, and every order on its bound account example: Bearer eyJhbGciOi... required: false description: >- Customer bearer from `POST /compliance/sessions`: that customer’s orders, and every order on its bound account name: authorization in: header responses: '200': description: The session content: application/json: schema: $ref: '#/components/schemas/OfframpSession' '401': description: Missing or invalid bearer content: application/json: schema: type: object properties: error: type: string code: type: string enum: - VERIFICATION_REQUIRED description: >- The customer must resume hosted verification for this currency, then retry required: - error '403': description: >- The bearer no longer matches its customer, or an API key was sent: payout rails are per customer content: application/json: schema: type: object properties: error: type: string code: type: string enum: - VERIFICATION_REQUIRED description: >- The customer must resume hosted verification for this currency, then retry required: - error '404': description: No such session content: application/json: schema: type: object properties: error: type: string code: type: string enum: - VERIFICATION_REQUIRED description: >- The customer must resume hosted verification for this currency, then retry required: - error '500': description: Internal failure serving the request content: application/json: schema: type: object properties: error: type: string code: type: string enum: - VERIFICATION_REQUIRED description: >- The customer must resume hosted verification for this currency, then retry required: - error '502': description: The provider refused or failed the request content: application/json: schema: type: object properties: error: type: string code: type: string enum: - VERIFICATION_REQUIRED description: >- The customer must resume hosted verification for this currency, then retry required: - error '503': description: No payout provider is configured content: application/json: schema: type: object properties: error: type: string code: type: string enum: - VERIFICATION_REQUIRED description: >- The customer must resume hosted verification for this currency, then retry required: - error components: schemas: OfframpSession: type: object properties: id: type: string format: uuid provider: type: string enum: - noah - swapped status: type: string enum: - pending - processing - completed - failed - refunded terminal: type: boolean description: No stage will change again stages: type: object properties: receipt: $ref: '#/components/schemas/OnrampReceiptStage' conversion: $ref: '#/components/schemas/OnrampConversionStage' delivery: $ref: '#/components/schemas/OnrampDeliveryStage' return: $ref: '#/components/schemas/OnrampReturnStage' required: - receipt - conversion - delivery - return additionalProperties: false rail: oneOf: - type: object properties: kind: type: string enum: - fiat method: type: string required: - kind - method additionalProperties: false - type: object properties: kind: type: string enum: - exchange connection: type: string required: - kind - connection additionalProperties: false description: '`provider_selected` / `unknown` when the provider did not say' fiat: type: object properties: charged: type: - object - 'null' properties: total: type: - string - 'null' description: Including fees net: type: - string - 'null' description: Before fees currency: type: string required: - total - net - currency additionalProperties: false description: What the customer paid, in their own currency eur: type: - object - 'null' properties: total: type: - string - 'null' description: Including fees net: type: - string - 'null' description: Before fees required: - total - net additionalProperties: false description: Comparable across every order usd: type: - object - 'null' properties: total: type: - string - 'null' description: Including fees net: type: - string - 'null' description: Before fees required: - total - net additionalProperties: false required: - charged - eur - usd additionalProperties: false description: >- Each figure in a fixed currency; null when the provider did not state it crypto: type: - object - 'null' properties: asset: type: string network: type: string amount: type: string required: - asset - network - amount additionalProperties: false providerStatus: type: string description: The provider’s own status; informational createdAt: type: string format: date-time description: When the provider says the order began updatedAt: type: string format: date-time fundingAccount: type: string pattern: ^0x[a-fA-F0-9]{40}$ description: Where the withdrawal is sent; it pays the provider once example: '0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91' expiresAt: type: string format: date-time description: Funds arriving after this go back to the source account required: - id - provider - status - terminal - stages - rail - fiat - crypto - providerStatus - createdAt - updatedAt - fundingAccount - expiresAt additionalProperties: false OnrampReceiptStage: oneOf: - type: object properties: status: type: string enum: - not_started required: - status additionalProperties: false - type: object properties: status: type: string enum: - pending required: - status additionalProperties: false - type: object properties: status: type: string enum: - on_hold reason: type: string enum: - kyc_required - rfi_open - review required: - status - reason additionalProperties: false - type: object properties: status: type: string enum: - processing required: - status additionalProperties: false - type: object properties: status: type: string enum: - completed required: - status additionalProperties: false - type: object properties: status: type: string enum: - failed reason: type: string enum: - cancelled - declined - expired - provider_error required: - status - reason additionalProperties: false OnrampConversionStage: oneOf: - type: object properties: status: type: string enum: - not_started required: - status additionalProperties: false - type: object properties: status: type: string enum: - processing required: - status additionalProperties: false - type: object properties: status: type: string enum: - on_hold reason: type: string enum: - rfi_open - review required: - status - reason additionalProperties: false - type: object properties: status: type: string enum: - completed required: - status additionalProperties: false - type: object properties: status: type: string enum: - failed reason: type: string enum: - sub_fee - provider_error required: - status - reason additionalProperties: false OnrampDeliveryStage: oneOf: - type: object properties: status: type: string enum: - not_started required: - status additionalProperties: false - type: object properties: status: type: string enum: - pending required: - status additionalProperties: false - type: object properties: status: type: string enum: - on_hold reason: type: string enum: - rfi_open - review required: - status - reason additionalProperties: false - type: object properties: status: type: string enum: - submitted txHash: type: string pattern: ^0x[0-9a-f]{64}$ required: - status - txHash additionalProperties: false description: The provider reported the transfer; not yet seen on chain - type: object properties: status: type: string enum: - completed txHash: type: string pattern: ^0x[0-9a-f]{64}$ depositId: type: string description: The deposit it landed as required: - status - txHash - depositId additionalProperties: false description: The transfer landed on chain as a deposit - type: object properties: status: type: string enum: - failed reason: type: string enum: - sub_fee - provider_error required: - status - reason additionalProperties: false OnrampReturnStage: oneOf: - type: object properties: status: type: string enum: - none required: - status additionalProperties: false - type: object properties: status: type: string enum: - pending required: - status additionalProperties: false - type: object properties: status: type: string enum: - processing required: - status additionalProperties: false - type: object properties: status: type: string enum: - completed outcome: type: string enum: - full_refund - adjustment - unresolved required: - status - outcome additionalProperties: false - type: object properties: status: type: string enum: - failed required: - status additionalProperties: false ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.