Payments
Collections
Create payment link
Response key | Scenario |
---|---|
error_provider_error | An unexpected response was obtained from the provider service. |
error_empty_module_secret | An empty module secret was passed. |
error_no_subscription_found | The company has not subscribed to this module. |
error_unauthorized_module | Authentication failed for this module. |
error_module_access_expired | The module subscription has expired. |
error_module_credits_exhausted | Module credits are exhausted for the company. |
error_decentro_error | Something wrong happened at the Decentro level. |
unauthorized_provider | The Provider is not authorized for the company. |
success_payment_link_created | The payment link was created successfully. |
error_invalid_reference_id | The reference id passed is not of type string. |
error_duplicate_reference_id | A duplicate request reference id is passed. |
error_invalid_account_number | The account passed does not match the underlying provider. |
error_malformed_request | A malformed JSON request was passed. |
error_amount_not_parsable | The amount is not a valid positive value. |
error_exceeded_decimal_in_amount | More than 2 decimals were passed in amount. |
error_amount_type_invalid | Amount type other than a positive integer is passed. |
error_unsanitized_values | Invalid characters such as. @ # $ % ^ & * ! ; : ' " ~ ` ? = + ) ( were passed. |
error_invalid_purpose_message_length | Long purpose length was passed. |
error_invalid_purpose_message | The purpose message passed is not in string format. |
error_invalid_generate_QR_value | Generate QR value is passed other than 0 or 1. |
error_expiry_is_not_positive | Expiry time passed is less than 0. |
error_expiry_exceeded_max_expiry_days | Expiry time passed is more than 45 days. |
error_invalid_expiry_value | Expiry time passed is not of the type positive integer. |
error_invalid_generate_uri_value | Generate uri value is passed other than 0 or 1. |
error_empty_payee_account | An empty payee account was passed. |
error_invalid_reference_id | The request reference id passed is not a string. |
error_empty_reference_id | An empty reference_id was passed. |
error_empty_amount | An empty amount was passed. |
error_empty_purpose_message | An empty purpose message was passed. |
error_invalid_custom_QR_value | Custom QR value is passed other than 0 or 1. |
error_QR_not_generated | An error occurred while creating a dynamic QR. |
error_empty_generate_QR | An empty generate QR was passed. |
Get transaction status
Response key | Scenario |
---|---|
success_transaction_status_successful | UPI Transaction Status is successful. |
error_no_transaction_found | This transaction was not found in our system. If there was any debit, it would have already been reversed. Please retry the corresponding initiate payment transaction. |
success_transaction_status_pending | UPI Transaction Status is successful pending. |
success_transaction_status_failure | UPI Transaction Status is successful failure. |
success_transaction_status_expired | UPI Transaction Status is successful expired. |
error_invalid_provider | Given transaction does not belong to the original provider. |
error_provider_error | Error occurred while fetching transaction status from provider. |
error_api_access_error | Error occurred while accessing the API. |
error_authentication_request | Error occurred while authenticating the request. |
error_unauthorized_request | Error occurred because request is unauthorized . |
error_plan_not_configured | Error occurred because plan is not configured. |
error_plan_not_found | Error occurred because plan is not found. |
error_duplicate_transaction | Duplicate transaction found in the system. |
Validate VPA(UPI-ID)
Response keys | Scenarios |
---|---|
success_UPI_id_valid | The given UPI-ID is valid. |
success_UPI_id_invalid | The given UPI-ID is invalid. |
error_unsanitized_values | Unsanitized values detected for key(s): upi_id. Kindly sanitize the corresponding values by removing special characters such as . @ # $ % ^ & * ! ; : ' " ~ ` ? = + ) ( and retry. |
error_missing_UPI_id | UPI-ID (Virtual Payment Address) cannot be null or empty. Hint : upi_id (string). |
error_invalid_UPI_id_format | UPI-ID (Virtual Payment Address) is not in valid format. Please try again with valid UPI-ID. |
error_invalid_reference_id | Request reference id is not of type string. |
error_duplicate_reference_id | Duplicate Request Reference ID. |
error_missing_reference_id | Request reference id cannot be null or empty. Hint: reference_id (string). |
error_invalid_type | Invalid value entered for type. Type can be either 'basic' or 'advance'. |
error_insufficient_commission_balance | Insufficient commission debit account balance. |
error_insufficient_prepaid_credits | Insufficient prepaid credits. |
error_module_credits_exhausted | You have consumed your QA credits. Please connect with our team on [email protected] for credit renewal. |
error_invalid_UPI_id_data_type | Incorrect UPI-ID data type. |
error_invalid_type_data_type | Incorrect validation type data type. Type can either be 'BASIC' or 'ADVANCE'. |
error_validation_type_empty | Validation type is empty. |
success_UPI_id_failed | When UPI validation status is failed. |
error_provider_feature_unavailable | Company is not on boarded on both ICICI and NPST. |
error_provider_error | Unexpected response received from underlying provider. |
error_missing_configuration | Commission/Credit plan not configured. Please drop a mail to [email protected] to configure the plan. |
error_invalid_configuration | Commission/Credit plan not configured. Please drop a mail to [email protected] to configure the plan. |
Refund
Response keys | Scenarios |
---|---|
success_refund_status_pending | Transaction refund request processed successfully. |
error_invalid_reference_id | Reference URL is not of type string. |
error_duplicate_reference_id | Duplicate Request Reference ID. |
error_malformed_request | Malformed request detected. |
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_invalid_purpose_message_length | Length of Purpose Message cannot be greater than X. |
error_invalid_purpose_message | Purpose Message is not of type string. Hint : purpose_message (string). |
error_missing_reference_id | Request reference id cannot be null or empty. Hint: reference_id (string). |
error_missing_purpose_message | Purpose Message cannot be null or empty. Hint : purpose_message (string). |
error_invalid_credentials | Invalid authentication credentials. |
error_missing_credentials | No API key found in request. |
error_invalid_client_credentials | Authentication failed. Please use valid Client ID and Client Secret. |
error_empty_client_secret | Client Secret cannot be empty. Hint: client_secret (string). |
error_unauthorized_module | Authentication failed for accessing the module. |
error_empty_module_secret | Module Secret cannot be empty. Hint: module_secret (string). |
error_company/account_disabled | UPI Credit transactions are disabled for the company/account. |
error_no_transaction_found | No such transaction found at our end. Please check the values and retry. |
error_no_transaction_identifier_found | Any one value should be present out of transaction_id , original_reference_id and bank_reference_number .Please check the documentation and provide values accordingly. |
error_provider_error | Unexpected response received from underlying provider. |
error_invalid_bank_reference_number | Original transaction bank reference number is invalid. |
error_pending_original_transaction | Original transaction has not reached terminal state. |
error_unsuccessful_original_transaction | Original transaction was not a success. |
error_refund_already_processed | Refund already processed for the given transaction. |
error_refund_already_initiated | Another refund has already been initiated for the given original transaction. |
error_insufficient_balance | Refund cannot be processed due to insufficient balance. Contact [email protected]. |
Error_keys
Error keys serve as indicators to notify clients when a payment transaction encounters issues. These errors are unique to the payment collections. In a complex ecosystem like UPI, where multiple payment entities collaborate to facilitate a transaction, it's essential to pinpoint the cause of a transaction failure. Error keys play a crucial role in helping clients identify which specific entity within the UPI ecosystem contributed to the transaction's failure.
Error key | Description |
---|---|
error_at_remitter_bank | The transaction failed due to issue at remitter's (end customer) bank. Please contact the remitter's bank. The common reasons for such failures are the payer account is frozen, technical issues at the bank, etc. |
error_at_beneficiary_bank | The transaction failed due to issue at beneficiary bank. |
error_at_payer_psp | The transaction failed due to issue at payer psp. |
error_at_payee_psp | The transaction failed due to payee psp. |
error_at_npci | The transaction failed due to issue at NPCI. |
Updated about 2 months ago