Weavr Correspondent Bank Transfers API

openapi: 3.2.0
info:
  title: Weavr Correspondent Bank Transfers API
  contact:
    name: Weavr
    url: https://weavr.io
  x-logo:
    url: https://storage.googleapis.com/weavr-cdn/weavr_logo-new.png
    backgroundColor: '#FFFFFF'
    altText: Weavr
  version: '1.0'
  description: 'Operations tagged Correspondent Bank Transfers across 2 of this provider''s published API definitions: weavr-multi-openapi-original.yml, weavr-webhooks-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Weavr Sandbox Environment
  url: https://sandbox.weavr.io/multi
- url: '""'
tags:
- name: Correspondent Bank Transfers
  description: 'Correspondent bank transfers allow financial institutions to initiate wire transfers on behalf of originators (third parties).

    These transfers comply with travel rule requirements by capturing and transmitting originator information.

    '
paths:
  /correspondent_bank_transfers:
    post:
      tags:
      - Correspondent Bank Transfers
      summary: Create a correspondent bank transfer
      operationId: correspondentBankTransferCreate
      description: 'Creates an outgoing wire transfer on behalf of an originator (correspondent banking).


        This endpoint is designed for correspondent banking use cases where a financial institution

        initiates a wire transfer on behalf of another party (the originator).


        The Outgoing Wire Transfer Profile (configured in the Multi Portal) specified determines the behaviour

        and restrictions of the transaction (for example, fees).

        '
      parameters:
      - $ref: '#/components/parameters/idempotency-ref'
      requestBody:
        $ref: '#/components/requestBodies/CorrespondentBankingOwtCreateRequest'
      responses:
        '200':
          $ref: '#/components/responses/CorrespondentBankingOwtResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/CorrespondentBankingOwtCreateConflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        default:
          $ref: '#/components/responses/Error'
      security:
      - auth_token: []
        api-key: []
    get:
      tags:
      - Correspondent Bank Transfers
      description: Retrieves all correspondent bank transfer transactions.
      summary: Get all correspondent bank transfer transactions
      operationId: correspondentBankTransfersGet
      parameters:
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/sourceInstrument_id'
      - $ref: '#/components/parameters/sourceInstrument_type'
      - name: createdFrom
        in: query
        required: false
        description: Filter for correspondent bank transfer transactions created after `createdFrom` timestamp, expressed in Epoch timestamp using millisecond precision.
        schema:
          type: integer
          format: int64
      - name: createdTo
        in: query
        required: false
        description: Filter for correspondent bank transfer transactions created before `createdTo` timestamp, expressed in Epoch timestamp using millisecond precision.
        schema:
          type: integer
          format: int64
      - name: executedFrom
        in: query
        required: false
        description: Filter for correspondent bank transfer transactions executed after `executedFrom` timestamp, expressed in Epoch timestamp using millisecond precision.
        schema:
          type: integer
          format: int64
      - name: executedTo
        in: query
        required: false
        description: Filter for correspondent bank transfer transactions executed before `executedTo` timestamp, expressed in Epoch timestamp using millisecond precision.
        schema:
          type: integer
          format: int64
      - name: tag
        in: query
        required: false
        description: Filter by the correspondent bank transfer tag. The exact tag must be provided, as wildcards are not supported.
        schema:
          type: string
      - name: state
        in: query
        required: false
        description: Filter by the state of the correspondent bank transfer transaction.
        schema:
          type: array
          items:
            $ref: '#/components/schemas/CorrespondentBankingOwtState'
      - name: originator.name
        in: query
        required: false
        description: Filter by the originator name. Partial matches are supported.
        schema:
          type: string
      - name: originator.type
        in: query
        required: false
        description: Filter by the originator type.
        schema:
          type: string
          enum:
          - INDIVIDUAL
          - BUSINESS
      - name: originator.tag
        in: query
        required: false
        description: Filter by the originator tag.
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/CorrespondentBankingOwtsResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - auth_token: []
        api-key: []
    servers:
    - description: Weavr Sandbox Environment
      url: https://sandbox.weavr.io/multi
  /correspondent_bank_transfers/{id}:
    get:
      tags:
      - Correspondent Bank Transfers
      description: Retrieves the correspondent bank transfer identified by the `id` path parameter.
      summary: Get a correspondent bank transfer transaction
      operationId: correspondentBankTransferGet
      parameters:
      - name: id
        in: path
        required: true
        description: The unique identifier of the correspondent bank transfer transaction.
        schema:
          type: string
          pattern: ^[0-9]+$
      responses:
        '200':
          $ref: '#/components/responses/CorrespondentBankingOwtResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - auth_token: []
        api-key: []
    servers:
    - description: Weavr Sandbox Environment
      url: https://sandbox.weavr.io/multi
  /correspondent_bank_transfers/{id}/cancel:
    post:
      tags:
      - Correspondent Bank Transfers
      description: Cancel the correspondent bank transfer identified by the `id` path parameter.
      summary: Cancel a correspondent bank transfer transaction
      operationId: correspondentBankTransferCancel
      parameters:
      - name: id
        in: path
        required: true
        description: The unique identifier of the correspondent bank transfer transaction.
        schema:
          type: string
          pattern: ^[0-9]+$
      requestBody:
        $ref: '#/components/requestBodies/TransactionSingleCancelRequest'
      responses:
        '200':
          $ref: '#/components/responses/CorrespondentBankingOwtResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/CorrespondentBankingOwtCancelConflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - auth_token: []
        api-key: []
    servers:
    - description: Weavr Sandbox Environment
      url: https://sandbox.weavr.io/multi
  /correspondent_bank_transfers/{id}/confirm:
    post:
      tags:
      - Correspondent Bank Transfers
      description: Confirm the correspondent bank transfer identified by the `id` path parameter.
      summary: Confirm a correspondent bank transfer transaction
      operationId: correspondentBankTransferConfirm
      parameters:
      - name: id
        in: path
        required: true
        description: The unique identifier of the correspondent bank transfer transaction.
        schema:
          type: string
          pattern: ^[0-9]+$
      responses:
        '200':
          $ref: '#/components/responses/CorrespondentBankingOwtResponse'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/CorrespondentBankingOwtConfirmConflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
      - auth_token: []
        api-key: []
    servers:
    - description: Weavr Sandbox Environment
      url: https://sandbox.weavr.io/multi
