openapi.yaml

openapi: 3.0.3
info:
  title: Payments API
  version: v1
paths:
  /_info:
    get:
      summary: Get server info
      operationId: getServerInfo
      tags:
        - payments.v1
      responses:
        "200":
          $ref: '#/components/responses/ServerInfo'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /payments:
    post:
      summary: Create a payment
      tags:
        - payments.v1
      operationId: createPayment
      description: Create a payment
      requestBody:
        $ref: '#/components/requestBodies/Payment'
      responses:
        "200":
          $ref: '#/components/responses/Payment'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      summary: List payments
      operationId: listPayments
      tags:
        - payments.v1
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Sort'
        - $ref: '#/components/parameters/Query'
      responses:
        "200":
          $ref: '#/components/responses/Payments'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /payments/{paymentId}:
    get:
      summary: Get a payment
      tags:
        - payments.v1
      operationId: getPayment
      parameters:
        - $ref: '#/components/parameters/PaymentId'
      responses:
        "200":
          $ref: '#/components/responses/Payment'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /payments/{paymentId}/metadata:
    patch:
      summary: Update metadata
      tags:
        - payments.v1
      operationId: updateMetadata
      parameters:
        - $ref: '#/components/parameters/PaymentId'
      requestBody:
        $ref: '#/components/requestBodies/UpdateMetadata'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /transfer-initiations:
    get:
      summary: List Transfer Initiations
      operationId: listTransferInitiations
      tags:
        - payments.v1
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Sort'
        - $ref: '#/components/parameters/Query'
      responses:
        "200":
          $ref: '#/components/responses/TransferInitiations'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
    post:
      summary: Create a TransferInitiation
      tags:
        - payments.v1
      operationId: createTransferInitiation
      description: Create a transfer initiation
      requestBody:
        $ref: '#/components/requestBodies/TransferInitiation'
      responses:
        "200":
          $ref: '#/components/responses/TransferInitiation'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /transfer-initiations/{transferId}:
    get:
      summary: Get a transfer initiation
      tags:
        - payments.v1
      operationId: getTransferInitiation
      parameters:
        - $ref: '#/components/parameters/TransferId'
      responses:
        "200":
          $ref: '#/components/responses/TransferInitiation'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
    delete:
      summary: Delete a transfer initiation
      operationId: deleteTransferInitiation
      tags:
        - payments.v1
      description: Delete a transfer initiation by its id.
      parameters:
        - $ref: '#/components/parameters/TransferId'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /transfer-initiations/{transferId}/status:
    post:
      summary: Update the status of a transfer initiation
      tags:
        - payments.v1
      operationId: udpateTransferInitiationStatus
      description: Update a transfer initiation status
      parameters:
        - $ref: '#/components/parameters/TransferId'
      requestBody:
        $ref: '#/components/requestBodies/UpdateTransferInitiationStatus'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /transfer-initiations/{transferId}/reverse:
    post:
      summary: Reverse a transfer initiation
      tags:
        - payments.v1
      operationId: reverseTransferInitiation
      description: Reverse transfer initiation
      parameters:
        - $ref: '#/components/parameters/TransferId'
      requestBody:
        $ref: '#/components/requestBodies/ReverseTransferInitiation'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /transfer-initiations/{transferId}/retry:
    post:
      summary: Retry a failed transfer initiation
      tags:
        - payments.v1
      operationId: retryTransferInitiation
      description: Retry a failed transfer initiation
      parameters:
        - $ref: '#/components/parameters/TransferId'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /pools:
    get:
      summary: List Pools
      operationId: listPools
      tags:
        - payments.v1
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Sort'
        - $ref: '#/components/parameters/Query'
      responses:
        "200":
          $ref: '#/components/responses/Pools'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
    post:
      summary: Create a Pool
      tags:
        - payments.v1
      operationId: createPool
      description: Create a Pool
      requestBody:
        $ref: '#/components/requestBodies/Pool'
      responses:
        "200":
          $ref: '#/components/responses/Pool'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /pools/{poolId}:
    get:
      summary: Get a Pool
      tags:
        - payments.v1
      operationId: getPool
      parameters:
        - $ref: '#/components/parameters/PoolId'
      responses:
        "200":
          $ref: '#/components/responses/Pool'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
    delete:
      summary: Delete a Pool
      operationId: deletePool
      tags:
        - payments.v1
      description: Delete a pool by its id.
      parameters:
        - $ref: '#/components/parameters/PoolId'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /pools/{poolId}/accounts:
    post:
      summary: Add an account to a pool
      tags:
        - payments.v1
      operationId: addAccountToPool
      description: Add an account to a pool
      parameters:
        - $ref: '#/components/parameters/PoolId'
      requestBody:
        $ref: '#/components/requestBodies/AddAccountToPool'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /pools/{poolId}/accounts/{accountId}:
    delete:
      summary: Remove an account from a pool
      operationId: removeAccountFromPool
      tags:
        - payments.v1
      description: Remove an account from a pool by its id.
      parameters:
        - $ref: '#/components/parameters/PoolId'
        - $ref: '#/components/parameters/AccountId'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /pools/{poolId}/balances:
    get:
      summary: Get pool balances
      operationId: getPoolBalances
      tags:
        - payments.v1
      parameters:
        - $ref: '#/components/parameters/PoolId'
        - name: at
          in: query
          description: |
            Filter balances by date.
          required: true
          schema:
            type: string
            format: date-time
      responses:
        "200":
          $ref: '#/components/responses/PoolBalances'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /accounts:
    post:
      summary: Create an account
      tags:
        - payments.v1
      operationId: createAccount
      description: Create an account
      requestBody:
        $ref: '#/components/requestBodies/Account'
      responses:
        "200":
          $ref: '#/components/responses/Account'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      summary: List accounts
      operationId: listAccounts
      tags:
        - payments.v1
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Sort'
        - $ref: '#/components/parameters/Query'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        "200":
          $ref: '#/components/responses/Accounts'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /accounts/{accountId}:
    get:
      summary: Get an account
      tags:
        - payments.v1
      operationId: getAccount
      parameters:
        - $ref: '#/components/parameters/AccountId'
      responses:
        "200":
          $ref: '#/components/responses/Account'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /accounts/{accountId}/balances:
    get:
      summary: Get account balances
      operationId: getAccountBalances
      tags:
        - payments.v1
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - name: limit
          in: query
          description: The maximum number of results to return per page.
          required: false
          schema:
            type: integer
            format: int64
        - name: asset
          in: query
          description: |
            Filter balances by currency.
            If not specified, all account's balances will be returned.
          required: false
          schema:
            type: string
        - name: from
          in: query
          description: |
            Filter balances by date.
            If not specified, all account's balances will be returned.
          required: false
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          description: |
            Filter balances by date.
            If not specified, default will be set to now.
          required: false
          schema:
            type: string
            format: date-time
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Sort'
      responses:
        "200":
          $ref: '#/components/responses/AccountBalances'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /bank-accounts:
    post:
      summary: Create a BankAccount in Payments and on the PSP
      tags:
        - payments.v1
      operationId: createBankAccount
      description: Create a bank account in Payments and on the PSP.
      requestBody:
        $ref: '#/components/requestBodies/BankAccount'
      responses:
        "200":
          $ref: '#/components/responses/BankAccount'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      summary: List bank accounts created by user on Formance
      operationId: listBankAccounts
      tags:
        - payments.v1
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
        - $ref: '#/components/parameters/Sort'
      description: List all bank accounts created by user on Formance.
      responses:
        "200":
          $ref: '#/components/responses/BankAccounts'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /bank-accounts/{bankAccountId}:
    get:
      summary: Get a bank account created by user on Formance
      tags:
        - payments.v1
      operationId: getBankAccount
      parameters:
        - $ref: '#/components/parameters/BankAccountId'
      responses:
        "200":
          $ref: '#/components/responses/BankAccount'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /bank-accounts/{bankAccountId}/forward:
    post:
      summary: Forward a bank account to a connector
      tags:
        - payments.v1
      operationId: forwardBankAccount
      parameters:
        - $ref: '#/components/parameters/BankAccountId'
      requestBody:
        $ref: '#/components/requestBodies/ForwardBankAccount'
      responses:
        "200":
          $ref: '#/components/responses/BankAccount'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /bank-accounts/{bankAccountId}/metadata:
    patch:
      summary: Update metadata of a bank account
      tags:
        - payments.v1
      operationId: updateBankAccountMetadata
      parameters:
        - $ref: '#/components/parameters/BankAccountId'
      requestBody:
        $ref: '#/components/requestBodies/UpdateBankAccountMetadata'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /connectors:
    get:
      summary: List all installed connectors
      operationId: listAllConnectors
      tags:
        - payments.v1
      description: List all installed connectors.
      responses:
        "200":
          $ref: '#/components/responses/Connectors'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /connectors/configs:
    get:
      summary: List the configs of each available connector
      operationId: listConfigsAvailableConnectors
      tags:
        - payments.v1
      description: List the configs of each available connector.
      responses:
        "200":
          $ref: '#/components/responses/ConnectorsConfigs'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /connectors/{connector}:
    post:
      summary: Install a connector
      tags:
        - payments.v1
      operationId: installConnector
      description: Install a connector by its name and config.
      parameters:
        - $ref: '#/components/parameters/Connector'
      requestBody:
        $ref: '#/components/requestBodies/ConnectorConfig'
      responses:
        "201":
          $ref: '#/components/responses/ConnectorInstalled'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
    delete:
      summary: Uninstall a connector
      deprecated: true
      operationId: uninstallConnector
      tags:
        - payments.v1
      description: Uninstall a connector by its name.
      parameters:
        - $ref: '#/components/parameters/Connector'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /connectors/{connector}/{connectorId}:
    delete:
      summary: Uninstall a connector
      operationId: uninstallConnectorV1
      tags:
        - payments.v1
      description: Uninstall a connector by its name.
      parameters:
        - $ref: '#/components/parameters/Connector'
        - $ref: '#/components/parameters/ConnectorID'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /connectors/{connector}/config:
    get:
      summary: Read the config of a connector
      deprecated: true
      operationId: readConnectorConfig
      tags:
        - payments.v1
      description: Read connector config
      parameters:
        - $ref: '#/components/parameters/Connector'
      responses:
        "200":
          $ref: '#/components/responses/ConnectorConfig'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /connectors/{connector}/{connectorId}/config:
    post:
      summary: Update the config of a connector
      operationId: updateConnectorConfigV1
      tags:
        - payments.v1
      description: Update connector config
      parameters:
        - $ref: '#/components/parameters/Connector'
        - $ref: '#/components/parameters/ConnectorID'
      requestBody:
        $ref: '#/components/requestBodies/ConnectorConfig'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      summary: Read the config of a connector
      operationId: readConnectorConfigV1
      tags:
        - payments.v1
      description: Read connector config
      parameters:
        - $ref: '#/components/parameters/Connector'
        - $ref: '#/components/parameters/ConnectorID'
      responses:
        "200":
          $ref: '#/components/responses/ConnectorConfig'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /connectors/{connector}/reset:
    post:
      summary: Reset a connector
      deprecated: true
      operationId: resetConnector
      tags:
        - payments.v1
      description: |
        Reset a connector by its name.
        It will remove the connector and ALL PAYMENTS generated with it.
      parameters:
        - $ref: '#/components/parameters/Connector'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /connectors/{connector}/{connectorId}/reset:
    post:
      summary: Reset a connector
      operationId: resetConnectorV1
      tags:
        - payments.v1
      description: |
        Reset a connector by its name.
        It will remove the connector and ALL PAYMENTS generated with it.
      parameters:
        - $ref: '#/components/parameters/Connector'
        - $ref: '#/components/parameters/ConnectorID'
      responses:
        "204":
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /connectors/{connector}/tasks:
    get:
      summary: List tasks from a connector
      deprecated: true
      tags:
        - payments.v1
      operationId: listConnectorTasks
      description: List all tasks associated with this connector.
      parameters:
        - $ref: '#/components/parameters/Connector'
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
      responses:
        "200":
          $ref: '#/components/responses/Tasks'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /connectors/{connector}/{connectorId}/tasks:
    get:
      summary: List tasks from a connector
      tags:
        - payments.v1
      operationId: listConnectorTasksV1
      description: List all tasks associated with this connector.
      parameters:
        - $ref: '#/components/parameters/Connector'
        - $ref: '#/components/parameters/ConnectorID'
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
      responses:
        "200":
          $ref: '#/components/responses/Tasks'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /connectors/{connector}/tasks/{taskId}:
    get:
      summary: Read a specific task of the connector
      deprecated: true
      tags:
        - payments.v1
      operationId: getConnectorTask
      description: Get a specific task associated to the connector.
      parameters:
        - $ref: '#/components/parameters/Connector'
        - $ref: '#/components/parameters/TaskId'
      responses:
        "200":
          $ref: '#/components/responses/Task'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /connectors/{connector}/{connectorId}/tasks/{taskId}:
    get:
      summary: Read a specific task of the connector
      tags:
        - payments.v1
      operationId: getConnectorTaskV1
      description: Get a specific task associated to the connector.
      parameters:
        - $ref: '#/components/parameters/Connector'
        - $ref: '#/components/parameters/ConnectorID'
        - $ref: '#/components/parameters/TaskId'
      responses:
        "200":
          $ref: '#/components/responses/Task'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:read
  /connectors/{connector}/transfers:
    post:
      summary: Transfer funds between Connector accounts
      tags:
        - payments.v1
      operationId: connectorsTransfer
      description: Execute a transfer between two accounts.
      parameters:
        - $ref: '#/components/parameters/Connector'
      requestBody:
        $ref: '#/components/requestBodies/Transfer'
      responses:
        "200":
          $ref: '#/components/responses/Transfer'
        default:
          $ref: '#/components/responses/PaymentsErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/accounts:
    post:
      tags:
        - payments.v3
      summary: |
        Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.
      operationId: v3CreateAccount
      x-speakeasy-name-override: CreateAccount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3CreateAccountRequest'
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3CreateAccountResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      tags:
        - payments.v3
      summary: List all accounts
      operationId: v3ListAccounts
      x-speakeasy-name-override: ListAccounts
      parameters:
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3QueryBuilder'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3AccountsCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/accounts/{accountID}:
    get:
      tags:
        - payments.v3
      summary: Get an account by ID
      operationId: v3GetAccount
      x-speakeasy-name-override: GetAccount
      parameters:
        - $ref: '#/components/parameters/V3AccountID'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3GetAccountResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/accounts/{accountID}/balances:
    get:
      tags:
        - payments.v3
      summary: Get account balances
      operationId: v3GetAccountBalances
      x-speakeasy-name-override: GetAccountBalances
      parameters:
        - $ref: '#/components/parameters/V3AccountID'
        - $ref: '#/components/parameters/V3Asset'
        - $ref: '#/components/parameters/V3FromTimestamp'
        - $ref: '#/components/parameters/V3ToTimestamp'
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3BalancesCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/bank-accounts:
    post:
      tags:
        - payments.v3
      summary: |
        Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.
      operationId: v3CreateBankAccount
      x-speakeasy-name-override: CreateBankAccount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3CreateBankAccountRequest'
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3CreateBankAccountResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      tags:
        - payments.v3
      summary: List all bank accounts
      operationId: v3ListBankAccounts
      x-speakeasy-name-override: ListBankAccounts
      parameters:
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3QueryBuilder'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3BankAccountsCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/bank-accounts/{bankAccountID}:
    get:
      tags:
        - payments.v3
      summary: Get a Bank Account by ID
      operationId: v3GetBankAccount
      x-speakeasy-name-override: GetBankAccount
      parameters:
        - $ref: '#/components/parameters/V3BankAccountID'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3GetBankAccountResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
  /v3/bank-accounts/{bankAccountID}/metadata:
    patch:
      tags:
        - payments.v3
      summary: Update a bank account's metadata
      operationId: v3UpdateBankAccountMetadata
      x-speakeasy-name-override: UpdateBankAccountMetadata
      parameters:
        - $ref: '#/components/parameters/V3BankAccountID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3UpdateBankAccountMetadataRequest'
      responses:
        "204":
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
  /v3/bank-accounts/{bankAccountID}/forward:
    post:
      tags:
        - payments.v3
      summary: Forward a Bank Account to a PSP for creation
      operationId: v3ForwardBankAccount
      x-speakeasy-name-override: ForwardBankAccount
      parameters:
        - $ref: '#/components/parameters/V3BankAccountID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3ForwardBankAccountRequest'
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ForwardBankAccountResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
  /v3/connectors:
    get:
      tags:
        - payments.v3
      summary: List all connectors
      operationId: v3ListConnectors
      x-speakeasy-name-override: ListConnectors
      parameters:
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3QueryBuilder'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ConnectorsCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/connectors/install/{connector}:
    post:
      tags:
        - payments.v3
      summary: Install a connector
      operationId: v3InstallConnector
      x-speakeasy-name-override: InstallConnector
      parameters:
        - $ref: '#/components/parameters/V3Connector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3InstallConnectorRequest'
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3InstallConnectorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/connectors/configs:
    get:
      tags:
        - payments.v3
      summary: List all connector configurations
      operationId: v3ListConnectorConfigs
      x-speakeasy-name-override: ListConnectorConfigs
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ConnectorConfigsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/connectors/{connectorID}:
    delete:
      tags:
        - payments.v3
      summary: Uninstall a connector
      operationId: v3UninstallConnector
      x-speakeasy-name-override: UninstallConnector
      parameters:
        - $ref: '#/components/parameters/V3ConnectorID'
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3UninstallConnectorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/connectors/{connectorID}/config:
    get:
      tags:
        - payments.v3
      summary: Get a connector configuration by ID
      operationId: v3GetConnectorConfig
      x-speakeasy-name-override: GetConnectorConfig
      parameters:
        - $ref: '#/components/parameters/V3ConnectorID'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3GetConnectorConfigResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/connectors/{connectorID}/reset:
    post:
      tags:
        - payments.v3
      summary: Reset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.
      operationId: v3ResetConnector
      x-speakeasy-name-override: ResetConnector
      parameters:
        - $ref: '#/components/parameters/V3ConnectorID'
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ResetConnectorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/connectors/{connectorID}/schedules:
    get:
      tags:
        - payments.v3
      summary: List all connector schedules
      operationId: v3ListConnectorSchedules
      x-speakeasy-name-override: ListConnectorSchedules
      parameters:
        - $ref: '#/components/parameters/V3ConnectorID'
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3QueryBuilder'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ConnectorSchedulesCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/connectors/{connectorID}/schedules/{scheduleID}:
    get:
      tags:
        - payments.v3
      summary: Get a connector schedule by ID
      operationId: v3GetConnectorSchedule
      x-speakeasy-name-override: GetConnectorSchedule
      parameters:
        - $ref: '#/components/parameters/V3ConnectorID'
        - $ref: '#/components/parameters/V3ScheduleID'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ConnectorScheduleResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/connectors/{connectorID}/schedules/{scheduleID}/instances:
    get:
      tags:
        - payments.v3
      summary: List all connector schedule instances
      operationId: v3ListConnectorScheduleInstances
      x-speakeasy-name-override: ListConnectorScheduleInstances
      parameters:
        - $ref: '#/components/parameters/V3ConnectorID'
        - $ref: '#/components/parameters/V3ScheduleID'
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ConnectorScheduleInstancesCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/payments:
    post:
      tags:
        - payments.v3
      summary: |
        Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.
      operationId: v3CreatePayment
      x-speakeasy-name-override: CreatePayment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3CreatePaymentRequest'
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3CreatePaymentResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      tags:
        - payments.v3
      summary: List all payments
      operationId: v3ListPayments
      x-speakeasy-name-override: ListPayments
      parameters:
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3QueryBuilder'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3PaymentsCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/payments/{paymentID}:
    get:
      tags:
        - payments.v3
      summary: Get a payment by ID
      operationId: v3GetPayment
      x-speakeasy-name-override: GetPayment
      parameters:
        - $ref: '#/components/parameters/V3PaymentID'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3GetPaymentResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/payments/{paymentID}/metadata:
    patch:
      tags:
        - payments.v3
      summary: Update a payment's metadata
      operationId: v3UpdatePaymentMetadata
      x-speakeasy-name-override: UpdatePaymentMetadata
      parameters:
        - $ref: '#/components/parameters/V3PaymentID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3UpdatePaymentMetadataRequest'
      responses:
        "204":
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/payment-initiations:
    post:
      tags:
        - payments.v3
      summary: Initiate a payment
      operationId: v3InitiatePayment
      x-speakeasy-name-override: InitiatePayment
      parameters:
        - $ref: '#/components/parameters/V3NoValidation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3InitiatePaymentRequest'
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3InitiatePaymentResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      tags:
        - payments.v3
      summary: List all payment initiations
      operationId: v3ListPaymentInitiations
      x-speakeasy-name-override: ListPaymentInitiations
      parameters:
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3QueryBuilder'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3PaymentInitiationsCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/payment-initiations/{paymentInitiationID}:
    delete:
      tags:
        - payments.v3
      summary: Delete a payment initiation by ID
      operationId: v3DeletePaymentInitiation
      x-speakeasy-name-override: DeletePaymentInitiation
      parameters:
        - $ref: '#/components/parameters/V3PaymentInitiationID'
      responses:
        "204":
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      tags:
        - payments.v3
      summary: Get a payment initiation by ID
      operationId: v3GetPaymentInitiation
      x-speakeasy-name-override: GetPaymentInitiation
      parameters:
        - $ref: '#/components/parameters/V3PaymentInitiationID'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3GetPaymentInitiationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/payment-initiations/{paymentInitiationID}/retry:
    post:
      tags:
        - payments.v3
      summary: Retry a payment initiation
      operationId: v3RetryPaymentInitiation
      x-speakeasy-name-override: RetryPaymentInitiation
      parameters:
        - $ref: '#/components/parameters/V3PaymentInitiationID'
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3RetryPaymentInitiationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/payment-initiations/{paymentInitiationID}/approve:
    post:
      tags:
        - payments.v3
      summary: Approve a payment initiation
      operationId: v3ApprovePaymentInitiation
      x-speakeasy-name-override: ApprovePaymentInitiation
      parameters:
        - $ref: '#/components/parameters/V3PaymentInitiationID'
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ApprovePaymentInitiationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/payment-initiations/{paymentInitiationID}/reject:
    post:
      tags:
        - payments.v3
      summary: Reject a payment initiation
      operationId: v3RejectPaymentInitiation
      x-speakeasy-name-override: RejectPaymentInitiation
      parameters:
        - $ref: '#/components/parameters/V3PaymentInitiationID'
      responses:
        "204":
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/payment-initiations/{paymentInitiationID}/reverse:
    post:
      tags:
        - payments.v3
      summary: Reverse a payment initiation
      operationId: v3ReversePaymentInitiation
      x-speakeasy-name-override: ReversePaymentInitiation
      parameters:
        - $ref: '#/components/parameters/V3PaymentInitiationID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3ReversePaymentInitiationRequest'
      responses:
        "202":
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ReversePaymentInitiationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/payment-initiations/{paymentInitiationID}/adjustments:
    get:
      tags:
        - payments.v3
      summary: List all payment initiation adjustments
      operationId: v3ListPaymentInitiationAdjustments
      x-speakeasy-name-override: ListPaymentInitiationAdjustments
      parameters:
        - $ref: '#/components/parameters/V3PaymentInitiationID'
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3QueryBuilder'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3PaymentInitiationAdjustmentsCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/payment-initiations/{paymentInitiationID}/payments:
    get:
      tags:
        - payments.v3
      summary: List all payments related to a payment initiation
      operationId: v3ListPaymentInitiationRelatedPayments
      x-speakeasy-name-override: ListPaymentInitiationRelatedPayments
      parameters:
        - $ref: '#/components/parameters/V3PaymentInitiationID'
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3QueryBuilder'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3PaymentInitiationRelatedPaymentsCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/pools:
    post:
      tags:
        - payments.v3
      summary: Create a formance pool object
      operationId: v3CreatePool
      x-speakeasy-name-override: CreatePool
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3CreatePoolRequest'
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3CreatePoolResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
    get:
      tags:
        - payments.v3
      summary: List all pools
      operationId: v3ListPools
      x-speakeasy-name-override: ListPools
      parameters:
        - $ref: '#/components/parameters/V3PageSize'
        - $ref: '#/components/parameters/V3Cursor'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3QueryBuilder'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3PoolsCursorResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/pools/{poolID}:
    get:
      tags:
        - payments.v3
      summary: Get a pool by ID
      operationId: v3GetPool
      x-speakeasy-name-override: GetPool
      parameters:
        - $ref: '#/components/parameters/V3PoolID'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3GetPoolResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
    delete:
      tags:
        - payments.v3
      summary: Delete a pool by ID
      operationId: v3DeletePool
      x-speakeasy-name-override: DeletePool
      parameters:
        - $ref: '#/components/parameters/V3PoolID'
      responses:
        "204":
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/pools/{poolID}/balances:
    get:
      tags:
        - payments.v3
      summary: Get pool balances
      operationId: v3GetPoolBalances
      x-speakeasy-name-override: GetPoolBalances
      parameters:
        - $ref: '#/components/parameters/V3PoolID'
        - $ref: '#/components/parameters/V3At'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3PoolBalancesResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
  /v3/pools/{poolID}/accounts/{accountID}:
    post:
      tags:
        - payments.v3
      summary: Add an account to a pool
      operationId: v3AddAccountToPool
      x-speakeasy-name-override: AddAccountToPool
      parameters:
        - $ref: '#/components/parameters/V3PoolID'
        - $ref: '#/components/parameters/V3AccountID'
      responses:
        "204":
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
    delete:
      tags:
        - payments.v3
      summary: Remove an account from a pool
      operationId: v3RemoveAccountFromPool
      x-speakeasy-name-override: RemoveAccountFromPool
      parameters:
        - $ref: '#/components/parameters/V3PoolID'
        - $ref: '#/components/parameters/V3AccountID'
      responses:
        "204":
          description: No Content
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:write
  /v3/tasks/{taskID}:
    get:
      tags:
        - payments.v3
      summary: Get a task and its result by ID
      operationId: v3GetTask
      x-speakeasy-name-override: GetTask
      parameters:
        - $ref: '#/components/parameters/V3TaskID'
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3GetTaskResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3ErrorResponse'
      security:
        - Authorization:
            - payments:read
