> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get order

> Retrieve an existing order by id.



## OpenAPI

````yaml _media/specs/on-off-ramp-openapi.mintlify.json get /on-off-ramp/orders/{orderId}
openapi: 3.1.0
info:
  version: 0.1.0
  title: On & Off Ramp API
  description: >-
    The On & Off Ramp API offers a set of endpoints to move value between fiat
    and crypto through a single atomic order per direction: on-ramp or off-ramp.
  contact:
    name: Uphold API Team
    email: developer@uphold.com
    url: https://developer.uphold.com
servers:
  - url: https://api.enterprise.sandbox.uphold.com
    description: Sandbox
  - url: https://api.enterprise.uphold.com
    description: Production
security:
  - OAuth2: []
tags:
  - name: Orders
    description: On & Off Ramp orders.
  - name: Metadata
    description: Metadata.
  - name: Rails
    description: On & Off Ramp rails.
paths:
  /on-off-ramp/orders/{orderId}:
    get:
      tags:
        - Orders
      summary: Get order
      description: Retrieve an existing order by id.
      operationId: on-off-ramp.get-order
      parameters:
        - $ref: '#/components/parameters/order-id'
      responses:
        '200':
          $ref: '#/components/responses/get-order-response'
        '404':
          $ref: '#/components/responses/get-order-not-found-response'
      security:
        - OAuth2:
            - on-off-ramp.orders:read
