Updating Split Config for Reserved Account

You can update income splitting config for a reserved account using the endpoint below.

This endpoint is protected with OAuth 2.0 Bearer token

Endpoint URL: {{base_url}}/api/v1/bank-transfer/reserved-accounts/update-income-split-config/{{accountReference}}

HTTP Method: PUT

The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url

Update Split Config Request

[ { "subAccountCode": "MFY_SUB_721433262589", "feePercentage": 10.50, "splitPercentage": 10, "feeBearer": true }, { "subAccountCode": "MFY_SUB_422913869636", "feeBearer": false, "splitPercentage": 30 } ]

Update Split Config Response

{ "requestSuccessful": true, "responseMessage": "success", "responseCode": "0", "responseBody": { "code": "VEHMXNTPZB", "reservedAccountCode": "VEHMXNTPZB", "feeBearer": "MERCHANT_WITH_SUB_ACCOUNT", "configDetails": [ { "subAccountCode": "MFY_SUB_721433262589", "feePercentage": 10.50, "feeBearer": true, "splitPercentage": 10, "reservedAccountConfigCode": "VEHMXNTPZB" }, { "subAccountCode": "MFY_SUB_422913869636", "feePercentage": 0, "feeBearer": false, "splitPercentage": 30, "reservedAccountConfigCode": "VEHMXNTPZB" } ] } }

Field Reference

(M) indicates fields that are mandatory in the request body. (m) Indicates fields that are mandatory only if the parent object is not empty.

Field

Description

Field

Description

accountReference 

Your unique reference used to identify this reserved account

incomeSplitConfig 

Object containing specifications on how payments to this reserve account should be split.

subAccountCode 

The unique reference for the sub account that should receive the split.

feeBearer

Boolean to determine if the sub account should bear transaction fees or not

feePercentage

The percentage of the transaction fee to be borne by the sub account

splitPercentage

The percentage of the amount paid to be split into the sub account.