token-io Settlement Accounts API

These endpoints provide authorized access to an authenticated user's settlement account information, enabling you to create settlement accounts, retrieve settlement account details, transactions and payouts, and manage settlement rules.

OpenAPI Specification

token-io-settlement-accounts-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Token.io's Open Banking API for TPPs Account on File Settlement Accounts API
  description: '<b>Token.io''s Open Banking API</b><br/><br/>Token.io Support: <a href="https://support.token.io" target="_blank">support.token.io</a><br/><br/>The Token.io Open Banking API enables you to connect securely with banks for a range of services.<br/><br/> Using our API you can: <ul><li>provide authorized access to an authenticated user''s account information</li><li>get information on specific banks</li><li>initiate authorization with a user-selected bank</li><li>initate and track single immediate payments and future dated payments</li><li>use variable recurring payments (VRP) to grant long-held consents to Payment Initiation Service Providers (PISPs) to initiate series of payments from users'' bank accounts</li><li>carry out settlements, payments and refunds using our settlement accounts</li></ul><br/>For more information see our <a href="https://developer.token.io/token_rest_api_doc/content/e-rest/dashboard-intro.htm" target="_blank">developer documentation</a>.'
  version: ''
servers:
- url: https://api.token.io
tags:
- name: Settlement Accounts
  description: These endpoints provide authorized access to an authenticated user's settlement account information, enabling you to create settlement accounts, retrieve settlement account details, transactions and payouts, and manage settlement rules.
  x-internal: true
