This endpoint creates a sub account for a merchant, allowing the merchant split transaction settlement between the main account and one or more sub account(s)
This endpoint is protected with OAuth 2.0 Bearer Token
Endpoint URL: {{base_url}}/api/v1/sub-accounts
HTTP Method: POST
The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url
Sample Request
[
{
"currencyCode": "NGN",
"bankCode": "058",
"accountNumber": "0123456789",
"email": "tamira1@gmail.com",
"defaultSplitPercentage": "20"
}
]
The request is an array, so you can send multiple sub account objects to create multiple sub accounts at once.
Once the request is sent, a sub account code will be returned. This sub account code is the unique identifier for that sub account and will be used to reference the sub account in split payment requests.
Sample Response
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": [
{
"subAccountCode": "MFY_SUB_319452883328",
"accountNumber": "0123456789",
"accountName": "JOHN, DOE SNOW",
"currencyCode": "NGN",
"email": "tamira1@gmail.com",
"bankCode": "058",
"bankName": "GTBank",
"defaultSplitPercentage": 20
}
]
}
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 |