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

# List payout methods

> The ways the customer can be paid out to a bank account. The provider decides them per customer.



## OpenAPI

````yaml https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /offramp/options
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/options:
    get:
      tags:
        - Offramp
      summary: List payout methods
      description: >-
        The ways the customer can be paid out to a bank account. The provider
        decides them per customer.
      parameters:
        - schema:
            type: string
            pattern: ^[A-Z]{2}$
            description: Receiving bank country
          required: false
          description: Receiving bank country
          name: country
          in: query
        - schema:
            type: string
            pattern: ^[A-Z]{3}$
            description: ISO 4217 payout currency
          required: false
          description: ISO 4217 payout currency
          name: currency
          in: query
        - 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 payout methods
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfframpOptions'
        '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: Payouts are not enabled for this project
          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:
    OfframpOptions:
      type: object
      properties:
        methods:
          type: array
          items:
            $ref: '#/components/schemas/PayoutMethod'
      required:
        - methods
      additionalProperties: false
    PayoutMethod:
      type: object
      properties:
        methodId:
          type: string
          format: uuid
          description: Opaque; pass it back to open a session
        rail:
          type: string
          enum:
            - ach
            - wire
            - sepa
            - swift
            - faster_payments
            - pix
        accountType:
          type: string
          enum:
            - us
            - iban
            - swift
            - gb
            - pix
          description: Which beneficiary details this method needs
        currency:
          type: string
          example: USD
        country:
          type:
            - string
            - 'null'
          description: ISO 3166-1 alpha-2 of the receiving bank; null for international
          example: US
        limits:
          type: object
          properties:
            min:
              type:
                - string
                - 'null'
            max:
              type:
                - string
                - 'null'
          required:
            - min
            - max
        etaSeconds:
          type:
            - integer
            - 'null'
          description: Typical time to the bank, in seconds
      required:
        - methodId
        - rail
        - accountType
        - currency
        - country
        - limits
        - etaSeconds
      additionalProperties: false

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.