components:
  parameters:
    order-id:
      name: orderId
      description: The id of the order.
      in: path
      required: true
      schema:
        type: string
        format: uuid
      examples:
        Order ID:
          value: 623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0
  responses:
    get-order-response:
      description: Order retrieved.
      content:
        application/json:
          schema:
            type: object
            properties:
              order:
                $ref: '#/components/schemas/order'
            required:
              - order
          examples:
            Order Retrieved:
              value:
                order:
                  id: 623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0
                  type: on-ramp
                  pricing: locked
                  origin:
                    asset: USD
                    amount: '100.00'
                    rate: '2.07021435361804542440'
                    node:
                      type: external-account
                      id: 7dc5c846-5ac2-4853-b67f-005cb83d4017
                      ownerId: cd21b26d-35d2-408a-9201-b8fdbef7a604
                      via: card
                      network: visa
                  destination:
                    asset: XRP
                    amount: '46.125658'
                    rate: '0.48304176727029881912'
                    node:
                      type: crypto-address
                      network: xrp-ledger
                      address: rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY
                      reference: '67809592'
                      execution:
                        mode: onchain
                        transactionHash: >-
                          E3FE6EA3D48F0C2B639448020EA4F03D4F4F8FFDB243A852A44F5D14B4B4D6E2
                  denomination:
                    asset: USD
                    amount: '100.00'
                    rate: '1.00000000000000000000'
                    target: origin
                  fees:
                    - type: deposit
                      code: on-ramp-deposit
                      asset: USD
                      amount: '1.00'
                      percentage: '1'
                      beneficiary: uphold
                    - type: network
                      code: crypto-network
                      asset: USD
                      amount: '3.51'
                  status: completed
                  timeline:
                    - event: deposit-processing
                      timestamp: '2024-07-24T15:22:39.000Z'
                    - event: deposit-completed
                      timestamp: '2024-07-24T15:22:44.000Z'
                    - event: withdrawal-processing
                      timestamp: '2024-07-24T15:22:45.000Z'
                    - event: withdrawal-sent
                      timestamp: '2024-07-24T15:22:50.000Z'
                    - event: withdrawal-completed
                      timestamp: '2024-07-24T15:33:08.000Z'
                  quotedAt: '2024-07-24T15:02:39.000Z'
                  createdAt: '2024-07-24T15:22:39.000Z'
                  updatedAt: '2024-07-24T15:33:08.000Z'
                  completedAt: '2024-07-24T15:33:08.000Z'
            Order Retrieved - Alternative Payment Method to XRP:
              value:
                order:
                  id: c5e2a0d4-6b1f-4e8a-9d3c-2f7b8a1e4d60
                  type: on-ramp
                  pricing: locked
                  origin:
                    asset: USD
                    amount: '100.00'
                    rate: '2.07021435361804542440'
                    node:
                      type: apm
                      method: paypal
                  destination:
                    asset: XRP
                    amount: '46.125658'
                    rate: '0.48304176727029881912'
                    node:
                      type: crypto-address
                      network: xrp-ledger
                      address: rfBtmHiLwwWH5maH2PT78GxubrSydRF9aY
                      reference: '67809592'
                      execution:
                        mode: onchain
                        transactionHash: >-
                          A91C3E5F7B2D4068E1F3A5C7B9D0E2F4A6C8E0B2D4F6A8C0E2B4D6F8A0C2E4F6
                  denomination:
                    asset: USD
                    amount: '100.00'
                    rate: '1.00000000000000000000'
                    target: origin
                  fees:
                    - type: deposit
                      code: on-ramp-deposit
                      asset: USD
                      amount: '1.00'
                      percentage: '1'
                      beneficiary: uphold
                    - type: network
                      code: crypto-network
                      asset: USD
                      amount: '3.51'
                  status: completed
                  timeline:
                    - event: deposit-processing
                      timestamp: '2024-07-24T15:22:39.000Z'
                    - event: deposit-completed
                      timestamp: '2024-07-24T15:22:44.000Z'
                    - event: withdrawal-processing
                      timestamp: '2024-07-24T15:22:45.000Z'
                    - event: withdrawal-sent
                      timestamp: '2024-07-24T15:22:50.000Z'
                    - event: withdrawal-completed
                      timestamp: '2024-07-24T15:33:08.000Z'
                  quotedAt: '2024-07-24T15:02:39.000Z'
                  createdAt: '2024-07-24T15:22:39.000Z'
                  updatedAt: '2024-07-24T15:33:08.000Z'
                  completedAt: '2024-07-24T15:33:08.000Z'
            Order Retrieved - Credit Card to Crypto External Account:
              value:
                order:
                  id: aae7d753-6f05-4ec7-abc7-42d873af59b8
                  type: on-ramp
                  pricing: locked
                  origin:
                    asset: GBP
                    amount: '37.88'
                    rate: '1.10650721'
                    node:
                      type: external-account
                      id: 7e19455d-4f37-470b-97c8-c3c46929afe8
                      ownerId: 0e09372e-e0e0-416b-a0af-9dd47f007389
                      via: card
                      network: mastercard
                  destination:
                    asset: XRP
                    amount: '32.860156'
                    rate: '0.90374467558689064494'
                    node:
                      type: external-account
                      id: 42812374-4beb-c271-9011-44eb9713b638
                      ownerId: 0e09372e-e0e0-416b-a0af-9dd47f007389
                      via: crypto
                      network: xrp-ledger
                      execution:
                        mode: onchain
                        transactionHash: >-
                          7C2E9B4A1D6F8035E2B7C4A9D1F6E3B8A5C2D7F4E1B9A6C3D8F5E2B7A4C1D9E6
                  denomination:
                    asset: USD
                    amount: '50.00'
                    rate: '0.75757101480937430355'
                    target: origin
                  fees:
                    - type: deposit
                      code: on-ramp-deposit
                      asset: GBP
                      amount: '1.51'
                      percentage: '3.99'
                      beneficiary: uphold
                    - type: network
                      code: crypto-network
                      asset: GBP
                      amount: '0.01'
                  status: completed
                  timeline:
                    - event: deposit-processing
                      timestamp: '2026-09-26T14:54:05.112Z'
                    - event: deposit-completed
                      timestamp: '2026-09-26T14:54:31.405Z'
                    - event: withdrawal-processing
                      timestamp: '2026-09-26T14:54:32.018Z'
                    - event: withdrawal-sent
                      timestamp: '2026-09-26T14:54:36.772Z'
                    - event: withdrawal-completed
                      timestamp: '2026-09-26T14:54:41.209Z'
                  quotedAt: '2026-09-26T14:53:57.890Z'
                  createdAt: '2026-09-26T14:54:05.112Z'
                  updatedAt: '2026-09-26T14:54:41.209Z'
                  completedAt: '2026-09-26T14:54:41.209Z'
            Order Retrieved - BTC to Credit Card:
              value:
                order:
                  id: 7bd2bbcb-52c5-4f03-bb8e-27829f9cfb65
                  type: off-ramp
                  pricing: estimated
                  origin:
                    asset: BTC
                    amount: '0.00114037'
                    rate: '0.00001120405708392375'
                    node:
                      type: crypto-address
                      network: bitcoin
                      address: mt77MA2KBengxQa8txmGcVau9DSda12RHX
                      execution:
                        mode: onchain
                        transactionHash: >-
                          3a1f2c9d8e7b6a5f4e3d2c1b0a9f8e7d6c5b4a39281706f5e4d3c2b1a0f9e8d7
                  destination:
                    asset: USD
                    amount: '100.00'
                    rate: '89253.38317267768950981583'
                    node:
                      type: external-account
                      id: 7dc5c846-5ac2-4853-b67f-005cb83d4017
                      ownerId: cd21b26d-35d2-408a-9201-b8fdbef7a604
                      via: card
                      network: visa
                  denomination:
                    asset: USD
                    amount: '100.00'
                    rate: '1.00000000000000000000'
                    target: destination
                  fees:
                    - type: withdrawal
                      code: off-ramp-withdrawal
                      asset: BTC
                      amount: '0.00001996'
                      percentage: '1.75'
                      beneficiary: uphold
                  status: completed
                  timeline:
                    - event: deposit-processing
                      timestamp: '2026-09-26T15:01:12.430Z'
                    - event: deposit-completed
                      timestamp: '2026-09-26T15:31:48.902Z'
                    - event: withdrawal-processing
                      timestamp: '2026-09-26T15:31:49.517Z'
                    - event: withdrawal-sent
                      timestamp: '2026-09-26T15:31:53.284Z'
                    - event: withdrawal-completed
                      timestamp: '2026-09-26T15:32:20.661Z'
                  quotedAt: '2026-09-26T14:53:57.890Z'
                  createdAt: '2026-09-26T14:54:05.112Z'
                  updatedAt: '2026-09-26T15:32:20.661Z'
                  completedAt: '2026-09-26T15:32:20.661Z'
      headers:
        x-uphold-request-id:
          description: >-
            A unique identifier for the request that can be shared with Uphold
            for troubleshooting purposes.
          required: true
          schema:
            type: string
          examples:
            Request ID:
              value: a4e390583b3ac581-MRS
    get-order-not-found-response:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            Order Not Found:
              value:
                code: entity_not_found
                message: The order cannot be found
                details:
                  entity: order
      headers:
        x-uphold-request-id:
          description: >-
            A unique identifier for the request that can be shared with Uphold
            for troubleshooting purposes.
          required: true
          schema:
            type: string
          examples:
            Request ID:
              value: a4e390583b3ac581-MRS
  schemas:
    order:
      type: object
      discriminator:
        propertyName: type
        mapping:
          on-ramp: '#/components/schemas/order-on-ramp'
          off-ramp: '#/components/schemas/order-off-ramp'
      oneOf:
        - $ref: '#/components/schemas/order-on-ramp'
          title: On-ramp
        - $ref: '#/components/schemas/order-off-ramp'
          title: Off-ramp
    error:
      description: The error information.
      allOf:
        - $ref: '#/components/schemas/feedback'
    order-on-ramp:
      allOf:
        - $ref: '#/components/schemas/order-base'
        - type: object
          properties:
            type:
              description: The type of the order.
              type: string
              enum:
                - on-ramp
            pricing:
              $ref: '#/components/schemas/order-pricing'
              description: The pricing mode of the order.
            origin:
              description: The origin of the order.
              allOf:
                - $ref: '#/components/schemas/order-endpoint-base'
                - type: object
                  properties:
                    node:
                      description: The node of the endpoint.
                      oneOf:
                        - title: External account
                          type: object
                          discriminator:
                            propertyName: via
                            mapping:
                              card: >-
                                #/components/schemas/order-node-external-account-card
                              apm: >-
                                #/components/schemas/order-node-external-account-apm
                          oneOf:
                            - $ref: >-
                                #/components/schemas/order-node-external-account-card
                              title: External Account - Card
                            - $ref: >-
                                #/components/schemas/order-node-external-account-apm
                              title: External Account - APM
                        - $ref: '#/components/schemas/order-node-apm-origin'
                          title: APM
                  required:
                    - node
            destination:
              description: The destination of the order.
              allOf:
                - $ref: '#/components/schemas/order-endpoint-base'
                - type: object
                  properties:
                    node:
                      description: The node of the endpoint.
                      oneOf:
                        - $ref: '#/components/schemas/order-node-crypto-address'
                          title: Crypto address
                        - $ref: >-
                            #/components/schemas/order-node-external-account-crypto
                          title: External Account - Crypto
                  required:
                    - node
          required:
            - type
            - pricing
            - origin
            - destination
    order-off-ramp:
      allOf:
        - $ref: '#/components/schemas/order-base'
        - type: object
          properties:
            type:
              description: The type of the order.
              type: string
              enum:
                - off-ramp
            pricing:
              description: The pricing mode of the order.
              type: string
              enum:
                - estimated
            origin:
              description: The origin of the order.
              allOf:
                - $ref: '#/components/schemas/order-endpoint-base'
                - type: object
                  properties:
                    node:
                      $ref: '#/components/schemas/order-node-crypto-address'
                      description: The node of the endpoint.
                  required:
                    - node
            destination:
              description: The destination of the order.
              allOf:
                - $ref: '#/components/schemas/order-endpoint-base'
                - type: object
                  properties:
                    node:
                      description: The node of the endpoint.
                      oneOf:
                        - title: External account
                          type: object
                          discriminator:
                            propertyName: via
                            mapping:
                              card: >-
                                #/components/schemas/order-node-external-account-card
                          oneOf:
                            - $ref: >-
                                #/components/schemas/order-node-external-account-card
                              title: External Account - Card
                  required:
                    - node
          required:
            - type
            - pricing
            - origin
            - destination
    feedback:
      description: A feedback message with a code and human-readable description.
      type: object
      properties:
        code:
          description: A short string with a brief explanation about the code reported.
          type: string
        message:
          description: A human-readable message providing more details.
          type: string
        details:
          description: Additional information about the feedback reported.
          type: object
          additionalProperties: true
      required:
        - code
        - message
    order-base:
      type: object
      properties:
        id:
          description: The id of the order.
          type: string
          format: uuid
        type:
          $ref: '#/components/schemas/order-type'
        origin:
          type: object
        destination:
          type: object
        denomination:
          $ref: '#/components/schemas/order-denomination'
          description: The denomination of the order.
        fees:
          $ref: '#/components/schemas/order-fees'
          description: The fees of the order.
        status:
          description: The status of the order.
          type: string
          enum:
            - pending
            - processing
            - on-hold
            - completed
            - expired
            - failed
        timeline:
          description: >-
            The timeline of events that occurred throughout the order's
            lifecycle.
          type: array
          items:
            $ref: '#/components/schemas/order-timeline-item'
        quotedAt:
          description: The time at which the order was quoted.
          type: string
          format: date-time
        createdAt:
          description: The time at which the order was created.
          type: string
          format: date-time
        updatedAt:
          description: The time at which the order was last updated.
          type: string
          format: date-time
        completedAt:
          description: The time at which the order was completed, if it has completed.
          type: string
          format: date-time
      required:
        - id
        - type
        - origin
        - destination
        - denomination
        - fees
        - status
        - timeline
        - quotedAt
        - createdAt
        - updatedAt
    order-pricing:
      description: The pricing mode.
      type: string
      enum:
        - estimated
        - locked
    order-endpoint-base:
      type: object
      properties:
        asset:
          description: The asset of the endpoint.
          type: string
        amount:
          description: The amount of the endpoint.
          type: string
        rate:
          description: >-
            The rate of the endpoint against its counter-part (origin to
            destination and vice-versa).
          type: string
      required:
        - asset
        - amount
        - rate
    order-node-external-account-card:
      allOf:
        - $ref: '#/components/schemas/quote-node-external-account-card'
        - type: object
          properties:
            confirmationUrl:
              description: >-
                The URL to confirm the authorization using the external account
                (e.g., 3DS).
              type: string
              format: uri
    order-node-external-account-apm:
      allOf:
        - $ref: '#/components/schemas/quote-node-external-account-apm'
        - type: object
          properties:
            confirmationUrl:
              description: >-
                The URL to confirm the authorization using the APM external
                account.
              type: string
              format: uri
    order-node-apm-origin:
      allOf:
        - $ref: '#/components/schemas/quote-node-apm-origin'
        - type: object
          properties:
            confirmationUrl:
              description: The URL to confirm the authorization using the APM.
              type: string
              format: uri
    order-node-crypto-address:
      type: object
      properties:
        type:
          description: The type of the node.
          type: string
          enum:
            - crypto-address
        network:
          $ref: '#/components/schemas/string-no-edge-spaces'
          description: The network that the crypto address is on.
        address:
          $ref: '#/components/schemas/string-no-edge-spaces'
          description: The crypto address (may not be available for deposits).
        reference:
          description: >-
            The additional identifier (e.g., destination tag, memo, or message)
            for the crypto address.
          type: string
        execution:
          $ref: '#/components/schemas/order-node-crypto-address-execution'
          description: The execution details for the operation.
      required:
        - type
        - network
    order-node-external-account-crypto:
      allOf:
        - $ref: '#/components/schemas/order-node-external-account-base'
        - type: object
          properties:
            via:
              description: The rail type which the external account is used.
              type: string
              enum:
                - crypto
            network:
              description: The network used with the external account.
              type: string
            execution:
              $ref: '#/components/schemas/order-node-crypto-address-execution'
              description: The execution details for the operation.
          required:
            - via
            - network
    order-type:
      description: >-
        Whether the order is an on-ramp (fiat to crypto) or off-ramp (crypto to
        fiat) order.
      type: string
      enum:
        - on-ramp
        - off-ramp
    order-denomination:
      type: object
      properties:
        asset:
          description: The asset in which the operation is denominated.
          type: string
        amount:
          description: The amount of the operation.
          type: string
        rate:
          description: The rate against the specified target (origin or destination).
          type: string
        target:
          description: >-
            Whether this exact amount should be paid by the origin or received
            by the destination.
          type: string
          enum:
            - origin
            - destination
      required:
        - asset
        - amount
        - rate
        - target
    order-fees:
      type: array
      items:
        type: object
        properties:
          type:
            description: The type of the fee, as charged on the order's transactions.
            type: string
            enum:
              - deposit
              - exchange
              - network
              - withdrawal
          code:
            description: The code of the fee, as charged on the order's transactions.
            type: string
          asset:
            description: The asset in which the fee is denominated.
            type: string
          amount:
            description: The amount of the fee.
            type: string
          percentage:
            description: >-
              The percentage of the fee, if the amount was calculated from a
              percentage.
            type: string
          beneficiary:
            description: The party that receives the fee.
            type: string
        required:
          - type
          - code
          - asset
          - amount
    order-timeline-item:
      type: object
      oneOf:
        - $ref: '#/components/schemas/order-timeline-item-regular'
          title: Regular events
        - $ref: '#/components/schemas/order-timeline-item-error'
          title: Events with error
        - $ref: '#/components/schemas/order-timeline-item-reason'
          title: Events with reason
    quote-node-external-account-card:
      allOf:
        - $ref: '#/components/schemas/order-node-external-account-base'
        - type: object
          properties:
            via:
              description: The rail type which the external account is used.
              type: string
              enum:
                - card
            network:
              description: The network used with the external account.
              type: string
          required:
            - via
            - network
    quote-node-external-account-apm:
      allOf:
        - $ref: '#/components/schemas/order-node-external-account-base'
        - type: object
          properties:
            via:
              description: The rail type which the external account is used.
              type: string
              enum:
                - apm
          required:
            - via
    quote-node-apm-origin:
      type: object
      properties:
        type:
          description: The type of the node.
          type: string
          enum:
            - apm
        method:
          description: The alternative payment method to be used in the operation.
          enum:
            - apple-pay
            - google-pay
            - paypal
            - venmo
      required:
        - type
        - method
    string-no-edge-spaces:
      type: string
      pattern: ^\S.*\S$|^\S$
    order-node-crypto-address-execution:
      type: object
      discriminator:
        propertyName: mode
        mapping:
          onchain: '#/components/schemas/order-node-crypto-address-execution-onchain'
          offchain: '#/components/schemas/order-node-crypto-address-execution-offchain'
          simulated: '#/components/schemas/order-node-crypto-address-execution-simulated'
      oneOf:
        - $ref: '#/components/schemas/order-node-crypto-address-execution-onchain'
          title: On-chain
        - $ref: '#/components/schemas/order-node-crypto-address-execution-offchain'
          title: Off-chain
        - $ref: '#/components/schemas/order-node-crypto-address-execution-simulated'
          title: Simulated
    order-node-external-account-base:
      type: object
      properties:
        type:
          description: The type of the node.
          type: string
          enum:
            - external-account
        id:
          description: The external account id.
          type: string
          format: uuid
        ownerId:
          description: The id of the user that owns the external account.
          type: string
          format: uuid
        via:
          description: The rail type which the external account is used.
          type: string
          enum:
            - apm
            - card
            - crypto
      required:
        - type
        - id
        - ownerId
    order-timeline-item-regular:
      type: object
      properties:
        event:
          description: The event that occurred in the order's timeline.
          type: string
          enum:
            - deposit-requested
            - deposit-processing
            - deposit-completed
            - deposit-expired
            - withdrawal-processing
            - withdrawal-sent
            - withdrawal-completed
            - refund-address-requested
            - refund-address-completed
            - refund-processing
            - refund-sent
            - refund-completed
            - refund-skipped
        timestamp:
          $ref: '#/components/schemas/order-timeline-timestamp'
      required:
        - event
        - timestamp
    order-timeline-item-error:
      type: object
      properties:
        event:
          description: The event that occurred in the order's timeline.
          type: string
          enum:
            - withdrawal-commit-failed
            - refund-commit-failed
        timestamp:
          $ref: '#/components/schemas/order-timeline-timestamp'
        error:
          $ref: '#/components/schemas/error'
          title: The error associated with the event.
      required:
        - event
        - error
        - timestamp
    order-timeline-item-reason:
      type: object
      properties:
        event:
          description: The event that occurred in the order's timeline.
          type: string
          enum:
            - deposit-on-hold
            - deposit-failed
            - withdrawal-on-hold
            - withdrawal-failed
            - refund-on-hold
            - refund-failed
        timestamp:
          $ref: '#/components/schemas/order-timeline-timestamp'
        reason:
          $ref: '#/components/schemas/transaction-status-reason'
          description: The reason associated with the event.
      required:
        - event
        - reason
        - timestamp
    order-node-crypto-address-execution-onchain:
      type: object
      properties:
        mode:
          description: The mode of execution.
          type: string
          enum:
            - onchain
        transactionHash:
          $ref: '#/components/schemas/string-no-edge-spaces'
          description: The hash of the transaction in the blockchain.
      required:
        - mode
        - transactionHash
    order-node-crypto-address-execution-offchain:
      type: object
      properties:
        mode:
          description: The mode of execution.
          type: string
          enum:
            - offchain
        accountId:
          description: The account id to which the off-chain transaction was made.
          type: string
          format: uuid
        accountOwnerId:
          description: >-
            The id of the user that owns the account to which the off-chain
            transaction was made.
          type: string
          format: uuid
      required:
        - mode
    order-node-crypto-address-execution-simulated:
      type: object
      properties:
        mode:
          description: The mode of execution.
          type: string
          enum:
            - simulated
        transactionHash:
          $ref: '#/components/schemas/string-no-edge-spaces'
          description: The simulated transaction hash.
      required:
        - mode
    order-timeline-timestamp:
      description: The time at which the event occurred.
      type: string
      format: date-time
    transaction-status-reason:
      description: The reason why the transaction failed or is on hold.
      type: string
      enum:
        - apm-account-holder-data-mismatch
        - apm-authorization-failed
        - apm-missing-account-holder-data
        - apm-payment-method-declined
        - bank-account-holder-name-mismatch
        - beneficiary-country-restricted
        - card-declined
        - card-declined-by-bank
        - card-expired
        - card-permanently-declined-by-bank
        - card-unauthorized
        - card-unsupported
        - card-withdrawals-unsupported
        - insufficient-funds
        - pending-requests-for-information
        - provider-maximum-limit-exceeded
        - screening-verification-failed
        - travel-rule-verification-failed
        - unspecified-error
        - velocity
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 authentication
      flows:
        clientCredentials:
          tokenUrl: /core/oauth2/token
          scopes:
            on-off-ramp.orders:create: Grants access to create orders.
            on-off-ramp.orders:read: Grants access to view orders.
            on-off-ramp.orders.metadata:read: Grants access to view orders metadata.
            on-off-ramp.orders.metadata:write: Grants access to modify orders metadata.
            on-off-ramp.orders.quotes:create: Grants access to create order quotes.

````