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

# List bank links

> Lists the account's Bank Links with their nested active Account Links, ordered by link time descending. Links that are still being completed and unlinked links are not returned. Results are paged: follow `next_page_token` until it is absent. Eligibility is computed fresh on every read, so a link's rails and verdict can change between pages.



## OpenAPI

````yaml https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json get /v1/accounts/{account_id}/funds/bank-links
openapi: 3.1.0
info:
  title: PWS Public API
  version: '1'
  description: >-
    Integrate with Payward Services to onboard users, manage accounts and funds,
    trade assets, and receive event notifications.
  contact:
    name: Payward Services
servers:
  - url: https://api.sandbox.services.payward.com
security: []
tags:
  - name: Assets
    description: List the assets PWS is willing to swap.
    x-displayName: Assets
  - name: Conversions
    description: >-
      Rule-driven and on-demand fiat ↔ crypto value movement, including
      conversion rules and deposits.
    x-displayName: Conversions
  - name: Auto Earn
    description: >-
      Manage Auto Earn preferences and retrieve allocation and reward
      information.
    x-displayName: Auto Earn
  - name: Bonded Earn
    description: >-
      Allocate funds to and deallocate funds from bonded earn strategies, review
      allocations, and track request status.
    x-displayName: Bonded Earn
  - name: Funding
    description: >-
      Discover deposit and withdrawal options, manage deposit addresses, and
      move funds between accounts.
    x-displayName: Funding
  - name: Derivatives transfers
    description: >-
      Move funds between an account's spot balance and the same owner's futures
      balance.
    x-displayName: Derivatives transfers
  - name: Portfolio
    description: 'Inspect a customer''s portfolio: balances, valuations, and transactions.'
    x-displayName: Portfolio
  - name: Ramp
    description: >-
      Support Ramp flows with discovery, quotes, limits, and hosted checkout
      experiences.
    x-displayName: Ramp
  - name: Bank links
    description: >-
      Link US bank accounts to an account through a Kraken-hosted widget, then
      reference them for money movement.
    x-displayName: Bank links
  - name: Reports
    description: Settlement and reconciliation reports for the partner.
    x-displayName: Reports
  - name: Market data stream
    description: Live market data for derivatives instruments.
    x-displayName: Market data stream
  - name: Derivatives instruments
    description: Discover instruments available for trading by asset type.
    x-displayName: Derivatives instruments
  - name: Derivatives tickers
    x-group: Derivatives market data
    description: Read market-data snapshots for supported trading instruments.
    x-displayName: Derivatives tickers
  - name: Derivatives order books
    x-group: Derivatives market data
    description: Read level-two market depth for supported trading instruments.
    x-displayName: Derivatives order books
  - name: Derivatives OHLC
    x-group: Derivatives market data
    description: Read historical candlestick market data for supported trading instruments.
    x-displayName: Derivatives OHLC
  - name: Derivatives orders
    description: Submit and inspect orders by asset type.
    x-displayName: Derivatives orders
  - name: Derivatives trades
    description: Inspect executions by asset type.
    x-displayName: Derivatives trades
  - name: Derivatives leverage
    description: Read and update per-instrument leverage preferences for trading accounts.
    x-displayName: Derivatives leverage
  - name: Swaps
    description: Account-funded quotes that lock a price until they expire or are executed.
    x-displayName: Swaps
  - name: Onchain quotes
    description: Wallet-funded quotes that return the data needed to settle onchain.
    x-displayName: Onchain quotes
  - name: Price trigger swaps
    description: Swaps that wait for a target price before submitting a trade.
    x-displayName: Price trigger swaps
  - name: Travel Rule verifications
    description: Travel Rule address ownership verification flows.
    x-displayName: Travel Rule verifications
  - name: Users
    description: >-
      User onboarding and status flows that the partner manages.


      - **Create User** provisions an account-owned user from an external
      reference and optional email.

      - **Get User** retrieves the user's profile, verification status, and
      required actions.


      Use the returned user `id` for calls that require the user's identifier.
    x-displayName: Users
  - name: Verifications
    description: Identity verification (KYC) submission and status for end users.
    x-displayName: Verifications
  - name: Webhooks
    description: >-
      Register HTTPS destinations to receive event deliveries, rotate signing
      secrets, and inspect, update, or delete existing subscriptions. Each
      subscription is owned by the authenticated partner; deliveries are signed
      with HMAC-SHA256 and retried on transient failures.


      In webhook payloads, `account_id` and `user_id` are in groups of four
      characters, with a space between the groups. For example, `WCQY T95Y CUL2
      A7NX`. The REST APIs send the same identifier without spaces, for example
      `WCQYT95YCUL2A7NX`. Remove the spaces before you compare a webhook
      identifier with a REST identifier.


      Amounts in webhook payloads are decimal strings, in the ledger precision
      of the asset. Compare amounts as decimal numbers, not as strings.
    x-displayName: Webhooks
