IF Beneficiary Bank Accounts API

openapi: 3.2.0
info:
  title: Outgoing Transfer Beneficiary Bank Accounts 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
paths:
  /beneficiaries/{beneficiaryId}/bank-accounts:
    get:
      tags:
      - Beneficiary Bank Accounts
      summary: List Beneficiary Bank Accounts
      operationId: beneficiaries.bankAccounts.list
      parameters:
      - name: beneficiaryId
        in: path
        description: ID of beneficiary in UUID format
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Beneficiary bank account list returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryBankAccountsListResponse'
    post:
      tags:
      - Beneficiary Bank Accounts
      summary: Create a Beneficiary Bank Account
      operationId: beneficiaries.bankAccounts.create
      parameters:
      - name: beneficiaryId
        in: path
        description: ID of beneficiary in UUID format
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/BeneficiaryBankAccountCreateRequest'
        required: true
      responses:
        '201':
          description: Beneficiary bank account created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryCreateResponse'
  /beneficiaries/{beneficiaryId}/bank-accounts/{id}:
    get:
      tags:
      - Beneficiary Bank Accounts
      summary: Get a Beneficiary Bank Account
      operationId: beneficiaries.bankAccounts.get
      parameters:
      - name: beneficiaryId
        in: path
        description: ID of beneficiary in UUID format
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        description: ID of beneficiary bank account in UUID format
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/BeneficiaryBankAccountsGetResponse'
      responses:
        '200':
          description: Beneficiary bank account returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryBankAccountsGetResponse'
    patch:
      tags:
      - Beneficiary Bank Accounts
      summary: Update a Beneficiary Bank Account
      operationId: beneficiaries.bankAccounts.update
      parameters:
      - name: beneficiaryId
        in: path
        description: ID of beneficiary in UUID format
        required: true
        schema:
          type: string
          format: uuid
      - name: id
        in: path
        description: ID of beneficiary bank account in UUID format
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/BeneficiaryBankAccountUpdateRequest'
        required: true
      responses:
        '202':
          description: Beneficiary bank account updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryBankAccountUpdateResponse'
