Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Manage VA Settlement

This API allows the platform to manage the settlement account to where the virtual account settlements are performed.

post/v3/banking/settlement_account_setup

Headers

client_idstring required
client_secretstring required
x_on_behalf_ofstring

Optional header that allows parent merchant to consume the API on behalf of sub-merchant.

Request body

reference_idstring required

A unique ID assigned by clients for every API request.

actionstring required

The action that the platform wants to take on settlement account. Possible values: ACTIVATE/DEACTIVATE.

virtual_account_numberstring required

The virtual account number against which the settlement account is being added.

settlement_account_numberstring

The bank account number to which the settlement needs to be undertaken. Mandatory if transfer_type = NEFT/RTGS/IMPS

settlement_account_ifscstring

The bank account IFSC to which the settlement needs to be undertaken. Mandatory if transfer_type = NEFT/RTGS/IMPS

settlement_account_namestring

The name of the settlement account holder

settlement_account_urnstring

Unique URN received while adding a settlement account against a VA. Mandatory when action is 'DEACTIVATE'.

Response

200

OR

Example response

{
  "decentro_txn_id": "B13CFE965925475195D9B815881DCFB2",
  "api_status": "SUCCESS",
  "message": "Settlement account details added successfully.",
  "data": {
    "settlement_account_details": [
      {
        "settlement_account_urn": "1084AADE38054137B9F01594754020D6",
        "settlement_account_number": "89433454678320",
        "settlement_account_ifsc": "ICIC0001302",
        "settlement_account_name": "mock test",
        "virtual_account_number": "4625250092951178"
      }
    ]
  },
  "response_key": "success_settlement_account_added"
}