paths:
  /virtual-accounts:
    post:
      tags:
      - Settlement Accounts
      summary: Create a settlement account
      description: The `POST /virtual-accounts` endpoint creates a settlement account.
      operationId: GatewayService.CreateVirtualAccount
      x-internal: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVirtualAccountRequest'
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualAccountResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '404':
          $ref: '#/components/responses/CustomerNotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
    get:
      tags:
      - Settlement Accounts
      summary: Get settlement accounts
      description: The `GET /virtual-accounts` endpoint retrieves information for all settlement accounts.
      operationId: GatewayService.GetVirtualAccounts
      x-internal: true
      parameters:
      - name: limit
        in: query
        required: false
        description: The maximum number of records to return. <br/>The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200.
        schema:
          format: int32
          type: integer
      - name: offset
        in: query
        required: false
        description: The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value from the previous page response. <br/>The offset value should not be parsed and/or understood in any way.
        schema:
          type: string
      - name: currency
        in: query
        required: false
        description: The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> three letter currency code.
        example: EUR
        schema:
          type: string
      - name: country
        in: query
        required: false
        description: Two-letter country code in upper case (ISO 3166-1 alpha-2).
        example: PL
        schema:
          type: string
      - name: nickname
        in: query
        required: false
        description: The alias name that identifies the settlement account.
        example: Account Alias
        schema:
          type: string
      - name: onBehalfOfId
        in: query
        description: The id of the ultimate client on whose behalf the account is created. If the account is created on behalf of a sub-TPP, this field should contain the sub-TPP `referenceId`. This field is mandatory for unregulated TPPs.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: c5a863bc-86f2-4418-a26f-25b24c7983c7
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualAccountsResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '404':
          $ref: '#/components/responses/CustomerNotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
  /virtual-accounts/{accountId}:
    get:
      tags:
      - Settlement Accounts
      summary: Get a settlement account
      description: The `GET /virtual-accounts/{accountId}` endpoint the information, for a given settlement account.
      operationId: GatewayService.GetVirtualAccountById
      x-internal: true
      parameters:
      - name: accountId
        in: path
        description: The system-generated, unique id which specifies the settlement account.
        required: true
        schema:
          type: string
      - name: onBehalfOfId
        in: query
        description: Filters payments by the `onBehalfOfId` value - returns only payments with the `onBehalfOfId` value specified in this parameter.  This field is mandatory for unregulated TPPs.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: c5a863bc-86f2-4418-a26f-25b24c7983c7
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualAccountByIdResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '404':
          $ref: '#/components/responses/AccountNotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
  /virtual-accounts/{accountId}/transactions:
    get:
      tags:
      - Settlement Accounts
      summary: Get settlement account transactions
      description: The `GET /virtual-accounts/{accountId}/transactions` endpoint retrieves transcation information in a given settlement account.
      operationId: GatewayService.GetVirtualAccountTransactions
      x-internal: true
      parameters:
      - name: accountId
        in: path
        description: The system-generated, unique id which specifies the settlement account.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: The maximum number of records to return. <br/>The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200.
        schema:
          format: int32
          type: integer
      - name: offset
        in: query
        required: false
        description: The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value from the previous page response. <br/>The offset value should not be parsed and/or understood in any way.
        schema:
          type: string
      - name: refId
        in: query
        required: false
        description: Filters transactions by their `refId` value - returns only transactions with `refId` mentioned in the reference.
        schema:
          type: string
      - name: startDate
        in: query
        description: Returns transactions created on or after this date, inclusive (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).
        required: false
        schema:
          type: string
        example: '2022-04-05'
      - name: endDate
        in: query
        description: Returns transactions created on or before this date, inclusive (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).
        required: false
        schema:
          type: string
        example: '2022-04-05'
      - name: amount
        in: query
        required: false
        description: Filters transactions by their transaction amount.
        schema:
          type: string
      - name: providerPaymentId
        in: query
        required: false
        description: Filters transactions by the provider-payment-id.
        schema:
          type: string
      - name: transactionType
        in: query
        required: false
        description: Filters transactions by type to include only CREDIT or DEBIT transactions.
        schema:
          $ref: '#/components/schemas/TransactionType'
        example: CREDIT
      - name: onBehalfOfId
        in: query
        description: Filters payments by the `onBehalfOfId` value - returns only payments with `onBehalfOfId` specified in this parameter. This field is mandatory for unregulated TPPs.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: c5a863bc-86f2-4418-a26f-25b24c7983c7
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualAccountTransactionsResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '404':
          $ref: '#/components/responses/AccountNotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
  /virtual-accounts/{accountId}/transactions/{providerPaymentId}:
    get:
      tags:
      - Settlement Accounts
      summary: Get a settlement account transaction
      description: The `GET /virtual-accounts/{accountId}/transactions/{providerPaymentId}` endpoint retrieves information for a specific transaction in a given settlement account.
      operationId: GatewayService.GetVirtualAccountTransaction
      x-internal: true
      parameters:
      - name: accountId
        in: path
        description: The system-generated, unique id which specifies the settlement account.
        required: true
        schema:
          type: string
      - name: providerPaymentId
        in: path
        description: The settlement account provider-assigned unique transaction identifier.
        required: true
        schema:
          type: string
      - name: onBehalfOfId
        in: query
        description: Filters payments by the `onBehalfOfId` value - returns only payments with `onBehalfOfId` specified in this parameter. This field is mandatory for unregulated TPPs.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: c5a863bc-86f2-4418-a26f-25b24c7983c7
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualAccountTransactionResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '404':
          $ref: '#/components/responses/AccountNotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
  /virtual-accounts/{accountId}/settlement-rule:
    post:
      tags:
      - Settlement Accounts
      summary: Create a settlement rule
      description: The `POST /virtual-accounts/{accountId}/settlement-rule` endpoint creates a settlement rule, for a given settlement account.
      operationId: GatewayService.CreateVirtualAccountSettlementRule
      x-internal: true
      parameters:
      - name: accountId
        in: path
        description: The system-generated, unique id which specifies the settlement account.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVirtualAccountSettlementRuleRequest'
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVirtualAccountSettlementRuleResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '404':
          $ref: '#/components/responses/AccountNotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
  /virtual-accounts/{accountId}/settlement-rules:
    get:
      tags:
      - Settlement Accounts
      summary: Get settlement rules
      description: The `GET /virtual-accounts/{accountId}/settlement-rules` endpoint retrieves information about settlement rules, for a given settlement account, according to the settlement rule status in the request. If no status is provided, the endpoint retrieves all settlement rules for the settlement account.
      operationId: GatewayService.GetVirtualAccountSettlementRules
      x-internal: true
      parameters:
      - name: accountId
        description: The system-generated, unique id which specifies the settlement account.
        required: true
        in: path
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetVirtualAccountSettlementRulesRequest'
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualAccountSettlementRulesResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
  /virtual-accounts/{accountId}/settlement-rules/{settlementRuleId}:
    get:
      tags:
      - Settlement Accounts
      summary: Get a settlement rule
      description: The `GET /virtual-accounts/{accountId}/settlement-rules/{settlementRuleId}` endpoint retrieves information for a specific settlement rule, for a given settlement account.
      operationId: GatewayService.GetVirtualAccountSettlementRule
      x-internal: true
      parameters:
      - name: accountId
        description: The system-generated, unique id which specifies the settlement account.
        in: path
        required: true
        schema:
          type: string
      - name: settlementRuleId
        description: The id of the settlement rule.
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualAccountSettlementRuleResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '404':
          $ref: '#/components/responses/SettlementRuleNotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
    delete:
      tags:
      - Settlement Accounts
      summary: Delete a settlement rule
      description: The ` DELETE /virtual-accounts/{accountId}/settlement-rules/{settlementRuleId}` endpoint delete an active settlement rule, for a given settlement account.
      operationId: GatewayService.DeleteVirtualAccountSettlementRule
      x-internal: true
      parameters:
      - name: accountId
        description: The system-generated, unique id which specifies the settlement account.
        in: path
        required: true
        schema:
          type: string
      - name: settlementRuleId
        description: The id of the settlement rule.
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteVirtualAccountSettlementRuleResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '404':
          $ref: '#/components/responses/SettlementRuleNotFoundResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
  /virtual-accounts/{accountId}/settlement-rule-payouts:
    get:
      tags:
      - Settlement Accounts
      summary: Get settlement account payouts
      description: The `GET /virtual-accounts/{accountId}/settlement-rule-payouts` endpoint retrieves information about payouts created by a settlement rule, for a given settlement account.
      operationId: GatewayService.GetVirtualAccountSettlementPayouts
      x-internal: true
      parameters:
      - name: accountId
        description: The system-generated, unique id which specifies the settlement account.
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetVirtualAccountSettlementPayoutsRequest'
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVirtualAccountSettlementPayoutsResponse'
        '400':
          $ref: '#/components/responses/InvalidArgumentRequest'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/PermissionDeniedResponse'
        '429':
          $ref: '#/components/responses/TooManyRequestsResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableResponse'
        '504':
          $ref: '#/components/responses/GatewayTimeoutResponse'
      deprecated: false
      security:
      - Bearer: []
      - BasicAuth: []
      x-hideTryItPanel: true