components:
  schemas:
    BeneficiaryBankAccountsUpdateWorkflowContainer:
      required:
      - code
      type: object
      properties:
        code:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateWorkflow'
      description: workflow container
    BeneficiaryBankAccountsListMetadataContainer:
      required:
      - page
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageMetadata'
    BeneficiaryCreateWorkflow:
      type: string
      description: workflow code
      enum:
      - direct
      - client.direct
      - organization.direct
      - migration
      - direct
    BeneficiaryCreateConnect:
      type: string
      description: service provider selection type
      enum:
      - explicit
      - implicit
      - explicit
    BeneficiaryBankAccountsListResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryBankAccountsListWorkflow'
        data:
          $ref: '#/components/schemas/BeneficiaryBankAccountsListDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiaryBankAccountListConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryBankAccountsListMetadataContainer'
    Owner:
      type: string
      enum:
      - organization
      - client
    RoutingCodeType:
      type: string
      enum:
      - bic
      - sort-code
      - aba
      - rtn-canada
      - clabe
      - bsb-code
      - ifsc
      - cnaps
      - bank-code
      - branch-code
    BeneficiaryCreateWorkflowContainer:
      required:
      - code
      type: object
      properties:
        code:
          $ref: '#/components/schemas/BeneficiaryCreateWorkflow'
      description: workflow container
    BeneficiaryBankAccountsUpdateWorkflow:
      type: string
      description: workflow code
      enum:
      - direct
      - client.direct
      - organization.direct
      - migrate
      - direct
    BeneficiaryBankAccountsUpdateConnectContainer:
      required:
      - serviceProvider
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateConnect'
        serviceProvider:
          type: string
          description: 'account is connected to this service provider '
      description: connect container
    BeneficiaryBankAccountListConnectContainer:
      type: object
    BeneficiaryBankAccountCreateRequest:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryCreateWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryCreateRequestDataContainer'
        connect:
          $ref: '#/components/schemas/AccountCreateConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryBankAccountsCreateMetadataContainer'
      description: request model
    BeneficiaryBankAccountGetDataContainer:
      required:
      - bankAccount
      type: object
      properties:
        bankAccount:
          $ref: '#/components/schemas/BeneficiaryBankAccount'
    BeneficiaryBankAccountUpdateRequest:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateMetadataContainer'
      description: request model
    BeneficiaryBankAccountsUpdateMetadataContainer:
      type: object
    BeneficiaryCreateRequestDataContainer:
      type: object
      properties:
        beneficiary:
          $ref: '#/components/schemas/Beneficiary'
        sourceId:
          type: string
          description: id of the beneficiary to be migrated, required if workflow is migration
          writeOnly: true
    BeneficiaryBankAccountsUpdateDataContainer:
      type: object
      properties:
        bank account:
          type: object
          additionalProperties:
            type: object
            description: beneficiary bank account data model
          description: beneficiary bank account data model
    BeneficiaryCreateResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryCreateWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryCreateRequestDataContainer'
        connect:
          $ref: '#/components/schemas/PlatformAPIConnectContainer'
        metadata:
          $ref: '#/components/schemas/PlatformAPIMetadataContainer'
      description: Beneficiaries API Create Response
    BeneficiaryBankAccountsListDataContainer:
      type: object
      properties:
        beneficiaryBankAccount:
          $ref: '#/components/schemas/BeneficiaryBankAccountResourceListQueryInput'
        beneficiaryBankAccounts:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/BeneficiaryBankAccount'
    BeneficiaryBankAccount:
      type: object
      properties:
        id:
          type: string
          format: uuid
        accountHolderType:
          $ref: '#/components/schemas/LegalEntityType'
        beneficiaryId:
          type: string
          format: uuid
        country:
          type: string
        currency:
          type: string
        routingCodes:
          $ref: '#/components/schemas/RoutingCodeMap'
        accountNumber:
          type: string
        iban:
          type: string
        bankName:
          type: string
        creationDateTime:
          type: string
          format: date-time
        creatingUserUsername:
          type: string
        oneTimePasswordId:
          type: string
          format: uuid
        oneTimePassword:
          type: string
        ledgerNumber:
          type: string
      description: Beneficiary Bank Account Resource Object
      readOnly: true
    BeneficiaryBankAccountResourceListQueryInput:
      type: object
      properties:
        country:
          type: array
          items:
            type: string
        currency:
          type: array
          items:
            type: string
        iban:
          type: array
          items:
            type: string
        accountNumber:
          type: array
          items:
            type: string
        routingCodeKey:
          $ref: '#/components/schemas/RoutingCodeType'
        routingCodeValue:
          type: string
        owner:
          $ref: '#/components/schemas/Owner'
    Address:
      required:
      - city
      - country
      - street
      type: object
      properties:
        country:
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
          type: string
        region:
          type: string
        postalCode:
          type: string
        city:
          type: string
        street:
          type: string
        houseNumber:
          type: string
        refinement:
          type: string
    LegalEntityType:
      type: string
      enum:
      - corporate
      - individual
    BeneficiaryBankAccountsGetResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryBankAccountGetWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryBankAccountGetDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiaryBankAccountGetConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryBankAccountGetMetadataContainer'
    BeneficiaryBankAccountGetMetadataContainer:
      type: object
    BeneficiaryBankAccountsUpdateConnect:
      type: string
      description: service provider selection type
      enum:
      - explicit
      - implicit
      - explicit
    PageMetadata:
      required:
      - number
      - size
      - totalElements
      - totalPages
      type: object
      properties:
        size:
          minimum: 0
          type: integer
          description: number of elements in this page
          format: int32
        number:
          minimum: 0
          type: integer
          description: index of page starting from 0
          format: int32
        totalElements:
          minimum: 0
          type: integer
          description: total number of elements in all of the pages
          format: int64
          readOnly: true
        totalPages:
          minimum: 0
          type: integer
          description: number of total pages
          format: int32
          readOnly: true
    BeneficiaryBankAccountGetWorkflowContainer:
      type: object
    LegalEntityIdentity:
      required:
      - type
      type: object
      properties:
        type:
          type: string
      discriminator:
        propertyName: type
        mapping:
          corporate: '#/components/schemas/LegalEntityIdentityCorporate'
          individual: '#/components/schemas/LegalEntityIdentityIndividual'
    RoutingCodeMap:
      type: object
    BeneficiaryBankAccountGetConnectContainer:
      type: object
    AccountCreateConnectContainer:
      required:
      - serviceProvider
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/BeneficiaryCreateConnect'
        serviceProvider:
          type: string
          description: 'account is connected to this service provider '
      description: connect container
    PlatformAPIMetadataContainer:
      type: object
    BeneficiaryBankAccountUpdateResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryBankAccountsUpdateMetadataContainer'
      description: Beneficiary Bank Accounts API Update Response
    BeneficiaryBankAccountsListWorkflow:
      type: object
    BeneficiaryContact:
      type: object
      properties:
        phone:
          type: string
          description: beneficiary contact phone number
        email:
          type: string
          description: beneficiary contact email address
        address:
          $ref: '#/components/schemas/Address'
      description: Beneficiary Contact Resource Object
    BeneficiaryBankAccountsCreateMetadataContainer:
      type: object
    Beneficiary:
      required:
      - clientId
      - identity
      type: object
      properties:
        id:
          type: string
          format: uuid
        clientId:
          type: string
          description: ID of client in UUID format
          format: uuid
        identity:
          $ref: '#/components/schemas/LegalEntityIdentity'
        contact:
          $ref: '#/components/schemas/BeneficiaryContact'
        address:
          $ref: '#/components/schemas/Address'
        title:
          type: string
        fullName:
          type: string
        bankAccounts:
          type: array
          description: beneficiary bank accounts
          readOnly: true
          items:
            $ref: '#/components/schemas/BeneficiaryBankAccount'
      description: Beneficiary Resource Object
    PlatformAPIConnectContainer:
      type: object
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