Sign in

v1

latestOpenAPI 3.0.12026-07-225791279.7 KB
Sub Accounts

Create A Subaccount

This endpoint is used to create a subaccount.

Notes:

  1. Please be advised that access to this API is available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.
post/payaza-account/api/v1/subaccounts/merchant

Request body

mainAccountPayazaReferencestring required

The account reference of the main Payaza account.

namestring required

The name of the sub-account being created.

currencystring required

The currency code.

countrystring required

The country code in ISO 3166-1 alpha-3 format (e.g., NGA).

Example request

{
  "mainAccountPayazaReference": "100000000",
  "name": "Test Sub Account",
  "currency": "NGN",
  "country": "NGA"
}

Response

Subaccount creation successful

messagestring

Response message.

statusboolean

Request status.

Example response

{
  "message": "New account created",
  "status": true,
  "data": [
    {
      "id": 1110,
      "accountName": "Test Sub Account",
      "accountStatus": "ACTIVE",
      "businessFk": 11407,
      "currency": "NGN",
      "owner": "PAYAZA",
      "country": "NGA",
      "creationReference": "DC625576B5BF426A94CB6B1D868C0",
      "actionStatus": "ACTIVE",
      "payazaAccountReference": "2010000120",
      "virtualAccounts": [
        {
          "accountNumber": "9977719429",
          "accountName": "MERCHANT(Test Sub Account)",
          "bankCode": "000023"
        }
      ]
    }
  ]
}