Skip to main content
POST
/
payaza-account
/
api
/
v1
/
subaccounts
/
merchant
Create A Subaccount
curl --request POST \
  --url https://api.payaza.africa/live/payaza-account/api/v1/subaccounts/merchant \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-TenantID: <api-key>' \
  --data '
{
  "mainAccountPayazaReference": "100000000",
  "name": "Test Sub Account",
  "currency": "NGN",
  "country": "NGA"
}
'
{
  "message": "New account created",
  "status": true,
  "data": [
    {
      "id": 1110,
      "accountName": "Test Sub Account",
      "accountStatus": "ACTIVE",
      "accountBalance": 0,
      "escrowBalance": 0,
      "businessFk": 11407,
      "currency": "NGN",
      "owner": "PAYAZA",
      "country": "NGA",
      "creationReference": "DC625576B5BF426A94CB6B1D868C0",
      "actionStatus": "ACTIVE",
      "payazaAccountReference": "2010000120",
      "pnc": false,
      "pnd": false,
      "virtualAccounts": [
        {
          "accountNumber": "9977719429",
          "accountName": "MERCHANT(Test Sub Account)",
          "bankCode": "000023"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

​
X-TenantID
string
header
required

live or test

Body

application/json
​
mainAccountPayazaReference
string
required

The account reference of the main Payaza account.

Example:

"100000000"

​
name
string
required

The name of the sub-account being created.

Example:

"Test Sub Account"

​
currency
string
required

The currency code.

Example:

"NGN"

​
country
string
required

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

Example:

"NGA"

Response

Subaccount creation successful

​
message
string

Response message.

Example:

"New account created"

​
status
boolean

Request status.

Example:

true

​
data
object[]

List containing the newly created account details.