components:
  schemas:
    inline_response_500:
      properties:
        error:
          allOf:
          - type: object
            properties:
              errorCode:
                type: string
                description: This is a textual error code categorising the error.
                example: InternalServerError
          - $ref: '#/components/schemas/ServerError'
    PLIbanAccount:
      title: PLIbanAccount
      required:
      - iban
      type: object
      properties:
        iban:
          type: string
          description: The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
          example: GB29NWBK60161331926819
        bic:
          type: string
          description: The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long."
          example: BOFIIE2D
      description: Polish account details where the iban is required and the bic is optional.
    TokenizedAccountIdentifier:
      type: object
      properties:
        tokenizedAccountId:
          type: string
          description: Account on File identifier.
      required:
      - tokenizedAccountId
      additionalProperties: false
    inline_response_400:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Error'
    GetVirtualAccountSettlementPayoutsResponse:
      type: object
      properties:
        pageInfo:
          $ref: '#/components/schemas/PageInfo'
        payouts:
          items:
            type: array
            $ref: '#/components/schemas/SettlementRulePayout'
      description: Contains the response of the get settlement payouts request.
    VirtualAccount:
      type: object
      properties:
        accountId:
          type: string
          description: The system-generated, unique id which specifies the settlement account.
          example: pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV
        accountName:
          type: string
          description: The name of this account.
          example: Account Name
        accountNickName:
          type: string
          description: The alias name that identifies the settlement account.
          example: Account Alias
        accountNumber:
          type: string
          description: The unique identifier for the bank account in the UK or Ireland.
          example: '12345678'
        availableBalance:
          type: string
          description: The available account balance at the time of the query. For example, the previous day's closing balance +/- transactions during the day, and any overdraft facilities.
          example: 1572.38
        bic:
          type: string
          description: The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long."
          example: BOFIIE2D
        bookedBalance:
          type: string
          description: The account balance pending clearance, which may include uncleared items and any transactions yet to settle.
          example: 1282.79
        clearedBalance:
          type: string
          description: The cash balance in an account that can be immediately withdrawn or used in financial transactions. Until funds have cleared, they're considered to be pending and customers are unable to use them in transactions.
          example: 1167.32
        country:
          type: string
          description: Two-letter country code in upper case (ISO 3166-1 alpha-2).
          example: GB
        createdDateTime:
          type: string
          description: The date this account was created (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).
          format: string
          example: '2023-04-05T10:43:07.000+00:00'
        currency:
          type: string
          description: The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> three letter currency code.
          example: EUR
        iban:
          type: string
          description: The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
          example: GB29NWBK60161331926819
        sortCode:
          type: string
          description: The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland.
          example: 123456
        status:
          $ref: '#/components/schemas/VirtualAccount.Status'
        updatedDateTime:
          type: string
          description: The date and time this account was last updated (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).
          format: string
        onBehalfOfId:
          type: string
          description: The id of the ultimate client on whose behalf the account is created. If the account is created on behalf of a sub-TPP, this field will contain the sub-TPP `referenceId`. This field is mandatory for unregulated TPPs.
          example: c5a863bc-86f2-4418-a26f-25b24c7983c7
    GetVirtualAccountSettlementPayoutsRequest:
      type: object
      properties:
        accountId:
          type: string
          description: The settlement account id.
          example: pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV
        limit:
          type: integer
          description: The maximum number of items to return in the response.
          format: int32
          example: 10
        offset:
          type: string
          description: The offset of the first item to return in the response.
          example: LerV6Jmex
        settlementRuleId:
          type: string
          description: The id of the settlement rule.
          example: 123e4567-e89b-12d3-a456-426614174000
        startDate:
          type: string
          description: The start date of the settlement rule payout.
          example: '2024-01-01'
        endDate:
          type: string
          description: The end date of the settlement rule payout.
          example: '2024-12-01'
        ids:
          type: array
          items:
            type: string
          description: The list of payout ids.
          example:
          - 123e4567-e89b-12d3-a456-426614174000
        invertIds:
          type: boolean
          description: If true, the response will contain all settlement rule payouts except those specified in the `ids` field.
          example: false
        statuses:
          type: array
          items:
            type: string
          description: The list of payout statuses.
          example:
          - INITIATION_PENDING
          - INITIATION_PROCESSING
        invertStatuses:
          type: boolean
          description: If true, the response will contain all settlement rule payouts except those specified in the `statuses` field.
          example: false
        refIds:
          type: array
          items:
            type: string
          description: The list of settlement payout reference ids.
          example:
          - ShBdcTeqFabqJJhUF
      description: Contains the request payload to get settlement payouts.
    VirtualAccount.Status:
      example: ACTIVE
      default: INVALID
      type: string
      enum:
      - INVALID
      - ACTIVE
      - CLOSED
      - BLOCKED
      - CLIENT_BLOCKED
    PayoutInitiation:
      required:
      - amount
      - paymentType
      - refId
      - debtor
      - creditor
      - description
      type: object
      properties:
        description:
          type: string
          description: The payment reference, which must consist of at least 6 alphanumeric characters that are not all the same. Optional, uncounted characters include space, hyphen(-), full stop (.), ampersand(&), and forward slash (/). The total of all characters must be no greater than 18 for SCAN (Sort Code and Accou

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/token-io/refs/heads/main/openapi/token-io-settlement-accounts-api-openapi.yml