openapi: 3.2.0
info:
  title: Outgoing Transfer Beneficiary Bank Accounts Metadata API
  description: Operations for Outgoing Transfers
  version: '1'
servers:
- url: https://sandbox-api.integrated.finance/v1/{instanceId}
  description: Sandbox
  variables: {}
- url: https://api.integrated.finance/v1/{instanceId}
  description: Production
  variables: {}
tags:
- name: Beneficiary Bank Accounts Metadata
paths:
  /beneficiary-bank-account-requirements:
    get:
      tags:
      - Beneficiary Bank Accounts Metadata
      summary: Get Beneficiary Bank Account Metadata
      operationId: beneficiaries.bankAccounts.requirements.get
      responses:
        '200':
          description: Beneficiary bank account metadata returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryBankAccountMetadataResponse'
components:
  schemas:
    BeneficiaryBankAccountMetadataDataContainer:
      required:
      - beneficiaryAddress
      - beneficiaryBankAccount
      type: object
      properties:
        beneficiaryBankAccount:
          $ref: '#/components/schemas/BeneficiaryBankAccountMetadataResource'
        beneficiaryAddress:
          $ref: '#/components/schemas/BeneficiaryBankAccountMetadataAddressResource'
    BeneficiaryRequirementsResource:
      type: object
      properties:
        beneficiaryAddress:
          $ref: '#/components/schemas/FieldOptionType'
      description: beneficiary requirements
    BeneficiaryBankAccountMetadataResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryBankAccountMetadataWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryBankAccountMetadataDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiaryBankAccountMetadataConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryBankAccountMetadataMetadataContainer'
    BeneficiaryBankAccountMetadataResource:
      required:
      - beneficiaryBankAccountAccountNumberMetadata
      - beneficiaryBankAccountBankNameMetadata
      - beneficiaryBankAccountIbanMetadata
      - beneficiaryBankAccountRoutingCodesMetadata
      - beneficiaryRequirements
      type: object
      properties:
        beneficiaryRequirements:
          $ref: '#/components/schemas/BeneficiaryRequirementsResource'
        beneficiaryBankAccountIbanMetadata:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
        beneficiaryBankAccountAccountNumberMetadata:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
        beneficiaryBankAccountBankNameMetadata:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
        beneficiaryBankAccountRoutingCodesMetadata:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
          description: beneficiary bank account routing codes metadata
      description: beneficiary bank account metadata model
    BeneficiaryBankAccountMetadataConnectContainer:
      type: object
    BeneficiaryBankAccountFieldMetadataResourceString:
      required:
      - beneficiaryBankAccountFieldRegex
      - requirement
      type: object
      properties:
        beneficiaryBankAccountFieldRegex:
          type: string
          description: beneficiary bank account field metadata regex
        requirement:
          $ref: '#/components/schemas/FieldOptionType'
    BeneficiaryBankAccountMetadataMetadataContainer:
      type: object
    BeneficiaryBankAccountMetadataAddressResource:
      type: object
      properties:
        country:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
        region:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
        city:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
        street:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
        houseNumber:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
        postalCode:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
        refinement:
          $ref: '#/components/schemas/BeneficiaryBankAccountFieldMetadataResourceString'
      description: beneficiary bank account address metadata
    BeneficiaryBankAccountMetadataWorkflowContainer:
      type: object
    FieldOptionType:
      type: string
      description: beneficiary bank account field metadata requirement
      enum:
      - none
      - optional
      - required
x-provenance:
  method: searched
  source: https://developer.integrated.finance/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.integrated.finance/reference/beneficiariesbankaccountscreate.md
  - https://developer.integrated.finance/reference/beneficiariesbankaccountsget.md
  - https://developer.integrated.finance/reference/beneficiariesbankaccountslist.md
  - https://developer.integrated.finance/reference/beneficiariesbankaccountsrequirementsget.md
  - https://developer.integrated.finance/reference/beneficiariesbankaccountsupdate.md
  - https://developer.integrated.finance/reference/beneficiariescreate.md
  - https://developer.integrated.finance/reference/beneficiariesget.md
  - https://developer.integrated.finance/reference/beneficiarieslist.md
  - https://developer.integrated.finance/reference/beneficiariesupdate.md
  - https://developer.integrated.finance/reference/beneficiary-verificationscreate.md
  - https://developer.integrated.finance/reference/direct-debit-mandatescreate.md
  - https://developer.integrated.finance/reference/direct-debit-mandatesget.md
  - https://developer.integrated.finance/reference/direct-debit-mandateslist.md
  - https://developer.integrated.finance/reference/direct-debit-mandatesupdate.md
  - https://developer.integrated.finance/reference/direct-debit-paymentsget.md
  - https://developer.integrated.finance/reference/direct-debit-paymentslist.md
  - https://developer.integrated.finance/reference/direct-debit-paymentsupdate.md
  - https://developer.integrated.finance/reference/outgoing-transferscompliance-checkget.md
  - https://developer.integrated.finance/reference/outgoing-transferscompliance-checkupdate.md
  - https://developer.integrated.finance/reference/outgoing-transferscreate.md
  - https://developer.integrated.finance/reference/outgoing-transfersdate-metadataget.md
  - https://developer.integrated.finance/reference/outgoing-transfersdate-metadataget_1.md
  - https://developer.integrated.finance/reference/outgoing-transfersget.md
  - https://developer.integrated.finance/reference/outgoing-transferslist.md
  - https://developer.integrated.finance/reference/outgoing-transfersupdate.md
  merge:
    pages: 25
    deduped: 237
    conflicts_kept_first: 0