post https://in.staging.decentro.tech/v2/banking/verify_pay
Validate a UPI VPA via a penny drop
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/v2/banking/verify_pay |
| Production | https://in.decentro.tech/v2/banking/verify_pay |
This API enabled you yo check if a particular UPI-ID (Virtual Payment Address) is valid.
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. Please use valid client id, client secret and module secret. Use UPI_ID parameter in the request payload to check the various test cases of this API.
Important: Please refer to the Simulation Data guide Click here
Simulation Data
Steps to use this data:
- Take the UPI ID from values shared below depending on the scenario to be tested.
- API response will state the validation status of the VPA (valid or invalid)
| UPI ID | Validation status | Test case |
|---|---|---|
| test@upi | VALID | When VPA is valid |
| vpa_invalid@upi | INVALID | When VPA is invalid |
Response Keys
Below are the response keys propagated by Decentro in the response_key parameter, which cover all the scenarios a platform can encounter.
| Error Code | Response Key | Message |
|---|---|---|
| S00000 | success_account_details_retrieved | Account details retrieved successfully |
| S00000 | failure_expired_upi_vpa | The UPI VPA has expired. |
| S00000 | failure_vpa_restrictred | The customer has blocked trannsactions for this UPI ID. |
| S00000 | failure_account_frozen | The account associated with this mobile number is blocked or frozen. |
| S00000 | failure_dormant_account | The account associated with this mobile number is Inactive or Dormant. |
| S00000 | failure_account_closed | The bank account mapped to the UPI VPA is closed. |
| S00000 | failure_no_account_mapped | There is no bank account mapped with this UPI ID. |
| S00000 | faiure_invalid_upi_vpa | The beneficiary UPI VPA is invalid. |
| S00000 | failure_invalid_vpa | The beneficiary UPI VPA is invalid. |
| S00000 | failure_invalid_psp | The PSP powering the upi VPA is not active. |
- | error_invalid_method | The method is not allowed for the requested URL. |
| E00008 | (Not Applicable) | Authentication failed. Please use valid Client ID and Client Secret. |
| E00009 | error_malformed_request | Malformed request detected. |
| E00030 | error_unauthorized_module | Authentication failed for accessing the module |
| E00009 | error_unsanitized_values | Unsanitized values detected for key(s): reference_id. Kindly sanitize the corresponding values by removing special characters such as . @ # $ % ^ & * ! ; : ' " ~ ` ? = + ) ( and retry. |
| E00009 | error_empty_reference_id | Request reference ID cannot be null or empty. Hint: reference_id (string) |
| E00019 | error_duplicate_reference_id | Duplicate Request Reference ID |
| E00009 | error_invalid_reference_id_length | Request reference ID is not valid. Hint: reference_id should be restricted to 2 to 100 chars |
| E00009 | error_upi_vpa_insufficient_string_length | Parameter upi_vpa should be at least 4 characters long after trimming whitespace. Hint: upi_vpa (string) |
| E00009 | error_upi_vpa_missing_or_null | Parameter upi_vpa cannot be missing/null. Hint: upi_vpa (string) |
| E00000 | error_decentro_error | Internal Server Error. Kindly retry the transaction after sometime. |
| E00002 | error_validation_blocked | Transaction not permitted by the beneficiary bank. |
| E00002 | error_validation_blocked | The request could not be completed due to a risk exception by the remitter bank. Kindly retry the transaction after sometime. |
| E00002 | error_validation_blocked | Transaction not permitted for this account type (OD/CC/PPI) |
| E00002 | error_validation_blocked | The customer has not set the MPIN, configured it incorrectly, or has a temporary block as they have exceeded the number of retries. Kindly retry the transaction after sometime. |
| E00003 | error_beneficiary_bank_offline | The request could not be completed due to a error with the beneficiary bank. Kindly retry the transaction after sometime. |
| E00004 | error_validation_blocked | The request could not be completed as it was rejected by the remitting bank. |
| E00004 | error_validation_blocked | The request could not be completed as it was rejected by the beneficiary bank. |
| E00005 | error_frequency_limit_breached | The tranasction could not be completed due to a breach of transaction frequency limits set by the custoemr or their bank. Kindly retry the transaction after sometime. |
| E00006 | error_network_timeout_rejection | The transaction request could not be completed due to high response time from NPCI. Kindly retry the transaction after sometime. |
| E00007 | error_techinical_failure | The transaction failed due to a technical failure at NPCI. Kindly retry the transaction after sometime. |
| E00008 | error_beneficiary_bank_not_supported | The request could not be completed due to the beneficiary bank has not enabled this transaction type |
| E00012 | error_provider_error | Unexpected response received from provider. Kindly retry the transaction after sometime. |