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

# Simulate Wire

> Simulates a wire scenario in sandbox. Set `scenario` to choose what happens; each scenario takes the fields listed in its request shape. Available in Sandbox only.

> [!NOTE]
>
> See [Errors](https://docs.lead.bank/api-reference/using-the-api/errors-v2.md) for the common errors every v2 endpoint can return.


## OpenAPI

````yaml https://docs.lead.bank/openapi.json POST /v2/simulate/wires
openapi: 3.0.1
info:
  title: Lead Bank
  description: Lead Bank's APIs
  version: v1.0
servers:
  - url: https://api.sandbox.lead.bank
  - url: https://api.lead.bank
security:
  - bearerAuth: []
tags:
  - name: ACH
  - name: Account Number
  - name: OAuth
  - name: Events
  - name: Instant Payments
  - name: Lending
  - name: Simulation
  - name: Internal Transfer
  - name: Disbursement
  - name: Entity
  - name: Wire
  - name: Originator
  - name: Funding
  - name: Receivable Sale
  - name: Balances
  - name: Compliance
  - name: Application
  - name: User Account
  - name: Blockchain Payment
  - name: Core Account
  - name: Core Balance
  - name: Core Transaction
  - name: Event Subscription
  - name: Receivable
  - name: User Credit Transaction
  - name: Files
paths:
  /v2/simulate/wires:
    post:
      tags:
        - Simulation
      summary: Simulate Wire V2
      description: >-
        Simulates a wire scenario in sandbox. Set `scenario` to choose what
        happens; each scenario takes the fields listed in its request shape.
        Available in Sandbox only.
      operationId: simulate-wire-v2
      parameters:
        - name: Idempotency-Key
          in: header
          description: Idempotency key
          required: true
          schema:
            type: string
            maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateWireRequestV2'
      responses:
        '200':
          description: The simulation was accepted. The response body is empty.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulateResponse'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '403':
          $ref: '#/components/responses/ErrorForbidden'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '409':
          $ref: '#/components/responses/ErrorConflict'
        '422':
          description: >-
            The wire can't take this scenario, or one or more parameters failed
            validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: parameters_invalid
                message: One or more parameters are invalid. See errors for each one.
                errors:
                  - code: schema_violation
                    message: >-
                      debtor_agent.local_routing_identifier.value isn't a valid
                      ABA routing number.
                    parameters:
                      - debtor_agent.local_routing_identifier.value
        '429':
          $ref: '#/components/responses/ErrorTooManyRequests'
        '500':
          $ref: '#/components/responses/ErrorInternal'
        '503':
          $ref: '#/components/responses/ErrorServiceUnavailable'
        '504':
          $ref: '#/components/responses/ErrorGatewayTimeout'
components:
  schemas:
    SimulateWireRequestV2:
      type: object
      description: >-
        The wire scenario to simulate in sandbox. `scenario` selects which of
        the request shapes below applies.
      oneOf:
        - $ref: '#/components/schemas/SimulateIncomingWireRequestV2'
        - $ref: '#/components/schemas/SimulateIncomingWireReturnRequestV2'
        - $ref: '#/components/schemas/SimulateIncomingReturnRequestRequestV2'
        - $ref: '#/components/schemas/SimulateOutgoingReturnRequestAcceptedRequestV2'
        - $ref: '#/components/schemas/SimulateOutgoingReturnRequestRejectedRequestV2'
      discriminator:
        propertyName: scenario
        mapping:
          incoming_payment: '#/components/schemas/SimulateIncomingWireRequestV2'
          incoming_return: '#/components/schemas/SimulateIncomingWireReturnRequestV2'
          incoming_return_request: '#/components/schemas/SimulateIncomingReturnRequestRequestV2'
          outgoing_return_request_accepted: '#/components/schemas/SimulateOutgoingReturnRequestAcceptedRequestV2'
          outgoing_return_request_rejected: '#/components/schemas/SimulateOutgoingReturnRequestRejectedRequestV2'
    SimulateResponse:
      type: object
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: >-
            A human-readable description of the error family. Identical for
            every occurrence of a given `code`; carries no request-specific
            detail.
          example: One or more parameters are invalid.
        errors:
          type: array
          description: >-
            Zero or more specific errors within this family. Always present for
            validation errors, one entry per failing field.
          items:
            $ref: '#/components/schemas/ErrorItem'
    SimulateIncomingWireRequestV2:
      title: Incoming payment
      type: object
      description: >-
        Simulates an incoming wire. The wire is created in `posted`.
        `debtor_agent` must match `corridor_type`: a domestic wire takes a
        9-digit `local_routing_identifier` and no `business_identifier_code`; an
        international wire takes a non-US `business_identifier_code`.
      required:
        - scenario
        - corridor_type
        - amount
        - creditor_account_number_id
        - debtor
        - debtor_agent
      properties:
        scenario:
          type: string
          description: Creates an incoming wire in `posted`.
          enum:
            - incoming_payment
          example: incoming_payment
        corridor_type:
          $ref: '#/components/schemas/CorridorType'
          description: Whether to simulate a domestic or an international wire.
        amount:
          $ref: '#/components/schemas/WireAmount'
          description: Wire amount in USD cents.
        creditor_account_number_id:
          $ref: '#/components/schemas/AccountNumberID'
          description: The ID of the account number that will receive the simulated wire.
        debtor:
          $ref: '#/components/schemas/SimulateWireDebtorRequestV2'
          description: The party sending the wire.
        debtor_agent:
          $ref: '#/components/schemas/SimulateWireDebtorAgentRequest'
          description: The debtor's financial institution.
        instructing_agent:
          $ref: '#/components/schemas/SimulateWireInstructingAgentRequest'
          description: >-
            The financial institution that transmitted the payment to Lead.
            Defaults to the debtor agent for a domestic wire and to Deutsche
            Bank Trust Company Americas (routing number 021001033) for an
            international wire.
        remittance_details:
          type: object
          description: Details of the remittance information for the wire.
          properties:
            message_to_creditor:
              type: string
              description: Information intended specifically for the creditor.
              example: Payment for invoice 12345
              maxLength: 140
              pattern: >-
                ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
                !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
                !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
        payment_identifiers:
          type: object
          description: Payment identifiers for the wire.
          properties:
            end_to_end_identification:
              type: string
              description: >-
                Unique identification that the initiating party in a wire
                message can use to unambiguously identify the transaction. This
                is passed through, unchanged, throughout the entire wire chain.
              maxLength: 35
              pattern: ^[ \w/\-\?:\(\)\.,'\+!@#$%^&\*=`\{\|\}~";<>\[\\\]]*$
              example: EndtoEnd12345
    SimulateIncomingWireReturnRequestV2:
      title: Incoming return
      type: object
      description: >-
        Simulates an incoming return wire against an outgoing wire. The return
        wire is created in `posted`.
      required:
        - scenario
        - wire_id
        - reason
      properties:
        scenario:
          type: string
          description: Creates an incoming return wire in `posted`.
          enum:
            - incoming_return
          example: incoming_return
        wire_id:
          type: string
          description: >-
            ID of the outgoing wire (or outgoing return wire) you want to
            return.
          pattern: ^wire_\w+$
          example: wire_xyz001
        amount:
          $ref: '#/components/schemas/WireAmount'
          description: Amount to return in USD cents. Defaults to the full wire amount.
        reason:
          $ref: '#/components/schemas/WireReturnReasonV2'
          description: Return reason code.
        details:
          type: string
          description: >-
            Additional details about why the wire is being returned. Required
            when `reason` is `narrative`.
          minLength: 1
          maxLength: 105
          pattern: >-
            ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
    SimulateIncomingReturnRequestRequestV2:
      title: Incoming return request
      type: object
      description: >-
        Simulates an incoming return request against an incoming wire. The
        return request is created in `response_needed`.
      required:
        - scenario
        - wire_id
        - reason
      properties:
        scenario:
          type: string
          description: Creates an incoming return request in `response_needed`.
          enum:
            - incoming_return_request
          example: incoming_return_request
        wire_id:
          type: string
          description: >-
            ID of the incoming wire you want to simulate an incoming return
            request against.
          pattern: ^wire_\w+$
          example: wire_xyz001
        reason:
          $ref: '#/components/schemas/WireReturnRequestReason'
        details:
          type: string
          description: >-
            Free-text explanation included with the simulated request. Required
            when `reason` is `narrative`.
          minLength: 1
          maxLength: 105
          pattern: >-
            ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
    SimulateOutgoingReturnRequestAcceptedRequestV2:
      title: Outgoing return request accepted
      type: object
      description: >-
        Simulates the counterparty accepting your outgoing return request. The
        return request moves to `accepted` for the full wire amount; no return
        wire is created.
      required:
        - scenario
        - wire_id
      properties:
        scenario:
          type: string
          description: Moves the outgoing return request to `accepted`.
          enum:
            - outgoing_return_request_accepted
          example: outgoing_return_request_accepted
        wire_id:
          type: string
          description: >-
            ID of the wire whose outgoing return request you want to simulate an
            acceptance of.
          pattern: ^wire_\w+$
          example: wire_xyz001
    SimulateOutgoingReturnRequestRejectedRequestV2:
      title: Outgoing return request rejected
      type: object
      description: >-
        Simulates the counterparty rejecting your outgoing return request. The
        return request moves to `rejected`.
      required:
        - scenario
        - wire_id
        - reason
      properties:
        scenario:
          type: string
          description: Moves the outgoing return request to `rejected`.
          enum:
            - outgoing_return_request_rejected
          example: outgoing_return_request_rejected
        wire_id:
          type: string
          description: >-
            ID of the wire whose outgoing return request you want to simulate a
            rejection of.
          pattern: ^wire_\w+$
          example: wire_xyz001
        reason:
          $ref: '#/components/schemas/WireReturnRequestRejectionReason'
        details:
          type: string
          description: >-
            Free-text explanation included with the simulated rejection.
            Required when `reason` is `narrative`.
          minLength: 1
          maxLength: 105
          pattern: >-
            ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
    ErrorCode:
      type: string
      description: >-
        A snake_case code identifying the error family — the stable,
        machine-readable value partners branch on, together with the HTTP
        status.
      example: parameters_invalid
      enum:
        - request_malformed
        - content_too_large
        - headers_invalid
        - unsupported_media_type
        - authentication_missing
        - token_invalid
        - source_ip_not_permitted
        - url_invalid
        - object_not_found
        - method_not_allowed
        - idempotency_key_in_use
        - idempotency_request_mismatched
        - rate_limit_exceeded
        - internal_server_error
        - service_unavailable
        - endpoint_disabled
        - gateway_timeout
        - parameters_invalid
        - related_object_invalid
        - related_object_not_ready
        - related_object_incompatible
        - limit_exceeded
        - partner_control_restricted
        - lead_control_restricted
        - object_state_mismatched
        - object_modified_concurrently
        - operation_invalid
    ErrorItem:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: A snake_case code naming the specific error or sub-category.
          example: schema_violation
        message:
          type: string
          description: >-
            A human-readable description of this specific error, with
            interpolated values where relevant.
          example: account_number_id is required.
        parameters:
          type: array
          description: >-
            The request fields that caused this error, as `jq` paths without the
            leading dot. For example, a nested field is `address.city` and an
            array item is `beneficial_owners[1].ownership`. A key with
            characters other than letters, digits, and underscores is
            JSON-quoted, like `metadata["order.id"]`. Headers appear by name,
            like `Idempotency-Key`. Present for validation errors.
          items:
            type: string
          example:
            - account_number_id
    CorridorType:
      type: string
      description: >-
        Indicates whether the wire is domestic or international based on the
        banks included in the wire message. A wire is international if any bank
        in the payment chain is located outside the U.S.; otherwise, it is
        classified as domestic.
      example: domestic
      enum:
        - domestic
        - international
    WireAmount:
      description: The amount of the wire transaction in cents.
      type: integer
      format: int64
      example: 5000
      minimum: 1
      maximum: 990000000000
    AccountNumberID:
      type: string
      description: The ID of the Lead Bank Account Number object.
      example: account_number_xyz123
      pattern: ^account_number_\w+$
    SimulateWireDebtorRequestV2:
      type: object
      description: The party sending the wire.
      required:
        - name
        - account_identifier
        - address
      properties:
        name:
          type: string
          description: Name of the sending party.
          minLength: 1
          maxLength: 140
          pattern: >-
            ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
          example: Alex Smith
        account_identifier:
          type: object
          description: Account identifier of the sending party.
          required:
            - type
            - value
          properties:
            type:
              type: string
              description: Type of account identifier.
              enum:
                - account_number
                - iban
              example: account_number
            value:
              type: string
              description: Account identifier value of the sending party.
              minLength: 1
              maxLength: 34
              pattern: ^[a-zA-Z0-9 ]*[a-zA-Z0-9]+$
              example: '1032345678'
        address:
          $ref: '#/components/schemas/WirePostalAddressRequestV2'
          description: Postal address of the sending party.
    SimulateWireDebtorAgentRequest:
      type: object
      description: The debtor's financial institution.
      properties:
        local_routing_identifier:
          $ref: '#/components/schemas/LocalRoutingIdentifierRequest'
          description: >-
            Routing or transit code used by the financial institution's local
            clearing system. For

            domestic wires, this is always a US ABA routing number. For
            international wires, this may be

            another local clearing code.
        business_identifier_code:
          type: string
          description: >-
            Business Identifier Code (BIC) of the financial institution. A
            foreign financial

            institution's BIC is required to simulate an international wire.
          minLength: 8
          maxLength: 11
          pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$
          example: DEUTDEDB
    SimulateWireInstructingAgentRequest:
      type: object
      description: The financial institution that transmitted the payment to Lead.
      properties:
        local_routing_identifier:
          $ref: '#/components/schemas/LocalRoutingIdentifierRequest'
          description: >-
            Routing or transit code used to identify the instructing agent
            within a local clearing system.
    WireReturnReasonV2:
      type: string
      description: The reason for returning the wire.
      example: creditor_request
      enum:
        - account_blocked
        - wrong_amount
        - creditor_name_mismatch
        - honor_return_request
        - fraud_suspected
        - creditor_request
        - narrative
        - missing_debtor_data
        - missing_creditor_data
    WireReturnRequestReason:
      type: string
      description: >-
        Reason for the return request.


        - `creditor_account_number_invalid` — ISO `AC03`. Wire was sent to the
        wrong account number.

        - `wrong_amount` — ISO `AM09`. Wire amount is not the agreed amount or
        expected.

        - `customer_requested` — ISO `CUST`. The partner's end customer
        requested the return.

        - `duplication` — ISO `DUPL`. Duplicate wire sent.

        - `fraud_suspected` — ISO `FRAD`. Fraud suspected.

        - `narrative` — ISO `NARR`. Catch-all when no structured reason fits;
        details field carries the explanation.

        - `technical_problem` — ISO `TECH`. A technical issue caused the wire to
        be sent.

        - `undue_payment` — ISO `UPAY`. Payment was not due or for services not
        performed.

        - `per_agent_request` — ISO `AGNT`. Incoming only — Lead is the agent
        for outgoing payments.

        - `other` — Incoming only. Catch-all for unmapped ISO codes received
        from the counterparty.
      enum:
        - creditor_account_number_invalid
        - wrong_amount
        - customer_requested
        - duplication
        - fraud_suspected
        - narrative
        - technical_problem
        - undue_payment
        - per_agent_request
        - other
    WireReturnRequestRejectionReason:
      type: string
      description: >-
        Reason the return request was rejected.


        - `account_closed` — ISO `AC04`.

        - `non_sufficient_funds` — ISO `AM04`.

        - `customer_requested` — ISO `CUST`. Customer declined the return.

        - `legal_decision` — ISO `LEGL`.

        - `customer_no_response` — ISO `NOAS`. Customer did not respond by the
        deadline.

        - `returned_previously` — ISO `ARDT`. Wire already fully returned.
        Auto-set by Lead when applicable.

        - `narrative` — ISO `NARR`. Catch-all; details field carries the
        explanation.

        - `per_agent_request` — ISO `AGNT`. Incoming only.

        - `other` — Incoming only. Catch-all for unmapped ISO codes received
        from the counterparty.
      enum:
        - account_closed
        - non_sufficient_funds
        - customer_requested
        - legal_decision
        - customer_no_response
        - returned_previously
        - narrative
        - per_agent_request
        - other
    WirePostalAddressRequestV2:
      type: object
      description: >-
        Hybrid ISO 20022 postal address. `country` and `town_name` are required;
        up to two

        unstructured lines plus the structured fields are otherwise optional.
      required:
        - country
        - town_name
      properties:
        line_1:
          type: string
          description: Line one of the address in unstructured format.
          maxLength: 70
          pattern: >-
            ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
          example: 123 Main St
        line_2:
          type: string
          description: Line two of the address in unstructured format.
          maxLength: 70
          pattern: >-
            ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
          example: Suite 100
        town_name:
          type: string
          description: >-
            Name of a built-up area, with defined boundaries, and a local
            government.
          minLength: 1
          maxLength: 35
          pattern: >-
            ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
          example: Kansas City
        country_sub_division:
          type: string
          description: >-
            Identifies a subdivision of a country such as a state, region, or
            county.
          maxLength: 35
          pattern: >-
            ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
          example: MO
        post_code:
          type: string
          description: >-
            Identifier of letters and/or numbers added to a postal address to
            assist mail sorting.
          maxLength: 16
          pattern: >-
            ^[0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*[0-9a-zA-Z/\-\?:\(\)\.,'\+!@#$%^&\*=_`\{\|\}~";<>\[\\\]][0-9a-zA-Z/\-\?:\(\)\.,'\+
            !@#$%^&\*=_`\{\|\}~";<>\[\\\]]*$
          example: '64105'
        country:
          type: string
          description: >-
            ISO 3166-1 alpha-2 code representing a nation with its own
            government.
          pattern: ^[A-Z]{2}$
          example: US
    LocalRoutingIdentifierRequest:
      type: object
      description: >-
        Routing or transit code used by the creditor agent's local clearing
        system for international wire transfers, such as a sort code, IFSC, or
        BSB. This field may be required for certain destinations.
      properties:
        value:
          type: string
          description: The value of the local routing identifier.
          minLength: 1
          maxLength: 35
          example: '123456'
  responses:
    ErrorBadRequest:
      x-api-version: v2
      description: >-
        The request could not be parsed (e.g. a body that is not valid JSON, or
        a malformed URL or query string).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: request_malformed
            message: The request is invalid and cannot be parsed by the server.
    ErrorForbidden:
      x-api-version: v2
      description: Invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: token_invalid
            message: >-
              Your bearer token is expired, invalid, or lacks required scopes.
              Get a new token.
    ErrorNotFound:
      x-api-version: v2
      description: The requested object does not exist or is not visible to the caller.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: object_not_found
            message: >-
              The requested object does not exist or is not visible to this
              caller.
    ErrorConflict:
      x-api-version: v2
      description: >-
        The request conflicts with a prior request or with the current state of
        the object (e.g. idempotency key reuse, or an object state that does not
        permit the operation).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: object_state_mismatched
            message: The object is not in a state that permits this operation.
    ErrorTooManyRequests:
      x-api-version: v2
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: rate_limit_exceeded
            message: >-
              You have exceeded the rate limit for this endpoint. Retry after
              the limit resets.
    ErrorInternal:
      x-api-version: v2
      description: Something went wrong on Lead's side.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: internal_server_error
            message: >-
              Something went wrong on our end. Contact Lead with the Request-Id
              if this persists.
    ErrorServiceUnavailable:
      x-api-version: v2
      description: >-
        The endpoint is temporarily disabled (e.g. a migration cutover). Retry
        after a delay.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: endpoint_disabled
            message: >-
              This endpoint is temporarily disabled. Retry after the indicated
              delay.
    ErrorGatewayTimeout:
      x-api-version: v2
      description: An upstream system (the core) timed out. Retry with backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: gateway_timeout
            message: An upstream system timed out. Retry with backoff.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````