The API can be used by clients to request whitelisting of a remitter's account for VA based collections.
Overview
The Remitter Whitelisting API is a feature available for clients using Decentro's E-Collect stack. This API allows clients to manage remitter accounts, ensuring that only verified accounts can interact with their virtual accounts. The primary goal is to enhance security and streamline the process of managing remitter accounts through a structured flow that includes adding, updating, and removing accounts from the whitelist.
Following are the key features of remitter whitelisting:
- Whitelist Remitter Accounts: Clients can add or remove remitter accounts as needed.
- Callback Notifications: Clients receive updates on the status of their whitelisting requests.
- Validation and Security: Implement checks to ensure that only valid accounts are processed.
Flow
Below is the remitter whitelisting flow for clients:
- The client must ensure that the remitter whitelisting configuration flag is enabled for their consumer.
- Clients can trigger the remitter whitelisting API by sending a request with the necessary account details.
- A notification will be sent to the Decentro admin for review of your whitelisting request.
- The admin will respond with either an accept or reject decision for your whitelisting request.
- After the admin's decision, you will receive a remitter whitelisting callback indicating the final status of your whitelisting request.
Action Functionalities
The API supports three main actions:
- ADD: Add remitter account details to the whitelist.
- Provide the necessary account details, and you will receive a confirmation message upon successful addition.
- REMOVE: Remove remitter account details from the whitelist.
- This action is processed immediately without requiring admin approval. You must provide the remitter_code to identify which account to remove.
- UPDATE: Update existing remitter account details.
- The remitter_code is mandatory for updates. You can modify any provided fields (e.g., account_number, account_ifsc, vendor_relationship).
Note: If an account is de-whitelisted, it will be treated as a regular account in future transactions.
Managing family of virtual accounts
Clients can easily manage remitter account whitelisting against their virtual accounts by selecting from either a single virtual account, a family of virtual accounts, or all virtual accounts associated with a consumer.
To effectively identify the relevant virtual accounts, clients can use one of the following identifiers::
Identifier | Results |
---|---|
virtual_account_number | The whitelisting will be done against the specific virtual_account_number in question. |
custom_va_number | The whitelisting will be done against all virtual account numbers across various banks linked to the specified custom VA number. |
customer_va_identifier | The whitelisting will be done against all virtual account numbers across different banks associated with the given customer VA identifier. |
consumer_urn | The whitelisting will be done against all virtual accounts across banks created for the consumer. |
Status Mapping
The status of whitelisting requests can be categorized as follows:
Scenario | Remitter whitelisting status |
---|---|
Client initiates a request; admin has not reviewed. | PENDING |
Client's request is approved by admin. | ACTIVE |
Client's request is rejected by admin. | INACTIVE |