components:
  responses:
    ServerInfo:
      description: Server information
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServerInfo'
    NoContent:
      description: No content
    PaymentsErrorResponse:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentsErrorResponse'
    Payments:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentsCursor'
    Payment:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentResponse'
    Pools:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PoolsCursor'
    Pool:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PoolResponse'
    PoolBalances:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PoolBalancesResponse'
    TransferInitiations:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TransferInitiationsCursor'
    TransferInitiation:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TransferInitiationResponse'
    Accounts:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccountsCursor'
    Account:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccountResponse'
    AccountBalances:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BalancesCursor'
    ConnectorInstalled:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConnectorResponse'
    Connectors:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConnectorsResponse'
    BankAccounts:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankAccountsCursor'
    BankAccount:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankAccountResponse'
    ConnectorsConfigs:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConnectorsConfigsResponse'
    ConnectorConfig:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConnectorConfigResponse'
    Tasks:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TasksCursor'
    Task:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TaskResponse'
    Transfer:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TransferResponse'
  schemas:
    CursorBase:
      type: object
      required:
        - pageSize
        - hasMore
        - data
      properties:
        pageSize:
          type: integer
          format: int64
          minimum: 1
          maximum: 1000
          example: 15
        hasMore:
          type: boolean
          example: false
        previous:
          type: string
          example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
        next:
          type: string
          example: ""
    PaymentsCursor:
      type: object
      required:
        - cursor
      properties:
        cursor:
          allOf:
            - $ref: '#/components/schemas/CursorBase'
            - type: object
              required:
                - data
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/Payment'
    PoolsCursor:
      type: object
      required:
        - cursor
      properties:
        cursor:
          allOf:
            - $ref: '#/components/schemas/CursorBase'
            - type: object
              required:
                - data
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/Pool'
    TransferInitiationsCursor:
      type: object
      required:
        - cursor
      properties:
        cursor:
          allOf:
            - $ref: '#/components/schemas/CursorBase'
            - type: object
              required:
                - data
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/TransferInitiation'
    BankAccountsCursor:
      type: object
      required:
        - cursor
      properties:
        cursor:
          allOf:
            - $ref: '#/components/schemas/CursorBase'
            - type: object
              required:
                - data
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/BankAccount'
    AccountsCursor:
      type: object
      required:
        - cursor
      properties:
        cursor:
          allOf:
            - $ref: '#/components/schemas/CursorBase'
            - type: object
              required:
                - data
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/Account'
    BalancesCursor:
      type: object
      required:
        - cursor
      properties:
        cursor:
          allOf:
            - $ref: '#/components/schemas/CursorBase'
            - type: object
              required:
                - data
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/AccountBalance'
    TasksCursor:
      type: object
      required:
        - cursor
      properties:
        cursor:
          allOf:
            - $ref: '#/components/schemas/CursorBase'
            - type: object
              required:
                - data
              properties:
                data:
                  type: array
                  items:
                    oneOf:
                      - $ref: '#/components/schemas/TaskStripe'
                      - $ref: '#/components/schemas/TaskWise'
                      - $ref: '#/components/schemas/TaskCurrencyCloud'
                      - $ref: '#/components/schemas/TaskDummyPay'
                      - $ref: '#/components/schemas/TaskModulr'
                      - $ref: '#/components/schemas/TaskBankingCircle'
                      - $ref: '#/components/schemas/TaskMangoPay'
                      - $ref: '#/components/schemas/TaskMoneycorp'
    ConnectorConfigResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/ConnectorConfig'
    PaymentResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/Payment'
    PoolBalancesResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/PoolBalances'
    PoolResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/Pool'
    TransferInitiationResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/TransferInitiation'
    AccountResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/Account'
    ConnectorResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - connectorID
          properties:
            connectorID:
              type: string
    ConnectorsResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            type: object
            required:
              - provider
              - name
              - connectorID
            properties:
              provider:
                $ref: '#/components/schemas/Connector'
              name:
                type: string
              connectorID:
                type: string
              enabled:
                type: boolean
    BankAccountResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/BankAccount'
    ConnectorsConfigsResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - connector
          properties:
            connector:
              type: object
              required:
                - key
              properties:
                key:
                  type: object
                  required:
                    - dataType
                    - required
                  properties:
                    dataType:
                      type: string
                    required:
                      type: boolean
    TaskResponse:
      type: object
      required:
        - data
      properties:
        data:
          oneOf:
            - $ref: '#/components/schemas/TaskStripe'
            - $ref: '#/components/schemas/TaskWise'
            - $ref: '#/components/schemas/TaskCurrencyCloud'
            - $ref: '#/components/schemas/TaskDummyPay'
            - $ref: '#/components/schemas/TaskModulr'
            - $ref: '#/components/schemas/TaskBankingCircle'
            - $ref: '#/components/schemas/TaskMangoPay'
            - $ref: '#/components/schemas/TaskMoneycorp'
    TransferResponse:
      type: object
      properties:
        id:
          type: string
    Connector:
      type: string
      enum:
        - STRIPE
        - DUMMY-PAY
        - WISE
        - MODULR
        - CURRENCY-CLOUD
        - BANKING-CIRCLE
        - MANGOPAY
        - MONEYCORP
        - ATLAR
        - ADYEN
        - GENERIC
    TransferInitiationStatus:
      type: string
      enum:
        - WAITING_FOR_VALIDATION
        - PROCESSING
        - PROCESSED
        - FAILED
        - REJECTED
        - VALIDATED
        - ASK_RETRIED
        - ASK_REVERSED
        - REVERSE_PROCESSING
        - REVERSE_FAILED
        - PARTIALLY_REVERSED
        - REVERSED
    ConnectorConfig:
      anyOf:
        - $ref: '#/components/schemas/StripeConfig'
        - $ref: '#/components/schemas/DummyPayConfig'
        - $ref: '#/components/schemas/WiseConfig'
        - $ref: '#/components/schemas/ModulrConfig'
        - $ref: '#/components/schemas/CurrencyCloudConfig'
        - $ref: '#/components/schemas/BankingCircleConfig'
        - $ref: '#/components/schemas/MangoPayConfig'
        - $ref: '#/components/schemas/MoneycorpConfig'
        - $ref: '#/components/schemas/AtlarConfig'
        - $ref: '#/components/schemas/AdyenConfig'
        - $ref: '#/components/schemas/GenericConfig'
    StripeConfig:
      type: object
      required:
        - name
        - apiKey
      properties:
        name:
          type: string
          example: My Stripe Account
        pollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector will try to fetch new BalanceTransaction objects from Stripe API.
          default: 120s
        apiKey:
          type: string
          example: XXX
        pageSize:
          type: integer
          format: int64
          minimum: 0
          description: |
            Number of BalanceTransaction to fetch at each polling interval.
          default: 10
          example: 50
    DummyPayConfig:
      type: object
      required:
        - name
        - directory
      properties:
        name:
          type: string
          example: My DummyPay Account
        filePollingPeriod:
          type: string
          example: 60s
          description: The frequency at which the connector will try to fetch new payment objects from the directory
          default: 10s
        directory:
          type: string
          example: /tmp/dummypay
        prefixFileToIngest:
          type: string
        numberOfAccountsPreGenerated:
          type: integer
          format: int64
        numberOfPaymentsPreGenerated:
          type: integer
          format: int64
    WiseConfig:
      type: object
      required:
        - name
        - apiKey
      properties:
        name:
          type: string
          example: My Wise Account
        apiKey:
          type: string
          example: XXX
        pollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector will try to fetch new BalanceTransaction objects from Wise API.
          default: 120s
    ModulrConfig:
      type: object
      required:
        - name
        - apiKey
        - apiSecret
      properties:
        name:
          type: string
          example: My Modulr Account
        apiKey:
          type: string
          example: XXX
        apiSecret:
          type: string
          example: XXX
        endpoint:
          type: string
          example: XXX
        pollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector will try to fetch new BalanceTransaction objects from Modulr API.
          default: 120s
    BankingCircleConfig:
      type: object
      required:
        - name
        - username
        - password
        - endpoint
        - authorizationEndpoint
        - userCertificate
        - userCertificateKey
      properties:
        name:
          type: string
          example: My Banking Circle Account
        username:
          type: string
          example: XXX
        password:
          type: string
          example: XXX
        endpoint:
          type: string
          example: XXX
        authorizationEndpoint:
          type: string
          example: XXX
        userCertificate:
          type: string
          example: XXX
        userCertificateKey:
          type: string
          example: XXX
        pollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector will try to fetch new BalanceTransaction objects from Banking Circle API.
          default: 120s
    GenericConfig:
      type: object
      required:
        - name
        - apiKey
        - endpoint
      properties:
        name:
          type: string
          example: My Generic Account
        apiKey:
          type: string
          example: XXX
        endpoint:
          type: string
          example: XXX
        pollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector will try to fetch new BalanceTransaction objects from the API.
          default: 120s
    MangoPayConfig:
      type: object
      required:
        - name
        - clientID
        - apiKey
        - endpoint
      properties:
        name:
          type: string
          example: My MangoPay Account
        pollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector will try to fetch new BalanceTransaction objects from MangoPay API.
          default: 120s
        clientID:
          type: string
          example: XXX
        apiKey:
          type: string
          example: XXX
        endpoint:
          type: string
          example: XXX
    MoneycorpConfig:
      type: object
      required:
        - name
        - clientID
        - apiKey
        - endpoint
      properties:
        name:
          type: string
          example: My Moneycorp Account
        clientID:
          type: string
          example: XXX
        apiKey:
          type: string
          example: XXX
        endpoint:
          type: string
          example: XXX
        pollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector will try to fetch new BalanceTransaction objects from MoneyCorp API.
          default: 120s
    CurrencyCloudConfig:
      type: object
      required:
        - name
        - apiKey
        - loginID
      properties:
        name:
          type: string
          example: My CurrencyCloud Account
        apiKey:
          type: string
          example: XXX
        loginID:
          type: string
          example: XXX
          description: Username of the API Key holder
        pollingPeriod:
          type: string
          example: 60s
          description: The frequency at which the connector will fetch transactions
          default: 120s
        endpoint:
          type: string
          example: XXX
          description: The endpoint to use for the API. Defaults to https://devapi.currencycloud.com
    AdyenConfig:
      type: object
      required:
        - name
        - apiKey
        - hmacKey
      properties:
        name:
          type: string
          example: My Adyen Account
        apiKey:
          type: string
          example: XXX
        hmacKey:
          type: string
          example: XXX
        liveEndpointPrefix:
          type: string
          example: XXX
        pollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector will try to fetch new BalanceTransaction objects from Adyen API.
          default: 120s
    AtlarConfig:
      type: object
      required:
        - name
        - accessKey
        - secret
      properties:
        name:
          type: string
          example: My Atlar Account
        baseUrl:
          type: string
          example: https://api.example.com
          default: https://api.atlar.com
          description: |
            The base URL the client uses for making requests towards the Atlar API.
        pollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector tries to fetch new Transaction objects from the Atlar API.
          default: 120s
        transferInitiationStatusPollingPeriod:
          type: string
          example: 60s
          description: |
            The frequency at which the connector tries to fetch the status of payment initiations from the Atlar API.
          default: 120s
        accessKey:
          type: string
          example: XXX
          description: |
            The access key used by the connector for authorizing requests to the Atlar API.
            You can obtain it along with the associated secret from the Atlar dashboard.
        secret:
          type: string
          example: XXX
          description: |
            The secret used by the connector for authorizing requests to the Atlar API.
            You can obtain it along with the associated access key from the Atlar dashboard.
        pageSize:
          type: integer
          format: int64
          minimum: 0
          description: |
            Number of items to fetch when querying paginated APIs.
          default: 25
          example: 50
    TransferInitiation:
      type: object
      required:
        - id
        - reference
        - createdAt
        - scheduledAt
        - description
        - sourceAccountID
        - destinationAccountID
        - connectorID
        - type
        - amount
        - initialAmount
        - asset
        - status
        - error
      properties:
        id:
          type: string
          example: XXX
        reference:
          type: string
        createdAt:
          type: string
          format: date-time
        scheduledAt:
          type: string
          format: date-time
        description:
          type: string
        sourceAccountID:
          type: string
        destinationAccountID:
          type: string
        connectorID:
          type: string
        type:
          type: string
          enum:
            - TRANSFER
            - PAYOUT
        amount:
          type: integer
          format: bigint
        initialAmount:
          type: integer
          format: bigint
        asset:
          type: string
          example: USD
        status:
          $ref: '#/components/schemas/TransferInitiationStatus'
        error:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
          nullable: true
        relatedPayments:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/TransferInitiationPayments'
        relatedAdjustments:
          type: array
          items:
            $ref: '#/components/schemas/TransferInitiationAdjusments'
    TransferInitiationAdjusments:
      type: object
      required:
        - adjustmentID
        - createdAt
        - status
        - error
      properties:
        adjustmentID:
          type: string
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/TransferInitiationStatus'
        error:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
          nullable: true
    TransferInitiationPayments:
      type: object
      required:
        - paymentID
        - createdAt
        - status
        - error
      properties:
        paymentID:
          type: string
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/TransferInitiationStatus'
        error:
          type: string
    BankAccount:
      type: object
      required:
        - id
        - name
        - createdAt
        - country
      properties:
        id:
          type: string
        name:
          type: string
        createdAt:
          type: string
          format: date-time
        country:
          type: string
        connectorID:
          type: string
        accountID:
          type: string
        provider:
          type: string
        iban:
          type: string
        accountNumber:
          type: string
        swiftBicCode:
          type: string
        relatedAccounts:
          type: array
          items:
            $ref: '#/components/schemas/BankAccountRelatedAccounts'
        metadata:
          $ref: '#/components/schemas/BankAccountMetadata'
    BankAccountRelatedAccounts:
      type: object
      required:
        - id
        - createdAt
        - connectorID
        - provider
        - accountID
      properties:
        id:
          type: string
        createdAt:
          type: string
          format: date-time
        provider:
          type: string
        connectorID:
          type: string
        accountID:
          type: string
    BankAccountMetadata:
      type: object
      additionalProperties:
        type: string
      nullable: true
    Payment:
      type: object
      required:
        - id
        - reference
        - connectorID
        - sourceAccountID
        - destinationAccountID
        - type
        - status
        - initialAmount
        - amount
        - scheme
        - asset
        - createdAt
        - raw
        - adjustments
        - metadata
      properties:
        id:
          type: string
          example: XXX
        reference:
          type: string
        sourceAccountID:
          type: string
        destinationAccountID:
          type: string
        connectorID:
          type: string
        provider:
          $ref: '#/components/schemas/Connector'
        type:
          $ref: '#/components/schemas/PaymentType'
        status:
          $ref: '#/components/schemas/PaymentStatus'
        initialAmount:
          type: integer
          format: bigint
          minimum: 0
          example: 100
        amount:
          type: integer
          format: bigint
          minimum: 0
          example: 100
        scheme:
          $ref: '#/components/schemas/PaymentScheme'
        asset:
          type: string
          example: USD
        createdAt:
          type: string
          format: date-time
        raw:
          type: object
          nullable: true
        adjustments:
          type: array
          items:
            $ref: '#/components/schemas/PaymentAdjustment'
        metadata:
          $ref: '#/components/schemas/PaymentMetadata'
    PaymentAdjustment:
      type: object
      required:
        - reference
        - createdAt
        - amount
        - status
        - raw
      properties:
        reference:
          type: string
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/PaymentStatus'
        amount:
          type: integer
          format: bigint
          minimum: 0
          example: 100
        raw:
          type: object
    PaymentMetadata:
      type: object
      additionalProperties:
        type: string
      nullable: true
    AccountMetadata:
      type: object
      additionalProperties:
        type: string
      nullable: true
    Pool:
      type: object
      required:
        - id
        - name
        - accounts
      properties:
        id:
          type: string
        name:
          type: string
        accounts:
          type: array
          items:
            type: string
    PoolBalances:
      type: object
      required:
        - balances
      properties:
        balances:
          type: array
          items:
            $ref: '#/components/schemas/PoolBalance'
    PoolBalance:
      type: object
      required:
        - amount
        - asset
      properties:
        amount:
          type: integer
          format: bigint
          minimum: 0
          example: 100
        asset:
          type: string
          example: USD
    Account:
      type: object
      required:
        - id
        - createdAt
        - reference
        - connectorID
        - defaultCurrency
        - defaultAsset
        - accountName
        - type
        - metadata
        - raw
      properties:
        id:
          type: string
        createdAt:
          type: string
          format: date-time
        reference:
          type: string
        connectorID:
          type: string
        provider:
          type: string
        defaultCurrency:
          type: string
          deprecated: true
        defaultAsset:
          type: string
        accountName:
          type: string
        type:
          $ref: '#/components/schemas/AccountType'
        pools:
          type: array
          items:
            type: string
        metadata:
          $ref: '#/components/schemas/AccountMetadata'
        raw:
          type: object
          nullable: true
    AccountBalance:
      type: object
      required:
        - accountId
        - createdAt
        - lastUpdatedAt
        - currency
        - asset
        - balance
      properties:
        accountId:
          type: string
        createdAt:
          type: string
          format: date-time
        lastUpdatedAt:
          type: string
          format: date-time
        currency:
          type: string
          deprecated: true
        asset:
          type: string
        balance:
          type: integer
          format: bigint
    TaskBase:
      type: object
      required:
        - id
        - connectorID
        - createdAt
        - updatedAt
        - descriptor
        - status
      properties:
        id:
          type: string
          format: uuid
        connectorID:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/TaskStatus'
        state:
          nullable: true
          type: object
        error:
          type: string
    TaskStatus:
      type: string
      enum:
        - PENDING
        - ACTIVE
        - STOPPED
        - TERMINATED
        - FAILED
    TaskStripe:
      allOf:
        - $ref: '#/components/schemas/TaskBase'
        - type: object
          required:
            - descriptor
          properties:
            descriptor:
              type: object
              required:
                - name
                - account
              properties:
                name:
                  type: string
                main:
                  type: boolean
                account:
                  type: string
    TaskWise:
      allOf:
        - $ref: '#/components/schemas/TaskBase'
        - type: object
          required:
            - descriptor
          properties:
            descriptor:
              type: object
              properties:
                name:
                  type: string
                key:
                  type: string
                profileID:
                  type: integer
                  format: int64
                  minimum: 0
    TaskModulr:
      allOf:
        - $ref: '#/components/schemas/TaskBase'
        - type: object
          required:
            - descriptor
          properties:
            descriptor:
              type: object
              properties:
                name:
                  type: string
                key:
                  type: string
                accountID:
                  type: string
    TaskDummyPay:
      allOf:
        - $ref: '#/components/schemas/TaskBase'
        - type: object
          required:
            - descriptor
          properties:
            descriptor:
              type: object
              properties:
                name:
                  type: string
                key:
                  type: string
                fileName:
                  type: string
    TaskCurrencyCloud:
      allOf:
        - $ref: '#/components/schemas/TaskBase'
        - type: object
          required:
            - descriptor
          properties:
            descriptor:
              type: object
              properties:
                name:
                  type: string
    TaskBankingCircle:
      allOf:
        - $ref: '#/components/schemas/TaskBase'
        - type: object
          required:
            - descriptor
          properties:
            descriptor:
              type: object
              properties:
                name:
                  type: string
                key:
                  type: string
    TaskMangoPay:
      allOf:
        - $ref: '#/components/schemas/TaskBase'
        - type: object
          required:
            - descriptor
          properties:
            descriptor:
              type: object
              properties:
                name:
                  type: string
                key:
                  type: string
                userID:
                  type: string
    TaskMoneycorp:
      allOf:
        - $ref: '#/components/schemas/TaskBase'
        - type: object
          required:
            - descriptor
          properties:
            descriptor:
              type: object
              properties:
                name:
                  type: string
                key:
                  type: string
                accountID:
                  type: string
    TransferRequest:
      type: object
      required:
        - asset
        - amount
        - destination
      properties:
        amount:
          type: integer
          format: bigint
          minimum: 0
          example: 100
        asset:
          type: string
          example: USD
        destination:
          type: string
          example: acct_1Gqj58KZcSIg2N2q
        source:
          type: string
          example: acct_1Gqj58KZcSIg2N2q
    ForwardBankAccountRequest:
      type: object
      required:
        - connectorID
      properties:
        connectorID:
          type: string
    UpdateBankAccountMetadataRequest:
      type: object
      required:
        - metadata
      properties:
        metadata:
          $ref: '#/components/schemas/BankAccountMetadata'
    BankAccountRequest:
      type: object
      required:
        - country
        - connectorID
        - name
      properties:
        country:
          type: string
          example: GB
        connectorID:
          type: string
        name:
          type: string
          example: My account
        accountNumber:
          type: string
        iban:
          type: string
        swiftBicCode:
          type: string
        metadata:
          $ref: '#/components/schemas/BankAccountMetadata'
    AddAccountToPoolRequest:
      type: object
      required:
        - accountID
      properties:
        accountID:
          type: string
    PoolRequest:
      type: object
      required:
        - name
        - accountIDs
      properties:
        name:
          type: string
        accountIDs:
          type: array
          items:
            type: string
    AccountRequest:
      type: object
      required:
        - reference
        - connectorID
        - createdAt
        - type
      properties:
        reference:
          type: string
        connectorID:
          type: string
        createdAt:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/AccountType'
        defaultAsset:
          type: string
        accountName:
          type: string
        metadata:
          $ref: '#/components/schemas/AccountMetadata'
    PaymentRequest:
      type: object
      required:
        - reference
        - connectorID
        - createdAt
        - amount
        - type
        - status
        - scheme
        - asset
      properties:
        reference:
          type: string
        connectorID:
          type: string
        createdAt:
          type: string
          format: date-time
        amount:
          type: integer
          format: bigint
          minimum: 0
          example: 100
        type:
          $ref: '#/components/schemas/PaymentType'
        status:
          $ref: '#/components/schemas/PaymentStatus'
        scheme:
          $ref: '#/components/schemas/PaymentScheme'
        asset:
          type: string
          example: USD
        sourceAccountID:
          type: string
        destinationAccountID:
          type: string
    TransferInitiationRequest:
      type: object
      required:
        - reference
        - scheduledAt
        - description
        - sourceAccountID
        - destinationAccountID
        - type
        - amount
        - asset
        - validated
      properties:
        reference:
          type: string
          example: XXX
        scheduledAt:
          type: string
          format: date-time
        description:
          type: string
        sourceAccountID:
          type: string
        destinationAccountID:
          type: string
        connectorID:
          type: string
        provider:
          $ref: '#/components/schemas/Connector'
        type:
          type: string
          enum:
            - TRANSFER
            - PAYOUT
        amount:
          type: integer
          format: bigint
        asset:
          type: string
          example: USD
        validated:
          type: boolean
        metadata:
          type: object
          additionalProperties:
            type: string
          nullable: true
    ReverseTransferInitiationRequest:
      type: object
      required:
        - reference
        - description
        - amount
        - asset
        - metadata
      properties:
        reference:
          type: string
          example: XXX
        description:
          type: string
        amount:
          type: integer
          format: bigint
        asset:
          type: string
          example: USD
        metadata:
          type: object
          additionalProperties:
            type: string
          nullable: true
    UpdateTransferInitiationStatusRequest:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - WAITING_FOR_VALIDATION
            - PROCESSING
            - PROCESSED
            - FAILED
            - REJECTED
            - VALIDATED
    AccountType:
      type: string
      enum:
        - UNKNOWN
        - INTERNAL
        - EXTERNAL
    PaymentType:
      type: string
      enum:
        - PAY-IN
        - PAYOUT
        - TRANSFER
        - OTHER
    PaymentScheme:
      type: string
      enum:
        - unknown
        - other
        - visa
        - mastercard
        - amex
        - diners
        - discover
        - jcb
        - unionpay
        - alipay
        - cup
        - sepa debit
        - sepa credit
        - sepa
        - apple pay
        - google pay
        - doku
        - dragonpay
        - maestro
        - molpay
        - a2a
        - ach debit
        - ach
        - rtp
    PaymentStatus:
      type: string
      enum:
        - PENDING
        - SUCCEEDED
        - CANCELLED
        - FAILED
        - EXPIRED
        - REFUNDED
        - REFUNDED_FAILURE
        - DISPUTE
        - DISPUTE_WON
        - DISPUTE_LOST
        - OTHER
    PaymentsErrorResponse:
      type: object
      required:
        - errorCode
        - errorMessage
      properties:
        errorCode:
          $ref: '#/components/schemas/PaymentsErrorsEnum'
        errorMessage:
          type: string
          example: '[VALIDATION] missing reference'
    PaymentsErrorsEnum:
      type: string
      enum:
        - INTERNAL
        - VALIDATION
        - NOT_FOUND
      example: VALIDATION
    V3AccountID:
      type: string
    V3AccountsCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3Account'
    V3GetAccountResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3Account'
    V3CreateAccountRequest:
      type: object
      required:
        - reference
        - connectorID
        - createdAt
        - accountName
        - type
      properties:
        reference:
          type: string
        connectorID:
          type: string
          format: byte
        createdAt:
          type: string
          format: date-time
        accountName:
          type: string
        type:
          $ref: '#/components/schemas/V3AccountTypeEnum'
        defaultAsset:
          type: string
          pattern: ^[a-zA-Z]{3}\/[0-9]$
          nullable: true
        metadata:
          $ref: '#/components/schemas/V3Metadata'
    V3CreateAccountResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3Account'
    V3Account:
      type: object
      required:
        - id
        - connectorID
        - provider
        - reference
        - createdAt
        - type
        - raw
      properties:
        id:
          type: string
        connectorID:
          type: string
          format: byte
        provider:
          type: string
        reference:
          type: string
        createdAt:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/V3AccountTypeEnum'
        name:
          type: string
          nullable: true
        defaultAsset:
          type: string
          nullable: true
        metadata:
          $ref: '#/components/schemas/V3Metadata'
        raw:
          type: object
    V3AccountTypeEnum:
      type: string
      enum:
        - UNKNOWN
        - INTERNAL
        - EXTERNAL
    V3BalancesCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3Balance'
    V3Balance:
      type: object
      required:
        - accountID
        - createdAt
        - lastUpdatedAt
        - asset
        - balance
      properties:
        accountID:
          type: string
        createdAt:
          type: string
          format: date-time
        lastUpdatedAt:
          type: string
          format: date-time
        asset:
          type: string
        balance:
          type: integer
          format: bigint
    V3CreateBankAccountRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        accountNumber:
          type: string
        iban:
          type: string
        swiftBicCode:
          type: string
        country:
          type: string
        metadata:
          $ref: '#/components/schemas/V3Metadata'
    V3CreateBankAccountResponse:
      type: object
      required:
        - data
      properties:
        data:
          description: The ID of the created bank account
          type: string
    V3UpdateBankAccountMetadataRequest:
      type: object
      required:
        - metadata
      properties:
        metadata:
          $ref: '#/components/schemas/V3Metadata'
    V3ForwardBankAccountRequest:
      type: object
      required:
        - connectorID
      properties:
        connectorID:
          type: string
          format: byte
    V3ForwardBankAccountResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - taskID
          properties:
            taskID:
              description: |
                Since this call is asynchronous, the response will contain the ID of the task that was created to forward the bank account to the PSP. You can use the task API to check the status of the task and get the resulting bank account ID.
              type: string
    V3BankAccountsCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3BankAccount'
    V3GetBankAccountResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3BankAccount'
    V3BankAccount:
      type: object
      required:
        - id
        - createdAt
        - name
      properties:
        id:
          type: string
        createdAt:
          type: string
          format: date-time
        name:
          type: string
        accountNumber:
          type: string
          nullable: true
        iban:
          type: string
          nullable: true
        swiftBicCode:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        metadata:
          $ref: '#/components/schemas/V3Metadata'
        relatedAccounts:
          type: array
          items:
            $ref: '#/components/schemas/V3BankAccountRelatedAccount'
    V3BankAccountRelatedAccount:
      type: object
      required:
        - accountID
        - createdAt
      properties:
        accountID:
          type: string
        createdAt:
          type: string
          format: date-time
    V3InstallConnectorRequest:
      $ref: '#/components/schemas/V3ConnectorConfig'
    V3InstallConnectorResponse:
      type: object
      required:
        - data
      properties:
        data:
          description: The ID of the created connector
          type: string
    V3UninstallConnectorResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - taskID
          properties:
            taskID:
              description: |
                Since this call is asynchronous, the response will contain the ID of the task that was created to uninstall the connector. You can use the task API to check the status of the task and get the results.
              type: string
    V3ResetConnectorResponse:
      type: object
      required:
        - data
      properties:
        data:
          description: |
            Since this call is asynchronous, the response will contain the ID of the task that was created to reset the connector. You can use the task API to check the status of the task and get the results.
          type: string
    V3ConnectorConfigsResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - connector
          properties:
            connector:
              type: object
              required:
                - key
              properties:
                key:
                  type: object
                  required:
                    - dataType
                    - required
                  properties:
                    dataType:
                      type: string
                    required:
                      type: boolean
    V3GetConnectorConfigResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3ConnectorConfig'
    V3ConnectorsCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3Connector'
    V3ConnectorSchedulesCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3Schedule'
    V3ConnectorScheduleResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3Schedule'
    V3ConnectorScheduleInstancesCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3Instance'
    V3Connector:
      type: object
      required:
        - id
        - reference
        - name
        - createdAt
        - provider
        - scheduledForDeletion
        - config
      properties:
        id:
          type: string
        reference:
          type: string
        name:
          type: string
        createdAt:
          type: string
          format: date-time
        provider:
          type: string
        scheduledForDeletion:
          type: boolean
        config:
          type: object
    V3Schedule:
      type: object
      required:
        - id
        - connectorID
        - createdAt
      properties:
        id:
          type: string
        connectorID:
          type: string
          format: byte
        createdAt:
          type: string
          format: date-time
    V3Instance:
      type: object
      required:
        - id
        - connectorID
        - scheduleID
        - createdAt
        - udpatedAt
        - terminated
      properties:
        id:
          type: string
        connectorID:
          type: string
          format: byte
        scheduleID:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        terminated:
          type: boolean
        terminatedAt:
          type: string
          format: date-time
        error:
          type: string
    V3CreatePaymentRequest:
      type: object
      required:
        - reference
        - connectorID
        - createdAt
        - type
        - initialAmount
        - amount
        - asset
        - scheme
      properties:
        reference:
          type: string
        connectorID:
          type: string
          format: byte
        createdAt:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/V3PaymentTypeEnum'
        initialAmount:
          type: integer
          format: bigint
        amount:
          type: integer
          format: bigint
        asset:
          type: string
          pattern: ^[a-zA-Z]{3}\/[0-9]$
        scheme:
          type: string
        sourceAccountID:
          type: string
          format: byte
        destinationAccountID:
          type: string
          format: byte
        metadata:
          $ref: '#/components/schemas/V3Metadata'
        adjustments:
          type: array
          items:
            $ref: '#/components/schemas/V3CreatePaymentAdjustmentRequest'
    V3CreatePaymentAdjustmentRequest:
      type: object
      required:
        - reference
        - createdAt
        - status
      properties:
        reference:
          type: string
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/V3PaymentStatusEnum'
        amount:
          type: integer
          format: bigint
        asset:
          type: string
          pattern: ^[a-zA-Z]{3}\/[0-9]$
        metadata:
          $ref: '#/components/schemas/V3Metadata'
    V3CreatePaymentResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3Payment'
    V3UpdatePaymentMetadataRequest:
      type: object
      required:
        - metadata
      properties:
        metadata:
          $ref: '#/components/schemas/V3Metadata'
    V3PaymentsCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3Payment'
    V3GetPaymentResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3Payment'
    V3Payment:
      type: object
      required:
        - id
        - connectorID
        - provider
        - reference
        - createdAt
        - type
        - initialAmount
        - amount
        - asset
        - scheme
        - status
      properties:
        id:
          type: string
        connectorID:
          type: string
          format: byte
        provider:
          type: string
        reference:
          type: string
        createdAt:
          type: string
          format: date-time
        type:
          $ref: '#/components/schemas/V3PaymentTypeEnum'
        initialAmount:
          type: integer
          format: bigint
        amount:
          type: integer
          format: bigint
        asset:
          type: string
        scheme:
          type: string
        status:
          $ref: '#/components/schemas/V3PaymentStatusEnum'
        sourceAccountID:
          type: string
          format: byte
          nullable: true
        destinationAccountID:
          type: string
          format: byte
          nullable: true
        metadata:
          $ref: '#/components/schemas/V3Metadata'
        adjustments:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/V3PaymentAdjustment'
    V3PaymentAdjustment:
      type: object
      required:
        - id
        - reference
        - createdAt
        - status
        - raw
      properties:
        id:
          type: string
        reference:
          type: string
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/V3PaymentStatusEnum'
        amount:
          type: integer
          format: bigint
        asset:
          type: string
        metadata:
          $ref: '#/components/schemas/V3Metadata'
        raw:
          type: object
    V3PaymentTypeEnum:
      type: string
      enum:
        - UNKNOWN
        - PAY-IN
        - PAYOUT
        - TRANSFER
        - OTHER
    V3PaymentStatusEnum:
      type: string
      enum:
        - UNKNOWN
        - PENDING
        - SUCCEEDED
        - CANCELLED
        - FAILED
        - EXPIRED
        - REFUNDED
        - REFUNDED_FAILURE
        - REFUND_REVERSED
        - DISPUTE
        - DISPUTE_WON
        - DISPUTE_LOST
        - AMOUNT_ADJUSTEMENT
        - AUTHORISATION
        - CAPTURE
        - CAPTURE_FAILED
        - OTHER
    V3InitiatePaymentRequest:
      type: object
      required:
        - reference
        - scheduledAt
        - connectorID
        - description
        - type
        - amount
        - asset
      properties:
        reference:
          type: string
          minLength: 3
          maxLength: 1000
        scheduledAt:
          type: string
          format: date-time
        connectorID:
          type: string
          format: byte
        description:
          type: string
          maxLength: 10000
        type:
          $ref: '#/components/schemas/V3PaymentInitiationTypeEnum'
        amount:
          type: integer
          format: bigint
        asset:
          type: string
          pattern: ^[a-zA-Z]{3}\/[0-9]$
        sourceAccountID:
          type: string
          format: byte
          nullable: true
        destinationAccountID:
          type: string
          format: byte
        metadata:
          $ref: '#/components/schemas/V3Metadata'
    V3InitiatePaymentResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          properties:
            paymentInitiationID:
              description: |
                Related payment initiation object ID created.
              type: string
            taskID:
              description: |
                Will be filled if the noValidation query parameter is set to true. Since this call is asynchronous, the response will contain the ID of the task that was created to create the payment on the PSP. You can use the task API to check the status of the task and get the resulting payment ID
              type: string
    V3RetryPaymentInitiationResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - taskID
          properties:
            taskID:
              description: |
                Since this call is asynchronous, the response will contain the ID of the task that was created to retry the payment initiation to the PSP. You can use the task API to check the status of the task and get the resulting payment ID.
              type: string
    V3ApprovePaymentInitiationResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - taskID
          properties:
            taskID:
              description: |
                Since this call is asynchronous, the response will contain the ID of the task that was created to approve the payment initiation. You can use the task API to check the status of the task and get the resulting payment ID.
              type: string
    V3ReversePaymentInitiationRequest:
      type: object
      required:
        - reference
        - description
        - amount
        - asset
      properties:
        reference:
          type: string
          minLength: 3
          maxLength: 1000
        description:
          type: string
          maxLength: 10000
        amount:
          type: integer
          format: bigint
        asset:
          type: string
          pattern: ^[a-zA-Z]{3}\/[0-9]$
        metadata:
          $ref: '#/components/schemas/V3Metadata'
    V3ReversePaymentInitiationResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          properties:
            taskID:
              description: |
                Since this call is asynchronous, the response will contain the ID of the task that was created to reverse the payment initiation. You can use the task API to check the status of the task and get the resulting payment ID.
              type: string
            paymentInitiationReversalID:
              description: |
                Related payment initiation reversal object ID created.
              type: string
    V3PaymentInitiationsCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3PaymentInitiation'
    V3PaymentInitiationAdjustmentsCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3PaymentInitiationAdjustment'
    V3PaymentInitiationRelatedPaymentsCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3Payment'
    V3PaymentInitiation:
      type: object
      required:
        - id
        - connectorID
        - reference
        - createdAt
        - scheduledAt
        - description
        - type
        - amount
        - asset
        - status
      properties:
        id:
          type: string
        connectorID:
          type: string
          format: byte
        reference:
          type: string
        createdAt:
          type: string
          format: date-time
        scheduledAt:
          type: string
          format: date-time
        description:
          type: string
        type:
          $ref: '#/components/schemas/V3PaymentInitiationTypeEnum'
        amount:
          type: integer
          format: bigint
        asset:
          type: string
        status:
          $ref: '#/components/schemas/V3PaymentInitiationStatusEnum'
        sourceAccountID:
          type: string
          format: byte
        destinationAccountID:
          type: string
          format: byte
        error:
          type: string
        metadata:
          $ref: '#/components/schemas/V3Metadata'
    V3PaymentInitiationAdjustment:
      type: object
      required:
        - id
        - createdAt
        - status
      properties:
        id:
          type: string
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/V3PaymentInitiationStatusEnum'
        amount:
          type: integer
          format: bigint
        asset:
          type: string
        error:
          type: string
        metadata:
          $ref: '#/components/schemas/V3Metadata'
    V3GetPaymentInitiationResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3PaymentInitiation'
    V3PaymentInitiationStatusEnum:
      type: string
      enum:
        - UNKNOWN
        - WAITING_FOR_VALIDATION
        - PROCESSING
        - PROCESSED
        - FAILED
        - REJECTED
        - REVERSE_PROCESSING
        - REVERSE_FAILED
        - REVERSED
    V3PaymentInitiationTypeEnum:
      type: string
      enum:
        - UNKNOWN
        - TRANSFER
        - PAYOUT
    V3CreatePoolRequest:
      type: object
      required:
        - name
        - accountIDs
      properties:
        name:
          type: string
        accountIDs:
          type: array
          items:
            type: string
    V3CreatePoolResponse:
      type: object
      required:
        - data
      properties:
        data:
          description: The ID of the created pool
          type: string
    V3PoolsCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ""
            data:
              type: array
              items:
                $ref: '#/components/schemas/V3Pool'
    V3GetPoolResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3Pool'
    V3PoolBalancesResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3PoolBalances'
    V3Pool:
      type: object
      required:
        - id
        - name
        - createdAt
        - poolAccounts
      properties:
        id:
          type: string
        name:
          type: string
        createdAt:
          type: string
          format: date-time
        poolAccounts:
          type: array
          items:
            $ref: '#/components/schemas/V3AccountID'
    V3PoolBalances:
      type: array
      items:
        $ref: '#/components/schemas/V3PoolBalance'
    V3PoolBalance:
      type: object
      required:
        - asset
        - amount
      properties:
        asset:
          type: string
        amount:
          type: integer
          format: bigint
    V3GetTaskResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/V3Task'
    V3Task:
      type: object
      required:
        - id
        - status
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        status:
          $ref: '#/components/schemas/V3TaskStatusEnum'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        connectorID:
          type: string
          format: byte
        createdObjectID:
          type: string
        error:
          type: string
    V3TaskStatusEnum:
      type: string
      enum:
        - PROCESSING
        - SUCCEEDED
        - FAILED
    V3QueryBuilder:
      type: object
      additionalProperties: true
    V3Metadata:
      type: object
      additionalProperties:
        type: string
      nullable: true
    V3ErrorResponse:
      type: object
      required:
        - errorCode
        - errorMessage
      properties:
        errorCode:
          $ref: '#/components/schemas/V3ErrorsEnum'
        errorMessage:
          type: string
          example: '[VALIDATION] missing required config field: pollingPeriod'
        details:
          type: string
    V3ErrorsEnum:
      type: string
      enum:
        - INTERNAL
        - VALIDATION
        - INVALID_ID
        - MISSING_OR_INVALID_BODY
        - CONFLICT
        - NOT_FOUND
      example: VALIDATION
    V3ConnectorConfig:
      anyOf:
        - $ref: '#/components/schemas/V3AdyenConfig'
        - $ref: '#/components/schemas/V3AtlarConfig'
        - $ref: '#/components/schemas/V3BankingcircleConfig'
        - $ref: '#/components/schemas/V3CurrencycloudConfig'
        - $ref: '#/components/schemas/V3DummypayConfig'
        - $ref: '#/components/schemas/V3GenericConfig'
        - $ref: '#/components/schemas/V3MangopayConfig'
        - $ref: '#/components/schemas/V3ModulrConfig'
        - $ref: '#/components/schemas/V3MoneycorpConfig'
        - $ref: '#/components/schemas/V3StripeConfig'
        - $ref: '#/components/schemas/V3WiseConfig'
    V3AdyenConfig:
      type: object
      required:
        - name
        - apiKey
        - companyID
      properties:
        apiKey:
          type: string
        companyID:
          type: string
        liveEndpointPrefix:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
        webhookPassword:
          type: string
        webhookUsername:
          type: string
    V3AtlarConfig:
      type: object
      required:
        - name
        - baseURL
        - accessKey
        - secret
      properties:
        accessKey:
          type: string
        baseURL:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
        secret:
          type: string
    V3BankingcircleConfig:
      type: object
      required:
        - name
        - username
        - password
        - endpoint
        - authorizationEndpoint
        - userCertificate
        - userCertificateKey
      properties:
        authorizationEndpoint:
          type: string
        endpoint:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        password:
          type: string
        pollingPeriod:
          type: string
          default: 2m
        userCertificate:
          type: string
        userCertificateKey:
          type: string
        username:
          type: string
    V3CurrencycloudConfig:
      type: object
      required:
        - name
        - loginID
        - apiKey
        - endpoint
      properties:
        apiKey:
          type: string
        endpoint:
          type: string
        loginID:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
    V3DummypayConfig:
      type: object
      required:
        - name
        - directory
      properties:
        directory:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
    V3GenericConfig:
      type: object
      required:
        - name
        - apiKey
        - endpoint
      properties:
        apiKey:
          type: string
        endpoint:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
    V3MangopayConfig:
      type: object
      required:
        - name
        - clientID
        - apiKey
        - endpoint
      properties:
        apiKey:
          type: string
        clientID:
          type: string
        endpoint:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
    V3ModulrConfig:
      type: object
      required:
        - name
        - apiKey
        - apiSecret
        - endpoint
      properties:
        apiKey:
          type: string
        apiSecret:
          type: string
        endpoint:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
    V3MoneycorpConfig:
      type: object
      required:
        - name
        - clientID
        - apiKey
        - endpoint
      properties:
        apiKey:
          type: string
        clientID:
          type: string
        endpoint:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
    V3StripeConfig:
      type: object
      required:
        - name
        - apiKey
      properties:
        apiKey:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
    V3WiseConfig:
      type: object
      required:
        - name
        - apiKey
        - webhookPublicKey
      properties:
        apiKey:
          type: string
        name:
          type: string
        pageSize:
          type: integer
          default: "25"
        pollingPeriod:
          type: string
          default: 2m
        webhookPublicKey:
          type: string
  parameters:
    Query:
      name: query
      in: query
      required: false
      description: |
        Filters used to filter resources.
      schema:
        type: string
    PageSize:
      name: pageSize
      in: query
      description: |
        The maximum number of results to return per page.
      example: 100
      schema:
        type: integer
        format: int64
        minimum: 1
        maximum: 1000
        default: 15
    Cursor:
      name: cursor
      in: query
      description: |
        Parameter used in pagination requests. Maximum page size is set to 15.
        Set to the value of next for the next page of results.
        Set to the value of previous for the previous page of results.
        No other parameters can be set when this parameter is set.
      schema:
        type: string
        example: aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
    Sort:
      name: sort
      in: query
      schema:
        type: array
        items:
          type: string
      description: Fields used to sort payments (default is date:desc).
      example:
        - date:asc
        - status:desc
    PaymentId:
      name: paymentId
      in: path
      schema:
        type: string
      description: The payment ID.
      example: XXX
      required: true
    AccountId:
      name: accountId
      in: path
      schema:
        type: string
      description: The account ID.
      example: XXX
      required: true
    ConnectorID:
      name: connectorId
      in: path
      schema:
        type: string
      description: The connector ID.
      example: XXX
      required: true
    PoolId:
      name: poolId
      in: path
      schema:
        type: string
      description: The pool ID.
      example: XXX
      required: true
    TransferId:
      name: transferId
      in: path
      schema:
        type: string
      description: The transfer ID.
      example: XXX
      required: true
    BankAccountId:
      name: bankAccountId
      in: path
      schema:
        type: string
      description: The bank account ID.
      example: XXX
      required: true
    Connector:
      name: connector
      description: The name of the connector.
      in: path
      schema:
        $ref: '#/components/schemas/Connector'
      required: true
    TaskId:
      name: taskId
      description: The task ID.
      example: task1
      in: path
      schema:
        type: string
      required: true
    V3AccountID:
      name: accountID
      in: path
      required: true
      description: The account ID
      schema:
        type: string
    V3BankAccountID:
      name: bankAccountID
      in: path
      required: true
      description: The bank account ID
      schema:
        type: string
    V3PaymentID:
      name: paymentID
      in: path
      required: true
      description: The payment ID
      schema:
        type: string
    V3PaymentInitiationID:
      name: paymentInitiationID
      in: path
      required: true
      description: The payment initiation ID
      schema:
        type: string
    V3ConnectorID:
      name: connectorID
      in: path
      required: true
      description: The connector ID
      schema:
        type: string
    V3ScheduleID:
      name: scheduleID
      in: path
      required: true
      description: The schedule ID
      schema:
        type: string
    V3PoolID:
      name: poolID
      in: path
      required: true
      description: The pool ID
      schema:
        type: string
    V3TaskID:
      name: taskID
      in: path
      required: true
      description: The task ID
      schema:
        type: string
    V3Connector:
      name: connector
      in: path
      required: true
      description: The connector to filter by
      schema:
        type: string
    V3NoValidation:
      name: noValidation
      in: query
      required: false
      description: |
        If set to true, the request will not have to be validated. This is useful if we want to directly forward the request to the PSP.
      schema:
        type: boolean
        default: false
    V3At:
      name: at
      in: query
      required: false
      description: The time to filter by
      schema:
        type: string
        format: date-time
    V3Asset:
      name: asset
      in: query
      required: false
      description: The asset to filter by
      schema:
        type: string
    V3FromTimestamp:
      name: fromTimestamp
      in: query
      required: false
      description: The start of the time range to filter by
      schema:
        type: string
        format: date-time
    V3ToTimestamp:
      name: toTimestamp
      in: query
      required: false
      description: The end of the time range to filter by
      schema:
        type: string
        format: date-time
    V3PageSize:
      name: pageSize
      in: query
      description: The number of items to return
      required: false
      example: 100
      schema:
        type: integer
        format: int64
        minimum: 1
        maximum: 1000
    V3Cursor:
      name: cursor
      in: query
      required: false
      description: |
        Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.
      example: aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
      schema:
        type: string
  requestBodies:
    ConnectorConfig:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConnectorConfig'
    UpdateMetadata:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentMetadata'
    Payment:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentRequest'
    Account:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccountRequest'
    Pool:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PoolRequest'
    AddAccountToPool:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AddAccountToPoolRequest'
    TransferInitiation:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TransferInitiationRequest'
    ForwardBankAccount:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForwardBankAccountRequest'
    UpdateBankAccountMetadata:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateBankAccountMetadataRequest'
    BankAccount:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankAccountRequest'
    UpdateTransferInitiationStatus:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateTransferInitiationStatusRequest'
    ReverseTransferInitiation:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ReverseTransferInitiationRequest'
    Transfer:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TransferRequest'