v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Update Split Settlement Rule API

put/v3/banking/manage_split_settlement

Headers

client_idstring required

Decentro assigned client_id during on boarding.

client_secretstring required

Decentro assigned client_secret during on boarding.

x_on_behalf_ofstring

Optional header that allows parent merchant to consume the API on behalf of sub-merchant.The child consumer URN value must be passed here.

Request body

reference_idstring required

A unique ID assigned by clients for every API request.

consumer_urnstring

A unique identifier assigned to client's by Decentro during On boarding. (Mandatory if "virtual_account_number" is not passed)

virtual_account_numberstring

The virtual account number against which the settlement account is being added. (Mandatory if "consumer_urn" is not passed.)

split_settlement_rule_urnstring required

A URN generated to map the rules of the split against it.

is_activeboolean

A boolean flag to activate or deactivate a split rule. (Optional)

Response

200

decentro_txn_idstring

api_statusstring

messagestring

response_keystring

Example response

{
  "decentro_txn_id": "42300FB0FA1A46428BDA4A9369DD24E7",
  "api_status": "SUCCESS",
  "message": "Split Settlement Rule updated successfully.",
  "data": {
    "split_settlement_rule_urn": "426BF8958FC64708A50258DC4C9DF5F4",
    "split_settlement_rule": [
      {
        "amount": 10,
        "settlement_account_urn": "B2071BE05A8442FBACDC9C7A7EAB12A4"
      }
    ]
  },
  "response_key": "success_split_rule_updated_successfully"
}