paths:
  /v1/accounts/{account_id}/funds/bank-links:
    servers:
      - url: https://api.sandbox.services.payward.com
    get:
      tags:
        - Bank links
      summary: List bank links
      description: >-
        Lists the account's Bank Links with their nested active Account Links,
        ordered by link time descending. Links that are still being completed
        and unlinked links are not returned. Results are paged: follow
        `next_page_token` until it is absent. Eligibility is computed fresh on
        every read, so a link's rails and verdict can change between pages.
      operationId: listBankLinks
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - in: query
          name: page_size
          description: >-
            Maximum number of results to return. Ignored when `page_token` is
            present.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 25
            default: 20
          style: form
          example: 20
        - $ref: '#/components/parameters/PageToken'
      responses:
        '200':
          description: Successful response
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    description: >-
                      Bank Links for the account, ordered by link time
                      descending.
                    type: array
                    items:
                      $ref: '#/components/schemas/Ramp_BankLink'
                      description: >-
                        A provider-neutral linking operation and persistent bank
                        connection.
                  next_page_token:
                    description: >-
                      Opaque token for retrieving the next page. Absent when
                      there are no more results.
                    type: string
                    minLength: 1
                    maxLength: 256
              examples:
                page-of-bank-links:
                  summary: One page of Bank Links, with more to fetch
                  value:
                    data:
                      - bank_link_id: bal_5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
                        method_id: 3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b
                        status: linked
                        institution:
                          name: Pacific Trust Bank
                        account_links:
                          - account_link_id: al_7c2b8d19-4e35-4a71-b0c6-1d8f5e9a2b34
                            account_last4: '4242'
                            status: active
                            eligible_rails:
                              - ach
                              - rtp
                              - rfp
                            rail_limits:
                              rfp:
                                max_daily_amount: '15000'
                            eligibility_status: eligible
                        accounts_eligibility_status: eligible
                    next_page_token: AY7dRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4
                no-bank-links:
                  summary: Account with no Bank Links
                  value:
                    data: []
        '400':
          $ref: '#/components/responses/RampBadRequestResponse'
        '401':
          $ref: '#/components/responses/RampUnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/RampForbiddenResponse'
        '429':
          $ref: '#/components/responses/RampResourceExhaustedResponse'
        '500':
          $ref: '#/components/responses/RampInternalResponse'
        '501':
          $ref: '#/components/responses/RampUnimplementedResponse'
        '503':
          $ref: '#/components/responses/RampUnavailableResponse'
        '504':
          $ref: '#/components/responses/RampDeadlineExceededResponse'
      security:
        - ApiKey: []
          ApiSign: []
          ApiTimestamp: []
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      example: WVSD33HRMGSZUBM7
      schema:
        $ref: '#/components/schemas/AccountId'
    PageToken:
      name: page_token
      in: query
      description: >-
        Opaque token returned as `next_page_token` in the previous response.
        Omit to request the first page.
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 256
      style: form
      example: MjoyRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4
  headers:
    TraceId:
      description: Trace identifier for the request. Include it when contacting support.
      schema:
        type: string
        example: 4bf92f3577b34da6a3ce929d0e0e4736
    StrictTransportSecurity:
      description: Enforces HTTPS for the duration specified by `max-age`.
      schema:
        type: string
        example: max-age=31536000; includeSubDomains; preload
    CacheControl:
      description: Prevents caching of sensitive financial data. Always `no-store`.
      schema:
        type: string
        enum:
          - no-store
        example: no-store
  schemas:
    Ramp_BankLink:
      description: A provider-neutral linking operation and persistent bank connection.
      type: object
      properties:
        bank_link_id:
          description: Opaque public bank-link id.
          type: string
        method_id:
          description: Funding method this Bank Link was created for.
          type: string
        status:
          description: Current lifecycle state of the Bank Link.
          type: string
          enum:
            - pending
            - activating
            - linked
            - expired
            - unlinked
          title: BankLinkStatus
        next_action:
          description: How the partner completes the link while it is `pending`.
          type: object
          properties:
            type:
              type: string
              enum:
                - hosted_link
              title: NextActionType
            widget_url:
              description: >-
                Kraken-hosted widget URL. Not a Plaid URL and carries no Plaid
                Link token.
              type: string
            expires_at:
              $ref: '#/components/schemas/DateTime'
              description: Time at which the hosted-link action expires.
          title: NextAction
          required:
            - type
            - widget_url
        institution:
          description: >-
            Display-safe institution details. Provider account and item
            references are never exposed.
          type: object
          properties:
            name:
              description: Institution display name.
              type: string
              minLength: 1
              maxLength: 256
          title: Institution
          required:
            - name
        account_links:
          description: Account Links owned by this Bank Link.
          type: array
          items:
            description: A provider-neutral account linked under one Bank Link.
            type: object
            properties:
              account_link_id:
                description: Opaque public account-link id.
                type: string
              account_last4:
                description: The account's last four digits, safe to display.
                type: string
              status:
                type: string
                enum:
                  - active
                  - removed
                title: AccountLinkStatus
              eligible_rails:
                description: >-
                  Rails this account can currently use. Values are
                  provider-neutral method identifiers such as `ach`, `rtp`, or
                  `rfp`.
                type: array
                items:
                  type: string
              ineligibility_reasons:
                description: >-
                  Safe reasons why no rail is eligible. Empty when at least one
                  rail is eligible or eligibility has not yet been evaluated.
                type: array
                items:
                  type: string
              eligibility_status:
                $ref: '#/components/schemas/Ramp_AccountEligibilityStatus'
                description: >-
                  Whether this account can move money, from its own ownership
                  validation and rail capability. Always present, and consistent
                  with this account's `eligible_rails` and
                  `ineligibility_reasons`.
              rail_limits:
                $ref: '#/components/schemas/Ramp_RailLimits'
                description: Published limits for individual rails on this account.
            title: AccountLink
            required:
              - account_link_id
              - account_last4
              - status
              - eligibility_status
        accounts_eligibility_status:
          description: >-
            Whether any Account Link under this Bank Link can move money: the
            fold of the accounts' own `eligibility_status`. Always present.
            `eligible` means at least one account is eligible. `ineligible`
            means every account is conclusively ruled out, as a link that
            finished linking without a single account vacuously is. `unknown`
            means no account is confirmed eligible while at least one is still
            inconclusive, because its ownership or its rails were not evaluated.
            A `pending` link has no accounts to evaluate yet, so it reports
            `unknown` rather than the denial `ineligible` would be.
          type: string
          enum:
            - eligible
            - ineligible
            - unknown
          title: AccountsEligibilityStatus
        not_linked_accounts:
          description: >-
            Accounts the user selected at the provider that could not be linked
            under this Bank Link. They hold no `account_link_id`, are excluded
            from `account_links` and from `accounts_eligibility_status`, and can
            never move money. Surfaced so a partner can tell the user that an
            account they picked was left out. Absent or empty when every
            selected account linked.
          type: array
          items:
            description: An account selected at the provider that could not be linked.
            type: object
            properties:
              account_last4:
                description: >-
                  The account's last four digits, safe to display. May be empty
                  when the provider reported none.
                type: string
              reason:
                description: >-
                  Safe reason the account could not be linked. Known values are
                  `missing_identity` means the provider could not verify the
                  account holder's identity for this account. `missing_balance`
                  means the provider could not read the account's balance;
                  `unknown` is also possible. New reasons may be introduced over
                  time; treat any unrecognized value as `unknown`.
                type: string
            title: NotLinkedAccount
            required:
              - account_last4
              - reason
        linked_at:
          $ref: '#/components/schemas/DateTime'
          description: >-
            When the connection became active. Absent until the link finishes
            linking.
        expires_at:
          $ref: '#/components/schemas/DateTime'
          description: >-
            When the connection is due to expire, if the provider has reported
            an expiry.
      title: BankLink
      required:
        - bank_link_id
        - method_id
        - status
        - accounts_eligibility_status
    AccountId:
      description: Globally unique public identifier for an account.
      type: string
      minLength: 14
      maxLength: 42
    DateTime:
      description: RFC 3339 timestamp.
      type: string
      format: date-time
    Ramp_AccountEligibilityStatus:
      description: >-
        Whether one Account Link can move money, from the two checks it is
        subject to. `eligible` means its owner is validated and at least one
        rail is known. `ineligible` means a check ruled it out, or the account
        is no longer linked. `unknown` means a check could not answer or has not
        run.
      type: string
      enum:
        - eligible
        - ineligible
        - unknown
    Ramp_RailLimits:
      description: Published limits keyed by their provider-neutral rail identifier.
      type: object
      properties:
        rfp:
          $ref: '#/components/schemas/Ramp_RailLimit'
          description: >-
            Request for Payment limit. Absent when no valid published ceiling is
            available.
    BadRequestError:
      title: Bad Request
      description: Request validation failed or the request could not be processed.
      oneOf:
        - title: Bad Request
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          enum:
                            - bad_request
        - title: Gateway
          description: >-
            Gateway-level validation failure returned before the request reaches
            the service.
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          const: gateway
    UnauthenticatedError:
      title: Unauthenticated
      description: Authentication credentials are missing, invalid, or not accepted.
      oneOf:
        - title: Unauthenticated
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          enum:
                            - unauthenticated
        - title: Gateway
          description: Authentication failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          const: gateway
    ForbiddenError:
      title: Forbidden
      description: The caller is not allowed to perform this operation.
      oneOf:
        - title: Forbidden
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          enum:
                            - forbidden
        - title: Gateway
          description: Authorization failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          const: gateway
    ResourceExhaustedError:
      description: The request was rate limited or a resource quota was exhausted.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 429
                    code:
                      type: string
                      enum:
                        - resource_exhausted
    InternalError:
      description: An unexpected server-side error occurred.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 500
                    code:
                      type: string
                      enum:
                        - internal
    UnimplementedError:
      description: The requested operation is not implemented.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 501
                    code:
                      type: string
                      enum:
                        - unimplemented
    UnavailableError:
      description: The service is temporarily unavailable.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 503
                    code:
                      type: string
                      enum:
                        - unavailable
    DeadlineExceededError:
      description: The request deadline was exceeded before a response could be produced.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 504
                    code:
                      type: string
                      enum:
                        - deadline_exceeded
    Ramp_RailLimit:
      description: A provider-published limit for one transfer rail.
      type: object
      properties:
        max_daily_amount:
          description: >-
            Provider-published total daily ceiling in USD. This is not the
            account's remaining daily headroom and does not guarantee that a
            transfer up to this amount will be accepted.
          type: string
          pattern: ^[0-9]+(\.[0-9]+)?$
          minLength: 1
          maxLength: 64
      required:
        - max_daily_amount
    PwsValidationErrorEnvelope:
      description: Error envelope for request validation failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsValidationError'
          description: Validation error details.
    PwsValidationError:
      description: Standard PWS API error object for request validation failures.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
        causes:
          description: Validation failures that contributed to the error.
          type: array
          items:
            $ref: '#/components/schemas/PwsErrorCause'
    PwsGeneralErrorEnvelope:
      description: Error envelope for operational or domain failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsGeneralError'
          description: General error details.
    PwsGeneralError:
      description: Standard PWS API error object for non-validation failures.
      allOf:
        - $ref: '#/components/schemas/PwsErrorBase'
        - type: object
          properties:
            causes:
              description: Additional error details, when present.
              type: array
              items:
                type: object
                additionalProperties: true
    PwsErrorCause:
      description: A single request validation failure.
      type: object
      required:
        - field
        - message
      properties:
        field:
          description: Dot-notation path to the offending request field.
          type: string
        message:
          description: Human-readable explanation of the failed validation rule.
          type: string
    PwsErrorBase:
      description: Common fields present on every PWS API error object.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
  responses:
    RampBadRequestResponse:
      description: Validation error
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            bad-request:
              value:
                error:
                  type: validation_error
                  status: 400
                  instance: req_123
                  code: bad_request
    RampUnauthenticatedResponse:
      description: Authentication required
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthenticatedError'
          examples:
            unauthenticated:
              value:
                error:
                  type: authentication_error
                  status: 401
                  instance: req_123
                  code: unauthenticated
    RampForbiddenResponse:
      description: Forbidden
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
          examples:
            forbidden:
              value:
                error:
                  type: authorization_error
                  status: 403
                  instance: req_123
                  code: forbidden
    RampResourceExhaustedResponse:
      description: Rate limit exceeded
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceExhaustedError'
          examples:
            resource-exhausted:
              value:
                error:
                  type: rate_limit_error
                  status: 429
                  instance: req_123
                  code: resource_exhausted
    RampInternalResponse:
      description: Internal server error
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalError'
          examples:
            internal-error:
              value:
                error:
                  type: internal_error
                  status: 500
                  instance: req_123
                  code: internal
    RampUnimplementedResponse:
      description: Not implemented
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnimplementedError'
          examples:
            unimplemented:
              value:
                error:
                  type: api_error
                  status: 501
                  instance: req_123
                  code: unimplemented
    RampUnavailableResponse:
      description: Service unavailable
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnavailableError'
          examples:
            unavailable:
              value:
                error:
                  type: service_error
                  status: 503
                  instance: req_123
                  code: unavailable
    RampDeadlineExceededResponse:
      description: Deadline exceeded
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeadlineExceededError'
          examples:
            deadline-exceeded:
              value:
                error:
                  type: service_error
                  status: 504
                  instance: req_123
                  code: deadline_exceeded
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: API-Key
      description: Your public API key. Identifies the partner making the request.
    ApiSign:
      type: apiKey
      in: header
      name: API-Sign
      description: HMAC signature over the request, computed with your API secret.
    ApiTimestamp:
      type: apiKey
      in: header
      name: API-Timestamp
      description: >-
        Time the request was signed, as Unix milliseconds. Included in the
        request signature. Requests signed too far from the server's time are
        rejected.

````