webhooks:
  /correspondent_bank_transfers/watch:
    post:
      tags:
      - Correspondent Bank Transfers
      summary: Correspondent Bank Transfer transaction
      description: Notification that a Correspondent Bank Transfer has been processed.
      operationId: correspondent_bank_transfers_watch
      parameters:
      - $ref: '#/components/parameters/call-ref'
      - $ref: '#/components/parameters/published-timestamp'
      - $ref: '#/components/parameters/signature'
      - $ref: '#/components/parameters/signature-v2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrespondentBankTransferEvent'
        required: true
      responses:
        '204':
          description: Success - No Content
    servers:
    - url: '""'
components:
  responses:
    InternalServerError:
      description: Internal Server Error - There is a problem with the server. Please try again later.
      headers:
        request-ref:
          $ref: '#/components/headers/request-ref'
    CorrespondentBankingOwtsResponse:
      description: Success
      headers:
        request-ref:
          $ref: '#/components/headers/request-ref'
      content:
        application/json:
          schema:
            type: object
            properties:
              transfer:
                type: array
                items:
                  $ref: '#/components/schemas/CorrespondentBankingOwt'
              count:
                type: integer
                description: Total number of records (excluding the paging limit)
                format: int32
              responseCount:
                type: integer
                description: Total number of records returned in this response (always capped at 100).
                format: int32
    TooManyRequests:
      description: Too many requests.
      headers:
        request-ref:
          $ref: '#/components/headers/request-ref'
        x-ratelimit-limit:
          $ref: '#/components/headers/x-ratelimit-limit'
        x-ratelimit-reset:
          $ref: '#/components/headers/x-ratelimit-reset'
    Unauthorized:
      description: Unauthorized - Your credentials or access token are invalid.
      headers:
        request-ref:
          $ref: '#/components/headers/request-ref'
    Forbidden:
      description: Forbidden - Access to the requested resource or action is forbidden.
      headers:
        request-ref:
          $ref: '#/components/headers/request-ref'
      content:
        application/json:
          schema:
            type: object
            properties:
              errorCode:
                type: string
                enum:
                - INSUFFICIENT_PERMISSIONS
    CorrespondentBankingOwtResponse:
      description: Success
      headers:
        request-ref:
          $ref: '#/components/headers/request-ref'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CorrespondentBankingOwt'
    CorrespondentBankingOwtConfirmConflict:
      description: Conflict
      content:
        application/json:
          schema:
            type: object
            properties:
              errorCode:
                type: string
                enum:
                - INVALID_STATE
    NotFound:
      description: Not found - The requested resource couldn't be found.
      headers:
        request-ref:
          $ref: '#/components/headers/request-ref'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    CorrespondentBankingOwtCancelConflict:
      description: Conflict
      content:
        application/json:
          schema:
            type: object
            properties:
              errorCode:
                type: string
                enum:
                - INVALID_STATE
    BadRequestError:
      description: Bad Request Error - Your request is invalid.
      headers:
        request-ref:
          $ref: '#/components/headers/request-ref'
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                maxLength: 255
                type: string
                description: When present helps to identify and fix the problem.
              syntaxErrors:
                $ref: '#/components/schemas/SyntaxError'
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    CorrespondentBankingOwtCreateConflict:
      description: Conflict
      content:
        application/json:
          schema:
            type: object
            properties:
              errorCode:
                type: string
                enum:
                - PROFILE_INACTIVE
                - MODEL_CONSTRAINTS_VIOLATED
                - CURRENCY_MISMATCH
                - SOURCE_INSTRUMENT_BLOCKED
                - SOURCE_INSTRUMENT_DESTROYED
                - AMOUNT_INVALID
                - FUNDS_INSUFFICIENT
                - SOURCE_NOT_FOUND
                - FEE_NOT_CONFIGURED_FOR_CURRENCY
                - TYPE_NOT_SUPPORTED_BY_PROFILE
                - PROFILE_NOT_FOUND
                - SCHEDULED_TIMESTAMP_INVALID
                - BENEFICIARY_BANK_DETAILS_INVALID
                - ORIGINATOR_DETAILS_INVALID
                - PROVIDER_REJECTED
    ServiceUnavailable:
      description: Service Unavailable - The requested service is temporarily unavailable. Please try again later.
      headers:
        request-ref:
          $ref: '#/components/headers/request-ref'
  schemas:
    CorrespondentBankingIndividualAddressAndBirthInfo:
      required:
      - dateOfBirth
      - placeOfBirth
      type: object
      description: Birth information for an individual originator.
      properties:
        dateOfBirth:
          type: string
          format: date
          description: Date of birth in YYYY-MM-DD format.
        placeOfBirth:
          type: string
          maxLength: 140
          description: Place of birth - city and country.
    CorrespondentBankingOwtValidationOutcome:
      type: object
      required:
      - category
      - categoryResult
      properties:
        category:
          type: string
          enum:
          - SEPA_VERIFICATION_OF_PAYEE
          - UK_CONFIRMATION_OF_PAYEE
        categoryResult:
          oneOf:
          - $ref: '#/components/schemas/SEPAVerificationOfPayeeResult'
          - $ref: '#/components/schemas/UKConfirmationOfPayeeResult'
    CorrespondentBankingSEPABeneficiary:
      required:
      - name
      - iban
      - address
      type: object
      description: CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 35
          description: 'The beneficiary''s full name. >= 1 character and <= 35 characters.

            An extended character set is accepted to cater for all European languages.

            If SEPA does not support a particular character, it is automatically

            converted to an acceptable alternative, in line with SEPA scheme guidance.

            '
        iban:
          type: string
          minLength: 15
          maxLength: 34
          pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$
          description: International Bank Account Number, required for wire transfer over SEPA.
        bankIdentifierCode:
          type: string
          minLength: 8
          maxLength: 11
          pattern: ^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$
          description: BIC (Bank Identifier Code) for wire transfer over SEPA.
        address:
          maxLength: 105
          minLength: 1
          type: string
          description: 'The beneficiary''s address. Required for correspondent banking transfers.

            Maximum 105 characters (split into 3x35-char lines by the provider).

            '
        bankName:
          type: string
          maxLength: 150
          description: The beneficiary's bank name.
        bankAddress:
          maxLength: 150
          minLength: 1
          type: string
          description: The beneficiary's bank address.
        bankCountry:
          type: string
          description: The beneficiary's bank country in ISO 3166 alpha-2 format.
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
        nationality:
          $ref: '#/components/schemas/Nationality'
        dateOfBirth:
          $ref: '#/components/schemas/DateOfBirth'
    CorrespondentBankingIndividualOriginator:
      required:
      - name
      - address
      - country
      - bankAccountDetails
      type: object
      description: 'An individual (natural person) originator of the transfer.


        Travel Rule Requirements:

        - Mandatory: Full name and account number (via bankAccountDetails)

        - Mandatory: At least one supplementary information type (address + birth details, or address + official ID)

        '
      properties:
        tag:
          $ref: '#/components/schemas/Tag'
        name:
          type: string
          maxLength: 140
          description: Full name of the individual as documented on official ID.
        address:
          type: string
          maxLength: 255
          description: Full residential address of the individual.
        country:
          type: string
          minLength: 2
          maxLength: 2
          pattern: ^[A-Z]{2}$
          description: ISO 3166-1 alpha-2 country code.
        bankAccountDetails:
          $ref: '#/components/schemas/CorrespondentBankingBankAccountDetails'
          description: Account and financial institution details of the originator (travel rule mandatory).
        supplementaryInformation:
          oneOf:
          - $ref: '#/components/schemas/CorrespondentBankingIndividualAddressAndIdInfo'
          - $ref: '#/components/schemas/CorrespondentBankingIndividualAddressAndBirthInfo'
    Id:
      type: string
      pattern: ^[0-9]+$
    TransactionSingleCancelRequest:
      type: object
      properties:
        cancellationReason:
          $ref: '#/components/schemas/TransactionCancellationReason'
    CurrencyAmount:
      required:
      - currency
      - amount
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/Currency'
        amount:
          type: integer
          format: int64
          description: 'The monetary amount, scaled to the lowest denomination of the currency.


            Example, an amount of 1000 for a EUR currency is actually 1000 Euro cents or EUR 10.00.

            '
      description: The object representing a monetary amount in a particular currency.
    CorrespondentBankingOwtState:
      description: "The state of the correspondent bank transfer transaction, as follows:\n  - INVALID: The transfer has failed initial validation checks.\n  - PENDING_CHALLENGE: The transfer requires the completion of a transaction confirmation challenge before it can be submitted.\n  - SUBMITTED: The transfer has been submitted to the sending financial institution for processing.\n  - REJECTED: The transfer that was submitted was rejected.\n  - APPROVED: The transfer that was submitted has been approved and is being processed by the sending financial institution.\n  - FAILED: There was an issue with the transfer, and the transaction has failed.\n  - COMPLETED: The requested funds have been sent from the source instrument.\n  - RETURNED: The transfer has been returned to the sender.\n  - SCHEDULED: The transfer will be executed at the scheduled time.\n  - CANCELLED: The scheduled transfer has been cancelled.\n  - PENDING_CONFIRMATION: The transfer requires a manual confirmation by the user before proceeding.\n"
      type: string
      enum:
      - INVALID
      - PENDING_CHALLENGE
      - SUBMITTED
      - REJECTED
      - APPROVED
      - FAILED
      - COMPLETED
      - RETURNED
      - SCHEDULED
      - CANCELLED
      - PENDING_CONFIRMATION
    CorrespondentBankingRIXBeneficiary:
      required:
      - name
      - iban
      - address
      type: object
      description: CBT-specific beneficiary details for RIX wire transfers with Banking Circle FI-to-FI field limits.
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 35
          description: 'The beneficiary''s full name. >= 1 character and <= 35 characters.

            An extended character set is accepted to cater for all European languages.

            If RIX does not support a particular character, it is automatically

            converted to an acceptable alternative.

            '
        iban:
          type: string
          minLength: 15
          maxLength: 34
          pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$
          description: International Bank Account Number, required for wire transfer over RIX.
        bankIdentifierCode:
          type: string
          minLength: 8
          maxLength: 11
          pattern: ^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$
          description: BIC (Bank Identifier Code) for wire transfer over RIX.
        address:
          maxLength: 105
          minLength: 1
          type: string
          description: 'The beneficiary''s address. Required for correspondent banking transfers.

            Maximum 105 characters (split into 3x35-char lines by the provider).

            '
        bankName:
          type: string
          maxLength: 150
          description: The beneficiary's bank name.
        bankAddress:
          maxLength: 150
          minLength: 1
          type: string
          description: The beneficiary's bank address.
        bankCountry:
          type: string
          description: The beneficiary's bank country in ISO 3166 alpha-2 format.
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
        nationality:
          $ref: '#/components/schemas/Nationality'
        dateOfBirth:
          $ref: '#/components/schemas/DateOfBirth'
    CorrespondentBankingBankAccountDetails:
      required:
      - account
      - financialInstitution
      type: object
      description: Bank account details for the originator.
      properties:
        account:
          type: string
          minLength: 1
          maxLength: 34
          pattern: ^[a-zA-Z0-9]{1,34}$
          description: Can be either an account number or an International Bank Account Number (IBAN).
        financialInstitution:
          type: string
          minLength: 8
          maxLength: 11
          pattern: ^[a-zA-Z0-9]{8,11}$
          description: Bank Identifier Code (BIC) of the originator's financial institution.
    DateOfBirth:
      type: string
      format: date
      description: The date of birth in ISO 8601 format (YYYY-MM-DD).
    CorrespondentBankingOwtCreateRequest:
      required:
      - profileId
      - sourceInstrument
      - amount
      - originator
      - beneficiary
      - purpose
      type: object
      properties:
        profileId:
          $ref: '#/components/schemas/ProfileId'
        tag:
          $ref: '#/components/schemas/Tag'
        sourceInstrument:
          description: The managed account from which funds will be collected.
          required:
          - type
          - id
          type: object
          properties:
            type:
              type: string
              enum:
              - managed_accounts
            id:
              type: string
              pattern: ^[0-9]+$
        amount:
          description: The amount to transfer.
          $ref: '#/components/schemas/CurrencyAmount'
        originator:
          oneOf:
          - $ref: '#/components/schemas/CorrespondentBankingIndividualOriginator'
          - $ref: '#/components/schemas/CorrespondentBankingBusinessOriginator'
        beneficiary:
          oneOf:
          - $ref: '#/components/schemas/CorrespondentBankingSEPABeneficiary'
          - $ref: '#/components/schemas/CorrespondentBankingRIXBeneficiary'
          - $ref: '#/components/schemas/CorrespondentBankingFasterPaymentsBeneficiary'
        purpose:
          type: string
          maxLength: 255
          description: The purpose of the payment.
        description:
          maxLength: 35
          type: string
          description: 'These details are passed to the beneficiary as the `reference`. This field is mandatory for wire transfers executed over `SEPA`. The allowed length is dependent on the payment type:


            `SEPA` <= `35` characters. An extended character set is accepted to cater for all European languages. If `SEPA` does not support a particular character, it is automatically converted to an acceptable alternative, in line with `SEPA` scheme guidance.


            `Faster Payments` <= `18` characters

            '
        externalData:
          type: array
          description: Additional external data as key-value pairs.
          items:
            $ref: '#/components/schemas/CorrespondentBankingExternalData'
        scheduledTimestamp:
          $ref: '#/components/schemas/ScheduledTimestamp'
    SourceInstrumentType:
      type: string
      enum:
      - managed_accounts
    SyntaxError:
      type: object
      description: Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.
      properties:
        invalidFields:
          type: array
          items:
            type: object
            properties:
              params:
                type: array
                items:
                  type: string
              fieldName:
                type: string
              error:
                type: string
                enum:
                - REQUIRED
                - HAS_TEXT
                - REQUIRES
                - SIZE
                - RANGE
                - IN
                - NOT_IN
                - REGEX
                - EXACTLY
                - AT_LEAST
                - AT_MOST
                - ALL_OR_NONE
    CorrespondentBankingExternalData:
      type: object
      description: External data key-value pair.
      required:
      - name
      - value
      properties:
        name:
          type: string
          maxLength: 50
          description: Name/key of the external data.
        value:
          type: string
          maxLength: 255
          description: Value of the external data.
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    CorrespondentBankingBusinessAddressAndIdInfo:
      required:
      - documentType
      - documentNumber
      type: object
      description: Business identification for a business originator.
      properties:
        documentType:
          type: string
          enum:
          - LEI
          - REGISTRATION_NUMBER
          - TAX_ID
          - OTHER
          description: Type of business identification document.
        documentNumber:
          type: string
          maxLength: 35
          description: Business identification document number (e.g. LEI code, company registration number).
    Tag:
      type: string
      description: The tag field is a custom field that can be used to search and filter.
      maxLength: 50
      pattern: ^[a-zA-Z0-9_-]+$
    CorrespondentBankingOwt:
      required:
      - id
      - profileId
      - creationTimestamp
      - sourceInstrument
      - amount
      - originator
      - beneficiary
      - purpose
      - state
      type: object
      properties:
        id:
          type: string
          pattern: ^[0-9]+$
          description: The unique identifier of the Correspondent Banking OWT.
        profileId:
          $ref: '#/components/schemas/ProfileId'
        tag:
          $ref: '#/components/schemas/Tag'
        sourceInstrument:
          required:
          - type
          - id
          type: object
          description: The source managed account from where the funds were taken.
          properties:
            type:
              type: string
              enum:
              - managed_accounts
            id:
              type: string
              pattern: ^[0-9]+$
        amount:
          description: The amount transferred.
          $ref: '#/components/schemas/CurrencyAmount'
        originator:
          oneOf:
          - $ref: '#/components/schemas/CorrespondentBankingIndividualOriginator'
          - $ref: '#/components/schemas/CorrespondentBankingBusinessOriginator'
        beneficiary:
          oneOf:
          - $ref: '#/components/schemas/CorrespondentBankingSEPABeneficiary'
          - $ref: '#/components/schemas/CorrespondentBankingRIXBeneficiary'
          - $ref: '#/components/schemas/CorrespondentBankingFasterPaymentsBeneficiary'
        purpose:
          type: string
          maxLength: 255
          description: The purpose of the payment.
        description:
          maxLength: 35
          type: string
          description: 'These details are passed to the beneficiary as the `reference`. This field is mandatory for wire transfers executed over `SEPA`. The allowed length is dependent on the payment type:


            `SEPA` <= `35` characters. An extended character set is accepted to cater for all European languages. If `SEPA` does not support a particular character, it is automatically converted to an acceptable alternative, in line with `SEPA` scheme guidance.


            `Faster Payments` <= `18` characters

            '
        externalData:
          type: array
          description: Additional external data as key-value pairs.
          items:
            $ref: '#/components/schemas/CorrespondentBankingExternalData'
        state:
          $ref: '#/components/schemas/CorrespondentBankingOwtState'
        creationTimestamp:
          type: integer
          format: int64
          description: The time when the transaction was created, expressed in Epoch timestamp using millisecond precision.
        scheduledTimestamp:
          $ref: '#/components/schemas/ScheduledTimestamp'
        cancellationReason:
          $ref: '#/components/schemas/TransactionCancellationReason'
        validationOutcomes:
          type: array
          items:
            

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/weavr/refs/heads/main/openapi/weavr-correspondent-bank-transfers-api-openapi.yml