> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payaza.africa/llms.txt
> Use this file to discover all available pages before exploring further.

# Fetch Split Accounts

> This retrieves all split settlement accounts belonging to the authenticated merchant.



## OpenAPI

````yaml /openapi.json get /settlement/settlement/merchant/split-account?page=&size=
openapi: 3.0.1
info:
  title: Payaza Documentation
  version: 2.0.0
  description: >-
    API reference for processing payments using Card, Bank Transfer, USSD, and
    QR Code methods.
servers:
  - url: https://api.payaza.africa/live
security:
  - ApiKeyAuth: []
  - TenantID: []
  - ProductID: []
tags:
  - name: Transfers
    description: >-
      Transfers are transactions made from your Payaza account to beneficiaries.
      Merchants can instantly transfer funds from their available balance. For
      every transfer, you need to specify the amount and the beneficiary’s
      details. You become eligible to make transfers after you have been
      verified. (you sign up, finish account activation and KYC verification).
  - name: Payaza Account
    description: >-
      This is our internal account that can be used to make payouts to other
      bank accounts, in single or in bulk. The Payaza account can also be used
      to receive settlements. It can also be used to track the transfer status
      of your transactions and check your balance instantly
  - name: Sub Accounts
    description: >-
      This enables you to establish Sub Payaza accounts for your customers. Each
      sub-account comes with an assigned static virtual account, facilitating
      direct funding for individual accounts. Furthermore, the Main Payaza
      account can directly initiate funding for each sub-account. These
      sub-accounts serve the purpose of managing unique account positions or
      balances and facilitating disbursements from these positions to specified
      beneficiaries.
  - name: EUR Accounts
    description: >-
      This endpoints enable you to create EUR subaccounts which can be used to
      make transfers as required .
  - name: Apple Pay and Google Pay
    description: >-
      Apple Pay and Google Pay give your customers a fast, familiar, and secure
      way to complete payments. Our APIs provide a gateway to provide these
      services to your users for a smooth payment experience.
  - name: Virtual Accounts
    description: >-
      Virtual Accounts are bank accounts that are created for a specific purpose
      and last for specified durations. Virtual accounts are issued by Payaza’s
      partner banks. Our virtual account APIs can be used to create virtual
      accounts and perform other tasks relevant to virtual accounts. Virtual
      accounts are created to foster easy payment collections for your business
      and platform. 

      Static/Reserved Account: This virtual account is created by the merchant
      and remains valid indefinitely. It can be used multiple times and does not
      expire. 

      Dynamic Account: This virtual account is generated for a specific
      transaction or purpose. Please note that dynamic virtual account remains
      valid for a temporary period of time or until a payment of the specified
      amount is received. Upon expiry, a merchant can generate another one for a
      different purpose.
  - name: Card Collection
    description: >-
      The Card Collection APIs can be used to make card transactions, refund
      transactions that have been performed, check the status of a transaction
      and so much more.
  - name: Card Tokenisation
    description: >-
      The Card Tokenisation APIs are used to create card tokens, charge cards
      using tokens, retrieve all tokens created by a merchant account and
      deleting any card token as desired.
  - name: Refunds And Chargebacks
    description: >-
      The Refunds and Chargeback APIs are used to initiate refunds, view your
      refund and chargeback history and so much more.
  - name: Branches
    description: >-
      The Refunds and Chargeback APIs are used to initiate refunds, view your
      refund and chargeback history and so much more.
  - name: Auth-Capture-Void
    description: >-
      The Auth-Capture-Void APIs provide a two-phase payment process where
      transactions are first authorized, then captured or voided. This allows
      merchants to hold funds and complete the transaction in the future.
  - name: Momo and ZAR Collections
    description: APIs for MoMo, ZAR and XOF collections.
  - name: Check Transaction Status(Merchant Reference)
    description: >-
      This endpoint is used to check the transaction status of a transaction
      using the Merchant Reference..
