curl --request POST \
--url https://sandbox.cashfree.com/pg/orders/pay/authenticate/{cf_payment_id} \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"action": "SUBMIT_OTP",
"otp": 111000
}
'{
"action": "SUBMIT_OTP",
"authenticate_status": "SUCCESS",
"cf_payment_id": "3991872901",
"payment_message": "payment successful"
}Submit or Resend OTP
Use this API to submit or resend OTP if you use Native OTP for authentication of card payments.
curl --request POST \
--url https://sandbox.cashfree.com/pg/orders/pay/authenticate/{cf_payment_id} \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--data '
{
"action": "SUBMIT_OTP",
"otp": 111000
}
'{
"action": "SUBMIT_OTP",
"authenticate_status": "SUCCESS",
"cf_payment_id": "3991872901",
"payment_message": "payment successful"
}Submit_OTP
Submit_OTP
{
"action": "SUBMIT_OTP",
"authenticate_status": "SUCCESS",
"cf_payment_id": "3991872901",
"payment_message": "payment successful"
}
{
"action": "SUBMIT_OTP",
"authenticate_status": "FAILED",
"cf_payment_id": "5114916442998",
"payment_message": "otp is invalid"
}
{
"message": "Exceeded retry attempts. Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "request_invalid",
"type": "invalid_request_error"
}
{
"message": "Transaction is already processed. Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "request_invalid",
"type": "invalid_request_error"
}
{
"message": "transaction not found. Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
"code": "payment_not_found",
"type": "invalid_request_error"
}
{
"message": "transaction failed",
"code": "bank_processing_failure",
"type": "api_error"
}
{
"message": "transaction incomplete",
"code": "bank_processing_failure",
"type": "api_error"
}
Resend_OTP
Resend_OTP
{
"action": "RESEND_OTP",
"authenticate_status": "SUCCESS",
"cf_payment_id": "5114916574918",
"payment_message": "otp sent successfully"
}
Error codes
The following table lists the error codes you may encounter when submitting an OTP:Error codes
Error codes
| Code | Description | Type | Status |
|---|---|---|---|
action_missing | The action field is required but was not included in the request. | invalid_request_error | 400 |
cf_payment_id_missing | The cf_payment_id field is required but was not included in the request. | invalid_request_error | 400 |
Headers
API version to be used.
Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.
An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
Path Parameters
The Cashfree payment or transaction ID.
Body
Request parameters to submit or resend OTP if you use Native OTP for authentication of card payments.
Response
Success response for submitting or resend OTP if you use Native OTP for authentication of card payments.
Cashfree payment ID for which this request was sent.
The action that was requested.
SUBMIT_OTP, RESEND_OTP Status of this action - will be either success or failed. If the action is success, you should still call payment status API to verify the final payment status.
FAILED, SUCCESS Human readable message which describes the status in more detail.
Was this page helpful?