POST
/
orders
/
pay
/
authenticate
/
{cf_payment_id}

Headers

x-api-version
string
default:
2023-08-01
required

API version to be used. Format is in YYYY-MM-DD

x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

x-idempotency-key
string

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

cf_payment_id
string
required

The Cashfree payment or transaction ID.

Body

application/json

OTP to be submitted for headless/native OTP

action
enum<string>
required

The action for this workflow. Could be either SUBMIT_OTP or RESEND_OTP

Available options:
SUBMIT_OTP,
RESEND_OTP
otp
string
required

OTP to be submitted

Response

200 - application/json

This is the response shared when merchant inovkes the OTP submit or resend API

action
enum<string>

The action that was invoked for this request.

Available options:
SUBMIT_OTP,
RESEND_OTP
authenticate_status
enum<string>

Status of the is action. Will be either failed or successful. If the action is successful, you should still call the authorization status to verify the final payment status.

Available options:
FAILED,
SUCCESS
cf_payment_id
string

The payment id for which this request was sent

payment_message
string

Human readable message which describes the status in more detail