openapi: 3.2.0
info:
  title: Incoming Transfers API
  description: Operations for Incoming 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: Incoming Transfers
paths:
  /incoming-transfers:
    get:
      tags:
      - Incoming Transfers
      summary: List Incoming Transfers
      operationId: incoming-transfers.list
      responses:
        '200':
          description: Incoming transfer list returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingTransferListResponse'
  /incoming-transfers/{id}:
    get:
      tags:
      - Incoming Transfers
      summary: Get an Incoming Transfer
      operationId: incoming-transfers.get
      parameters:
      - name: id
        in: path
        description: ID of incoming transfer in UUID format
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Incoming transfer returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingTransferGetResponse'
    patch:
      tags:
      - Incoming Transfers
      summary: Update an Incoming Transfer
      operationId: incoming-transfers.update
      parameters:
      - name: id
        in: path
        description: ID of incoming transfer in UUID format
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/IncomingTransferUpdateRequest'
        required: true
      responses:
        '202':
          description: Incoming transfer updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingTransferUpdateResponse'
components:
  schemas:
    IncomingTransferResource:
      type: object
      properties:
        id:
          type: string
          description: id of incoming transfer
          format: uuid
          readOnly: true
        clientId:
          type: string
          description: id of client
          format: uuid
          readOnly: true
        accountId:
          type: string
          description: id of account which is credited by this incoming transfer
          format: uuid
          readOnly: true
        transactionNumber:
          maxLength: 15
          minLength: 15
          type: string
          description: unique transaction number
          readOnly: true
        status:
          $ref: '#/components/schemas/IncomingTransferStatus'
        currency:
          maxLength: 3
          minLength: 3
          type: string
          description: ISO 4217 currency code of incoming transfer
          readOnly: true
        amount:
          type: number
          description: amount
          format: double
          readOnly: true
        feeAmount:
          type: number
          description: fee amount
          format: double
          readOnly: true
        feeCurrency:
          maxLength: 3
          minLength: 3
          type: string
          description: ISO 4217 currency code of incoming transfer fee
          readOnly: true
        outgoingTransferId:
          type: string
          description: id of outgoing transfer if this is an internal transfer
          format: uuid
          readOnly: true
        serviceProviderId:
          type: string
          description: id assigned by service provider
          readOnly: true
        serviceProviderReference:
          type: string
          description: reference assigned by service provider
          readOnly: true
        senderInformation:
          type: string
          description: free text filled by sender
          readOnly: true
        senderName:
          type: string
          description: name of sender
          readOnly: true
        transferDate:
          type: string
          description: the date when transfer amount is reflected to account balance
          format: date
          readOnly: true
        totalAmount:
          type: number
          description: total amount including fee
          readOnly: true
        provisionedAccountCreditId:
          type: string
          description: Provisioned account credit id of the transfer
          format: uuid
          readOnly: true
        serviceProvider:
          type: string
          description: service provider that incoming transfer received from
          readOnly: true
        receiverAccount:
          $ref: '#/components/schemas/IncomingMoneyTransferBankAccount'
        senderAccount:
          $ref: '#/components/schemas/IncomingMoneyTransferBankAccount'
        scope:
          type: string
          description: transfer scope
          readOnly: true
          enum:
          - internal
          - external
        scheme:
          type: string
          description: transfer scheme depending on the scope of the transfer
          readOnly: true
          enum:
          - swift
          - local
          - sepa
          - sepa-instant
          - sepa-target-2
          - sepa-target-2-pacs009
          - chaps
          - bacs
          - faster-payments
          - faster-payments-poo
          - ach
          - wire
          - eft
        owner:
          $ref: '#/components/schemas/Owner'
        relatedTransaction:
          $ref: '#/components/schemas/RelatedTransaction'
        returnContext:
          $ref: '#/components/schemas/IncomingTransferReturnContextResource'
      description: incoming transfer model
    IncomingTransferListResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/IncomingTransferListWorkflowContainer'
        data:
          $ref: '#/components/schemas/IncomingTransferListDataContainer'
        connect:
          $ref: '#/components/schemas/IncomingTransferListConnectContainer'
        metadata:
          $ref: '#/components/schemas/IncomingTransferListMetadataContainer'
      description: response model
    IncomingTransferListWorkflowContainer:
      type: object
      description: workflow container
    IncomingMoneyTransferBankAccount:
      type: object
      properties:
        bankName:
          type: string
        accountHolderName:
          type: string
          description: name of the legal entity which account belongs to
        alias:
          maxLength: 30
          type: string
          description: alias of account, refer to Accounts section in Guides for details
        country:
          maxLength: 2
          minLength: 2
          type: string
          description: ISO 3166-1 alpha-2 country code
        currency:
          maxLength: 3
          minLength: 3
          type: string
          description: ISO 4217 currency code
        routingCodes:
          $ref: '#/components/schemas/RoutingCodeMap'
        accountNumber:
          maxLength: 20
          minLength: 8
          pattern: ^[0-9]{8,20}$
          type:
          - string
          - 'null'
          description: account number of account
        iban:
          maxLength: 31
          minLength: 15
          pattern: ^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[0-9]{4}([a-zA-Z0-9]?){3,19}$|^[A-Z]{2}\d{5}[0-9A-Z]{13}$
          type:
          - string
          - 'null'
          description: iban of account
        ledgerNumber:
          maxLength: 8
          minLength: 8
          pattern: ^[0-9]{8,8}$
          type: string
          description: unique ledger number of account generated internally
      description: bank account model of incoming transfers
      readOnly: true
    IncomingTransferUpdateWorkflowContainer:
      required:
      - code
      type: object
      properties:
        code:
          type: string
          description: workflow code
          enum:
          - client.direct
          - organization.direct
      description: workflow container
    Owner:
      type: string
      description: owner of incoming transfer
      readOnly: true
      enum:
      - organization
      - client
    IncomingTransferReturnContextResource:
      type: object
      properties:
        enabled:
          type: boolean
          description: return is enabled or not
          readOnly: true
        cutOffDateTime:
          type: string
          description: cut-off time if return is enabled
          format: date-time
          readOnly: true
        status:
          $ref: '#/components/schemas/IncomingTransferReturnStatus'
        reason:
          $ref: '#/components/schemas/IncomingTransferReturnReason'
      description: incoming transfer return model
    IncomingTransferGetConnectContainer:
      type: object
      description: connect container
    IncomingTransferGetMetadataContainer:
      type: object
      description: metadata container
    IncomingTransferListDataContainer:
      type: object
      properties:
        incomingTransfer:
          $ref: '#/components/schemas/IncomingTransferResourceQueryInput'
        incomingTransfers:
          type: array
          items:
            $ref: '#/components/schemas/IncomingTransferResource'
      description: data container
    IncomingTransferListMetadataContainer:
      required:
      - page
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageMetadata'
      description: metadata container
    TransactionNature:
      type: string
      enum:
      - actual
      - virtual
    IncomingTransferUpdateResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/IncomingTransferUpdateWorkflowContainer'
        data:
          $ref: '#/components/schemas/IncomingTransferUpdateDataContainer'
        connect:
          $ref: '#/components/schemas/IncomingTransferUpdateConnectContainer'
        metadata:
          $ref: '#/components/schemas/IncomingTransferMetadataConnectContainer'
      description: response model
    IncomingTransferGetDataContainer:
      required:
      - incomingTransfer
      type: object
      properties:
        incomingTransfer:
          $ref: '#/components/schemas/IncomingTransferResource'
      description: data container
    IncomingTransferGetResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/IncomingTransferGetWorkflowContainer'
        data:
          $ref: '#/components/schemas/IncomingTransferGetDataContainer'
        connect:
          $ref: '#/components/schemas/IncomingTransferGetConnectContainer'
        metadata:
          $ref: '#/components/schemas/IncomingTransferGetMetadataContainer'
      description: response model
    IncomingTransferMetadataConnectContainer:
      type: object
      description: metadata container
    IncomingTransferUpdateDataContainer:
      required:
      - incomingTransfer
      type: object
      properties:
        incomingTransfer:
          $ref: '#/components/schemas/IncomingTransferResource'
    RelatedTransaction:
      type: object
      properties:
        nature:
          $ref: '#/components/schemas/TransactionNature'
        id:
          type: string
          format: uuid
      description: related transaction of this transfer
      readOnly: true
    IncomingTransferStatus:
      type: string
      description: status of incoming transfer
      readOnly: true
      enum:
      - pending
      - on-hold
      - completed
      - failed
    IncomingTransferUpdateConnectContainer:
      type: object
      description: connect container
    IncomingTransferUpdateRequest:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/IncomingTransferUpdateWorkflowContainer'
        data:
          $ref: '#/components/schemas/IncomingTransferUpdateDataContainer'
        connect:
          $ref: '#/components/schemas/IncomingTransferUpdateConnectContainer'
        metadata:
          $ref: '#/components/schemas/IncomingTransferMetadataConnectContainer'
    IncomingTransferReturnReason:
      type: string
      description: reason of incoming transfer return
      enum:
      - account-closed
      - account-inactivated
      - account-not-found
      - user-requested
      - user-requested-as-duplicate
      - user-requested-as-wrong-amount
      - sender-recalled
      - rejected-by-compliance
    IncomingTransferReturnStatus:
      type: string
      description: status of incoming transfer return
      enum:
      - processing
      - released
      - completed
      - failed
    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
    RoutingCodeMap:
      type: object
      description: routing codes of account as map, refer to Accounts section in Guides for details
    IncomingTransferResourceQueryInput:
      type: object
      properties:
        status:
          type: array
          items:
            $ref: '#/components/schemas/IncomingTransferStatus'
        transactionNumber:
          type: array
          items:
            type: string
        amountFrom:
          type: number
        amountTo:
          type: number
        currency:
          type: array
          items:
            type: string
        serviceProvider:
          type: array
          items:
            type: string
        serviceProviderId:
          type: string
        serviceProviderReference:
          type: string
        clientId:
          type: array
          items:
            type: string
            format: uuid
        accountId:
          type: array
          items:
            type: string
            format: uuid
        senderInformation:
          type: string
        senderName:
          type: string
        transferDateFrom:
          type: string
          format: date
        transferDateTo:
          type: string
          format: date
        provisionedAccountCreditId:
          type: array
          items:
            type: string
            format: uuid
        owner:
          $ref: '#/components/schemas/Owner'
        hasRelatedTransaction:
          type: boolean
        relatedTransactionId:
          type: string
          format: uuid
        relatedTransactionNature:
          $ref: '#/components/schemas/TransactionNature'
    IncomingTransferGetWorkflowContainer:
      type: object
      description: workflow container
    IncomingTransferListConnectContainer:
      type: object
      description: connect container
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/incoming-transferscompliance-checkget.md
  - https://developer.integrated.finance/reference/incoming-transferscompliance-checkupdate.md
  - https://developer.integrated.finance/reference/incoming-transfersget.md
  - https://developer.integrated.finance/reference/incoming-transferslist.md
  - https://developer.integrated.finance/reference/incoming-transfersupdate.md
  - https://developer.integrated.finance/reference/provisioned-account-creditcreate.md
  - https://developer.integrated.finance/reference/provisioned-account-creditget.md
  - https://developer.integrated.finance/reference/provisioned-account-creditlist.md
  merge:
    pages: 8
    deduped: 41
    conflicts_kept_first: 0