post https://in.staging.decentro.tech/core_banking/money_transfer/validate_account
Important Note
Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.
API Endpoints
| Environment | Endpoint |
|---|---|
| Staging / Sandbox | https://in.staging.decentro.tech/core_banking/money_transfer/validate_account |
| Production | https://in.decentro.tech/core_banking/money_transfer/validate_account |
This API allows you to validate a bank account by doing a penny drop (small deposit) transaction automatically. This is a sync API and Decentro returns the response of the account immediately.
Simulation Data
Decentro provides the test data which will simulate various scenarios of the API when a transaction takes place.
Note: This test data is only valid in the Staging environment.
Important:Please refer to the Simulation Data guide here
API Specifications
Request Payload
| Request Parameter | Mandatory (M) / Optional (O) / Conditional Mandatory (CM) | Description |
|---|---|---|
| reference_id | M | A URN to be passed by the user for each API request. Alphanumeric values are allowed. Special characters such as “@ # $ % ^ & * ! ; : ~ ` ? = + ) ( apostrophe, double quotes” are not allowed |
| purpose_message | M | 1. The narration/remarks that will be displayed in the beneficiaries bank statement. 2. Only Alphanumeric values are allowed, special characters such as “@ # $ % ^ & * ! ; : ~ ` ? = + ) ( apostrophe, double quotes” are not allowed. 3. Minimum length is 5 characters and Maximum length is 255 characters |
| transfer_amount | O | The Amount to be transferred.If no amount is entered, then the default value will be considered as INR 1. Minimum amount is INR 1 and Maximum amount is INR 100( 2 Decimal values are allowed Ex: 1.00) |
| validation_type | O | The validation method to be passed. The accepted values are 1.penniless 2.pennydrop 3.hybrid |
| beneficiary_details | M | Object |
| name | O | The Beneficiary Account Holder's Name must be added. Note: No name validation is being performed. |
| account_number | M | Beneficiary Account Number to be added. The account number that needs to be validated |
| ifsc | M | Beneficiary IFSC code to be added. 1. Alphanumeric values are allowed as per the IFSC code assigned to the beneficiary bank. 2. If the transfer type is UPI, this parameter is not required. 3. Maximum length is 11 characters |
Response Payload
| Request Parameter | Mandatory (M) / Optional (O) / Conditional Mandatory (CM) | Description |
|---|---|---|
| status | M | The status of the API if the http status is 4xx,5xx, and the status of the payout transaction if the http status is 200. Decentro recommends not to use this parameter to map the transaction status. These are the status available 1. Success 2. Failure 3. Pending |
| transactionStatus | M | The status of the payout transaction. These are the status available 1. Success 2. Failure 3. Pending 4. Unknown |
| decentroTxnId | M | A URN generated by Decentro against the API request |
| responseCode | M | The response code of the API request |
| message | M | The message on the status of the account |
| providerMessage | CM | The message on the status of the transaction. This parameter will be generated when the status is "Success" or "Failure" |
| accountStatus | M | "Valid" or "Invalid" will be passed here |
| beneficiaryName | CM | The beneficiary name of the account holder |
| bankReferenceNumber | CM | The bank reference number of the transaction. This parameter will be generated when the status is "Success" or "Failure" |
| validationType | CM | The Validation method performed for this request. This parameter will show the values "Penniless" and "Penny Drop" |