Overview

This API lets the platform collect funds from a payer through NEFT/RTGS/IMPS on its v3 stack.

Flow

Below is the flow for using this API.

The platform creates a virtual account using this API and the endpoint by passing the consumer_urn shared by Decentro before going live.
The platform can choose a specific virtual account number as desired basis the usecase by the passing the suffix of the virtual account number under the 'custom_va_number' field in the request body.
The platform receives the status of virtual account creation in the response from Decentro, including the virtual account number if Decentro is generating it.
The platform can share the virtual account number and IFSC code with the payer on its website, app or offline for the payer to transfer funds to the virtual account.
The payer transfers funds to the virtual account using their Netbanking portal and any supported modes (NEFT/RTGS/IMPS).
Decentro triggers the account balance callback to the platform's endpoints configured by Decentro at onboarding time.
Decentro triggers the Terminal Transaction Status Callback/Webhook to the platform's endpoints configured by Decentro at onboarding time if Decentro receives a success or failure transaction at its end.

Note: Decentro has a standard nomenclature for creating a virtual account. The first 6 digits are static, and the subsequent 10 digits can be customized by the platform.

API Endpoints

Below are the API endpoints to be used by the platform basis the environments.

Environment	Endpoint
Staging / Sandbox	https://staging.api.decentro.tech/v3/banking/account/virtual
Production	https://api.decentro.tech/v3/banking/account/virtual

Response Keys

Below are the response keys propagated by Decentro in the response_key parameter, which cover all the scenarios a platform can encounter.

Response Key	Message
error_invalid_consumer_urn	Consumer URN does not exist. Please retry with a valid consumer_urn.
error_empty_consumer_urn	Consumer URN cannot be empty. Hint: consumer_urn (string).
error_invalid_format_consumer_urn	Consumer URN is not of type string. Hint: consumer_urn (string).
error_invalid_length_name	Invalid length for the `name` parameter. Length of name should be between 2 and 255 characters.
error_invalid_format_name	Name is not of type string. Please provide a valid format.
error_invalid_format_customer_va_identifier	customer_va_identifier is not of type string. Please provide a valid format.
error_empty_customer_va_identifier	Customer ID cannot be empty. Hint: customer_va_identifier (string).
error_invalid_length_customer_va_identifier	Invalid length for the `customer_va_identifier` parameter. Length of customer_va_identifier should be between 2 and 255 characters.
error_duplicate_customer_va_identifier	Duplicate customer_va_identifier found. Please provide a unique value.
error_invalid_format_custom_va_number	custom_va_number is not of type integer. Please provide a valid format.
error_duplicate_custom_va_number	Provided custom_va_number already exists. Please provide a unique value.
error_invalid_length_custom_va_number	Invalid length for the `custom_va_number` parameter. Length of custom_va_number should be between 6 and 10 characters.
error_invalid_custom_va_number	Custom VA number can only contain digits. Hint: custom_va_number (string)
error_invalid_block_va_auto_settlement	Please retry with a valid block_va_auto_settlement value.
error_invalid_format_block_va_auto_settlement	block_va_auto_settlement is not of type boolean. Please provide a valid format.
error_channel_disabled	E collect is disabled for the merchant. Please use a valid channel or contact support team to enable it.
error_missing_key_consumer_urn	Please pass consumer_urn
error_missing_customer_va_identifier	Please pass customer_va_identifier
error_unsanitized_values	Unsanitized values detected for key(s): purpose_message. Kindly sanitize the corresponding values by removing special characters such as . @ # $ % ^ & * ! ; : ' " ~ ` ? = + ) ( and retry.
error_consumer_configuration_issue	Virtual accounts cannot be created for this consumer. Please connect with us on `[email protected]`