paths:
  /settlement/settlement/merchant/split-account?page=&size=:
    get:
      tags:
        - Split Settlements
      summary: Fetch Split Accounts
      description: >-
        This retrieves all split settlement accounts belonging to the
        authenticated merchant.
      parameters:
        - name: page
          in: query
          required: true
          schema:
            type: integer
          description: The page number to retrieve.
        - name: size
          in: query
          required: true
          schema:
            type: integer
          description: The number of records per page.
      responses:
        '200':
          description: Fetch Split Accounts Response
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/fetchSplitAccountsResponse'
              examples:
                Fetch Split Accounts:
                  summary: Fetch Split Accounts Response
                  value:
                    code: '00'
                    success: true
                    error: null
                    data:
                      items:
                        - id: 116
                          account_no: '0223456789'
                          code: SSA_C70E2C391783952664709
                          account_name: Jane Doe
                          name: Jane doe
                          email: janedoe@gmail.com
                          bank_code: '123456'
                          bank_name: YOUR BANK
                          currency: NGN
                          country: NGA
                          split_type: FLAT
                          split_value: 3000
                          active: true
                          created_at: '2026-07-13T14:24:24.709239'
                          last_modified: '2026-07-13T14:24:24.713178'
                        - id: 115
                          account_no: '0123456789'
                          code: SSA_39B5E6E91783951863120
                          account_name: John Doe
                          name: John doe
                          email: johndoe@gmail.com
                          bank_code: '654321'
                          bank_name: MY BANK
                          currency: NGN
                          country: NGA
                          split_type: PERCENTAGE
                          split_value: 2
                          active: true
                          created_at: '2026-07-13T14:11:03.120587'
                          last_modified: '2026-07-13T14:11:03.123849'
                      page: 1
                      size: 2
                      total_elements: 8
                      total_pages: 4
                      has_next: true
                    message: split accounts fetched successfully
        '400':
          description: Invalid request
      security:
        - ApiKeyAuth: []
          TenantID: []
components:
  schemas:
    fetchSplitAccountsResponse:
      title: Fetch Split Accounts Response
      type: object
      properties:
        code:
          type: string
          description: >-
            System operational status response code tracking the request
            performance.
          example: '00'
        success:
          type: boolean
          description: Indicates if the request completed successfully.
          example: true
        error:
          type: string
          nullable: true
          description: >-
            Details regarding operational processing failure conditions. Returns
            null on success context.
          example: null
        data:
          type: object
          description: >-
            The payload containing the paginated list of split account
            configurations.
          properties:
            items:
              type: array
              description: >-
                An array of individual split account configuration records
                matching the current filter criteria.
              items:
                type: object
                properties:
                  id:
                    type: integer
                    description: >-
                      Unique internal database sequential identifier assigned to
                      the split account configuration.
                    example: 116
                  account_no:
                    type: string
                    description: >-
                      The destination bank account number where split funds will
                      be settled.
                    example: '0223456789'
                  code:
                    type: string
                    description: >-
                      The unique, system-generated tracking code reference
                      assigned specifically to this split account configuration.
                    example: SSA_C70E2C391783952664709
                  account_name:
                    type: string
                    description: >-
                      The official legal name tied to the destination bank
                      account.
                    example: Jane Doe
                  name:
                    type: string
                    description: >-
                      The custom profile name or identifier assigned to this
                      split recipient.
                    example: Jane doe
                  email:
                    type: string
                    format: email
                    description: >-
                      The contact email address associated with the split
                      account owner.
                    example: janedoe@gmail.com
                  bank_code:
                    type: string
                    description: >-
                      The unique central banking code identifying the settlement
                      bank.
                    example: '123456'
                  bank_name:
                    type: string
                    description: >-
                      The cleared name of the financial institution matching the
                      bank code.
                    example: YOUR BANK
                  currency:
                    type: string
                    description: >-
                      The 3-letter ISO currency code designated for transaction
                      settlement.
                    example: NGN
                  country:
                    type: string
                    description: The 3-letter ISO country code location tracking parameter.
                    example: NGA
                  split_type:
                    type: string
                    description: >-
                      The calculation mechanism applied to process transaction
                      splits (e.g., **PERCENTAGE**, **FLAT**).
                    example: FLAT
                  split_value:
                    type: number
                    description: >-
                      The numeric payout computation value allocated to the
                      beneficiary matching the context of the split type.
                    example: 3000
                  active:
                    type: boolean
                    description: >-
                      Indicates whether the split account configuration is
                      active and available to accept fund routings.
                    example: true
                  created_at:
                    type: string
                    format: date-time
                    description: >-
                      System database initial tracking entry generation
                      timestamp log.
                    example: '2026-07-13T14:24:24.709239'
                  last_modified:
                    type: string
                    format: date-time
                    description: >-
                      System database entry transaction state revision modifier
                      timestamp log.
                    example: '2026-07-13T14:24:24.713178'
            page:
              type: integer
              description: The current page index cursor location.
              example: 1
            size:
              type: integer
              description: >-
                The maximum record capacity boundaries requested per page
                segment window.
              example: 2
            total_elements:
              type: integer
              description: >-
                The absolute matching record count available across the entire
                data index query space.
              example: 8
            total_pages:
              type: integer
              description: >-
                The total page allocation blocks computed from the
                `total_elements` divided by page `size` layout constraints.
              example: 4
            has_next:
              type: boolean
              description: >-
                Flag indicating if additional sequential element records exist
                past the current window scope.
              example: true
        message:
          type: string
          description: Descriptive message confirming the data extraction outcome.
          example: split accounts fetched successfully
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Payaza {{Public API Key in Base 64}}
    TenantID:
      type: apiKey
      in: header
      name: X-TenantID
      description: live or test
    ProductID:
      type: apiKey
      in: header
      name: X-ProductID
      description: 'default value is ‟app” '

````