POST
/
oauth2
/
session
{
  "reference_id": 3123123,
  "verification_id": "123456",
  "user": [
    {
      "identifier_type": "MOBILE",
      "identifier_value": "9988123456"
    }
  ],
  "expiry": "2024-12-31T23:59:59Z",
  "session_id": "session_id_value"
}

Authorizations

x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-api-version
string
required

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

Body

application/json
user
object
required

It displays the list of user identifiers.

verification_id
string
required

It is the unique ID you create to identify the user session. The maximum character limit is 50. Alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Response

200 - application/json

Initiate Oauth Response Body Schema

expiry
string

The expiration date and time of the session, in UTC format. Format YYYY-MM-DDTHH:mm:ssZ

reference_id
integer

It displays the unique ID created by Cashfree Payments for reference purposes. format: int64

session_id
string

A unique identifier for the session associated with the request.

user
object

It displays the list of user identifiers provided in the request.

verification_id
string

It displays the unique ID you created to identify the verification request.