Returns a list of sub accounts previously created by the merchant.
Endpoint
GET: https://sandbox.monnify.com/api/v1/sub-accounts
This endpoint is protected with OAuth 2.0 Bearer Token
Get Sub Accounts Response
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": [
{
"subAccountCode": "MFY_SUB_319452883219",
"accountNumber": "0123456789",
"accountName": "JOHN, DOE SNOW",
"currencyCode": "NGN",
"email": "tamira1@gmail.com",
"bankCode": "058",
"bankName": "GTBank",
"defaultSplitPercentage": 20.00
},
{
"subAccountCode": "MFY_SUB_8838656722391",
"accountNumber": "9876543210",
"accountName": "JANE, DOE SNOW",
"currencyCode": "NGN",
"email": "tamira2@gmail.com",
"bankCode": "057",
"bankName": "Zenith bank",
"defaultSplitPercentage": 20.00=
}
]
}
Field Reference
(M) indicates fields that are mandatory in the request body
| Field | Description |
|---|---|
| currencyCode (M) | Settlement currency. "NGN" |
| accountNumber (M) | The account number that should be created as a sub account. |
| accountName | The name attached to the account number |
| bankName | Name of the bank where the account is domiciled |
| bankCode (M) | The 3 digit bank code of the bank where the account number is domiciled |
| email (M) | The email tied to the sub account. This email will receive settlement reports for settlements into the sub account. |
| defaultSplitPercentage (M) | The default percentage to be split into the sub account on any transaction. (Only applies if a specific amount is not passed during transaction initialization) |
| subAccountCode (M) | The unique reference for the sub account |
Related Articles