> ## 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.

# Request Corporate and User Subaccount

> This endpoint allows users to create a corporate or user subaccount



## OpenAPI

````yaml /openapi.json post /payaza-account/api/v1/subaccounts/merchant/euro/request
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:
  /payaza-account/api/v1/subaccounts/merchant/euro/request:
    post:
      tags:
        - EUR Accounts
      summary: Request Corporate and User Subaccount
      description: This endpoint allows users to create a corporate or user subaccount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/corporateSubAccountRequest'
                - $ref: '#/components/schemas/userSubAccountRequest'
            examples:
              Corporate Sub Account:
                summary: Corporate Account Request
                value:
                  country: NG
                  purpose: test purposes
                  currency: EUR
                  category: SUB_ACCOUNT
                  certificate_of_incorporation: >-
                    https://payaza-assets.s3.amazonaws.com/development/1737370134640-number2.png
                  mermat: >-
                    https://payaza-assets.s3.amazonaws.com/development/1737370128708-number1.jpg
                  consent: true
                  account_type: corporate
                  main_account_payaza_reference: '10987654312'
                  company_name: Steve Stones Plc
                  directors:
                    - id_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370156723-number3.jpg
                      id_type: passport
                      poa_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370165810-number4.jpg
                      poa_type: utilityBill
                    - id_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370156723-number3.jpg
                      id_type: passport
                      poa_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370165810-number4.jpg
                      poa_type: utilityBill
                  shareholders:
                    - id_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370178824-number5.jpg
                      id_type: passport
                      poa_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370187160-number6.png
                      poa_type: utilityBill
                    - id_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370178824-number5.jpg
                      id_type: passport
                      poa_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370187160-number6.png
                      poa_type: utilityBill
                    - id_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370178824-number5.jpg
                      id_type: passport
                      poa_file: >-
                        https://payaza-assets.s3.amazonaws.com/development/1737370187160-number6.png
                      poa_type: utilityBill
              User Sub Account:
                summary: User Account Request
                value:
                  country: US
                  currency: EUR
                  category: SUB_ACCOUNT
                  purpose: Sit consequuntur co
                  consent: 'true'
                  account_type: user
                  main_account_payaza_reference: '10987654312'
                  id_file: >-
                    https://payaza-assets.s3.amazonaws.com/development/1737369951133-number1.jpg
                  id_type: passport
                  poa_file: >-
                    https://payaza-assets.s3.amazonaws.com/development/1737369961250-number2.png
                  poa_type: utilityBill
                  first_name: Steve
                  last_name: Stones
      responses:
        '200':
          description: Sub-account requested
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/requestSubAccountResponse'
              examples:
                response:
                  summary: Success Response
                  value:
                    message: EUR Account request has been submitted for review.
                    status: true
                    creationReference: ac456ecb-7870-47d4-af23-2dde8563235f
        '400':
          description: Invalid request
      security:
        - ApiKeyAuth:
            - Payaza {{Public API Key In Base64}}
          TenantID:
            - test or live
components:
  schemas:
    corporateSubAccountRequest:
      title: Request Corporate Subaccount
      type: object
      required:
        - country
        - purpose
        - currency
        - category
        - account_type
        - company_name
        - main_account_payaza_reference
        - certificate_of_incorporation
        - consent
        - directors
      properties:
        country:
          type: string
          description: The 2-letter ISO country code (e.g.US.)
          example: US
        purpose:
          type: string
          description: The purpose for opening the account.
          example: test purposes
        currency:
          type: string
          description: The currency code e.g. **EUR**.
          example: EUR
        category:
          type: string
          description: The category of the account.
          example: SUB_ACCOUNT
        certificate_of_incorporation:
          type: string
          format: uri
          description: URL link to the certificate of incorporation.
          example: https://payaza-assets.s3.amazonaws.com/development/cert.png
        mermat:
          type: string
          format: uri
          description: URL link to company memorandum and articles of association.
          example: https://payaza-assets.s3.amazonaws.com/development/mermat.jpg
        consent:
          type: boolean
          description: Whether the company consents to the account request.
          example: true
        account_type:
          type: string
          description: Type of account **(corporate)**.
          example: corporate
        main_account_payaza_reference:
          type: string
          description: The main Payaza account reference number.
          example: '10987654312'
        company_name:
          type: string
          description: The registered company name.
          example: Steve Stones Plc
        directors:
          type: array
          description: List of directors with identification and proof of address.
          items:
            type: object
            required:
              - id_file
              - id_type
              - poa_file
              - poa_type
            properties:
              id_file:
                type: string
                format: uri
                description: URL to the director's ID document.
                example: https://payaza-assets.s3.amazonaws.com/development/id1.jpg
              id_type:
                type: string
                description: Type of ID provided (e.g., passport).
                example: passport
              poa_file:
                type: string
                format: uri
                description: URL to the Proof of Address document.
                example: https://payaza-assets.s3.amazonaws.com/development/poa1.jpg
              poa_type:
                type: string
                description: Type of POA provided (e.g., utilityBill).
                example: utilityBill
        shareholders:
          type: array
          description: List of company shareholders (Optional).
          items:
            type: object
            required:
              - id_file
              - id_type
              - poa_file
              - poa_type
            properties:
              id_file:
                type: string
                format: uri
                description: URL to the shareholder's ID document.
                example: https://payaza-assets.s3.amazonaws.com/development/id2.jpg
              id_type:
                type: string
                description: Type of ID provided.
                example: passport
              poa_file:
                type: string
                format: uri
                description: URL to the shareholder's Proof of Address.
                example: https://payaza-assets.s3.amazonaws.com/development/poa2.png
              poa_type:
                type: string
                description: Type of POA provided.
                example: utilityBill
    userSubAccountRequest:
      title: Request User Sub-account Request
      type: object
      required:
        - country
        - currency
        - category
        - purpose
        - consent
        - account_type
        - main_account_payaza_reference
        - id_file
        - id_type
        - poa_file
        - first_name
        - last_name
      properties:
        country:
          type: string
          description: The country ISO code **(e.g. US)**
          example: US
        currency:
          type: string
          description: The currency code **(e.g. EUR)**.
          example: EUR
        category:
          type: string
          description: The category of the account.
          example: SUB_ACCOUNT
        purpose:
          type: string
          description: Purpose of account.
          example: Testing
        consent:
          type: boolean
          description: Consent confirmation.
          example: 'true'
        account_type:
          type: string
          description: Type of account (**user**).
          example: user
        main_account_payaza_reference:
          type: string
          description: The main Payaza account reference.
          example: '10987654312'
        id_file:
          type: string
          format: uri
          description: URL link to the user's ID document.
          example: https://payaza-assets.s3.amazonaws.com/development/id.jpg
        id_type:
          type: string
          description: User’s ID type (**passport** or **identityCard**)..
          example: passport
        poa_file:
          type: string
          format: uri
          description: URL link to the Proof of Address document.
          example: https://payaza-assets.s3.amazonaws.com/development/poa.png
        poa_type:
          type: string
          description: Type of proof of address (e.g. utilityBill)
          example: utilityBill
        first_name:
          type: string
          description: First name of the user.
          example: Steve
        last_name:
          type: string
          description: Last name of the user.
          example: Stones
    requestSubAccountResponse:
      title: Request Sub-account Request
      type: object
      properties:
        message:
          type: string
          description: Response message.
          example: EUR Account request has been submitted for review.
        status:
          type: boolean
          description: Request status.
          example: true
        creationReference:
          type: string
          description: Unique reference ID to track the status of the review.
          example: ac456ecb-7870-47d4-af23-2dde8563235f
  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” '

````