Skip to main content
POST
/
payaza-account
/
api
/
v1
/
subaccounts
/
merchant
/
enquiry
/
business
Fetch All EUR subaccounts
curl --request POST \
  --url https://api.payaza.africa/live/payaza-account/api/v1/subaccounts/merchant/enquiry/business \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'X-TenantID: <api-key>' \
  --data '
{
  "pageSize": 10,
  "pageNumber": 1,
  "currency": "EUR",
  "searchPhrase": ""
}
'
{
  "message": "Account enquiry response",
  "status": true,
  "data": [
    {
      "id": 3796,
      "accountName": "Zachery Borer",
      "payazaAccountReference": "80810030592",
      "status": "ACTIVE",
      "accountBalance": 100000000,
      "businessId": 2046,
      "currency": "EUR",
      "country": "NGA",
      "organizationName": "PAYAZA",
      "productCode": "PAYOUT-SUB-EUR",
      "productNumber": "8899",
      "postNoCredit": false,
      "postNoDebit": false,
      "hasVirtualAccounts": true,
      "virtualAccounts": [
        {
          "accountNumber": "GB00213143149028220528",
          "accountName": "Zachery Borer",
          "bankCode": "ARPYGB21XXX",
          "bankId": 793
        }
      ],
      "holdTransactionAtLowBalance": false,
      "createdDate": "2025-03-11T00:01:21.113663"
    },
    {
      "id": 3665,
      "accountName": "Nikolaus and Sons",
      "payazaAccountReference": "80810030461",
      "status": "ACTIVE",
      "accountBalance": 100000000,
      "businessId": 2046,
      "currency": "EUR",
      "country": "NGA",
      "organizationName": "PAYAZA",
      "productCode": "PAYOUT-SUB-EUR",
      "productNumber": "8899",
      "postNoCredit": false,
      "postNoDebit": false,
      "hasVirtualAccounts": true,
      "virtualAccounts": [
        {
          "accountNumber": "GB31305690917679873490",
          "accountName": "Nikolaus and Sons",
          "bankCode": "ARPYGB21XXX",
          "bankId": 761
        }
      ],
      "holdTransactionAtLowBalance": false,
      "createdDate": "2025-03-09T08:30:05.188118"
    }
  ],
  "responseCode": null,
  "pageDetail": {
    "sorted": true,
    "pageNumber": 1,
    "pageSize": 10,
    "paged": true,
    "totalPages": 2,
    "totalElements": 10,
    "last": false,
    "size": 10,
    "number": 0,
    "numberOfElements": 10,
    "offset": 0
  }
}

Authorizations

​
Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

​
X-TenantID
string
header
required

live or test

Body

application/json
​
pageSize
integer
required

The number of items to return per page.

Example:

10

​
pageNumber
integer
required

The current page number to retrieve.

Example:

1

​
currency
string
required

The currency filter for the accounts.

Example:

"EUR"

​
searchPhrase
string

Optional search term to filter results.

Example:

""

Response

Account Enquiry Response

​
message
string

Response message.

Example:

"Account enquiry response"

​
status
boolean

Request status.

Example:

true

​
data
object[]

List of accounts found.

​
responseCode
string | null

Response code (if applicable).

Example:

null

​
pageDetail
object

Pagination details.