Cashfree Payments Developer Documentation

Submit risk details for an order

curl --request POST \
  --url https://sandbox.cashfree.com/pg/risk-details \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --header 'x-request-id: <x-request-id>' \
  --data '
{
  "merchant_order_id": "swapnil127",
  "customer_details": {
    "customer_name": "Swapnil B",
    "customer_login_status": "logged_in",
    "customer_email": "[email protected]",
    "customer_phone": "9876543210"
  },
  "device_fingerprint": {
    "uuid": "ibasidb-2oj31i2j-kjbskd",
    "browser": {
      "java_enabled": false,
      "javascript_enabled": false,
      "timezone_offset": 11,
      "color_depth": 23,
      "screen_width": 23,
      "screen_height": 100,
      "referer": "https://merchansite.com/example/paybill",
      "user_agent": "Mozilla/5.0",
      "session_duration": 1200
    },
    "ip": "105.106.107.108"
  },
  "risk_controls": {
    "preferred_non_3ds": false,
    "step_up_3ds": true,
    "cbp_coverage_requested": true
  },
  "industries": [
    {
      "industry_type": "flight",
      "industry_details": {
        "billing_address": {
          "address_line_1": "123 Street",
          "city": "New York City",
          "state": "New York",
          "country": "USA",
          "zipcode": 11001
        },
        "guests": [
          {
            "name": "Swapnil Buchke",
            "age": 26,
            "class": "Economy",
            "nationality": "Indian",
            "relationship_with_primary": "self"
          },
          {
            "name": "Kushagra Sahni",
            "age": 26,
            "class": "Economy",
            "nationality": "Indian",
            "relationship_with_primary": "sibling"
          }
        ],
        "itinerary": [
          {
            "departure_airport": "BOM",
            "arrival_airport": "DEL",
            "departure_date": "2025-10-15T00:00:00.000Z",
            "total_segments": 1,
            "flight_numbers": [
              "AI-101"
            ],
            "addons": {
              "concierge": true,
              "luggage": true,
              "meals": true,
              "delay_protection": false,
              "travel_insurance": true,
              "seats": true
            }
          }
        ],
        "fare_details": {
          "base_fare": "10000",
          "offer_fare": "9200",
          "promo_used": true
        }
      }
    }
  ]
}
'

{
  "status": "SUCCESS",
  "message": "Risk details accepted"
}

POST

risk-details

Submit risk details for an order

curl --request POST \
  --url https://sandbox.cashfree.com/pg/risk-details \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --header 'x-request-id: <x-request-id>' \
  --data '
{
  "merchant_order_id": "swapnil127",
  "customer_details": {
    "customer_name": "Swapnil B",
    "customer_login_status": "logged_in",
    "customer_email": "[email protected]",
    "customer_phone": "9876543210"
  },
  "device_fingerprint": {
    "uuid": "ibasidb-2oj31i2j-kjbskd",
    "browser": {
      "java_enabled": false,
      "javascript_enabled": false,
      "timezone_offset": 11,
      "color_depth": 23,
      "screen_width": 23,
      "screen_height": 100,
      "referer": "https://merchansite.com/example/paybill",
      "user_agent": "Mozilla/5.0",
      "session_duration": 1200
    },
    "ip": "105.106.107.108"
  },
  "risk_controls": {
    "preferred_non_3ds": false,
    "step_up_3ds": true,
    "cbp_coverage_requested": true
  },
  "industries": [
    {
      "industry_type": "flight",
      "industry_details": {
        "billing_address": {
          "address_line_1": "123 Street",
          "city": "New York City",
          "state": "New York",
          "country": "USA",
          "zipcode": 11001
        },
        "guests": [
          {
            "name": "Swapnil Buchke",
            "age": 26,
            "class": "Economy",
            "nationality": "Indian",
            "relationship_with_primary": "self"
          },
          {
            "name": "Kushagra Sahni",
            "age": 26,
            "class": "Economy",
            "nationality": "Indian",
            "relationship_with_primary": "sibling"
          }
        ],
        "itinerary": [
          {
            "departure_airport": "BOM",
            "arrival_airport": "DEL",
            "departure_date": "2025-10-15T00:00:00.000Z",
            "total_segments": 1,
            "flight_numbers": [
              "AI-101"
            ],
            "addons": {
              "concierge": true,
              "luggage": true,
              "meals": true,
              "delay_protection": false,
              "travel_insurance": true,
              "seats": true
            }
          }
        ],
        "fare_details": {
          "base_fare": "10000",
          "offer_fare": "9200",
          "promo_used": true
        }
      }
    }
  ]
}
'

{
  "status": "SUCCESS",
  "message": "Risk details accepted"
}

Headers

x-client-id

string

required

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

x-client-secret

string

required

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

x-api-version

string

required

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

x-request-id

string

required

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

string

Content type that the client can accept.

Content-Type

string

Content type of the request body.

Body

application/json

Request parameters for submitting risk details.

merchant_order_id

string

required

Unique identifier for the merchant order.

Example:

"swapnil127"

customer_details

object

required

Customer information for risk assessment.

Show child attributes

customer_details.customer_name

string

Full name of the customer.

Available options:

logged_in,

guest

customer_details.customer_email

string<email>

Email address of the customer.

customer_details.customer_phone

string

10-digit phone number of the customer.

Example:

{
  "customer_name": "Swapnil B",
  "customer_login_status": "logged_in",
  "customer_email": "[email protected]",
  "customer_phone": "9876543210"
}

device_fingerprint

object

required

Device and browser information for fraud detection.

Show child attributes

device_fingerprint.uuid

string

required

Unique device identifier.

Example:

"ibasidb-2oj31i2j-kjbskd"

device_fingerprint.browser

object

required

Browser-specific information.

Show child attributes

device_fingerprint.browser.java_enabled

boolean

Indicates whether Java is enabled in the browser.

device_fingerprint.browser.javascript_enabled

boolean

Indicates whether JavaScript is enabled in the browser.

device_fingerprint.browser.timezone_offset

integer

Timezone offset from UTC in minutes.

device_fingerprint.browser.color_depth

integer

Number of bits used to represent color on the screen.

device_fingerprint.browser.screen_width

integer

Screen width in pixels.

device_fingerprint.browser.screen_height

integer

Screen height in pixels.

device_fingerprint.browser.referer

string

URL of the page that referred the user to the current page.

device_fingerprint.browser.user_agent

string

User agent string from the browser.

device_fingerprint.browser.session_duration

integer

Duration of the user session in seconds.

Example:

{
  "java_enabled": false,
  "javascript_enabled": false,
  "timezone_offset": 11,
  "color_depth": 23,
  "screen_width": 23,
  "screen_height": 100,
  "referer": "https://merchansite.com/example/paybill",
  "user_agent": "Mozilla/5.0",
  "session_duration": 1200
}

device_fingerprint.ip

string<ipv4>

required

IP address of the customer's device.

Example:

"105.106.107.108"

risk_controls

object

required

Risk control preferences for the transaction.

Show child attributes

risk_controls.preferred_non_3ds

boolean

Preference for non-3DS authentication when possible.

risk_controls.step_up_3ds

boolean

Preference for stepping up to 3DS authentication when needed.

risk_controls.cbp_coverage_requested

boolean

Request for chargeback protection coverage.

Example:

{
  "preferred_non_3ds": false,
  "step_up_3ds": true,
  "cbp_coverage_requested": true
}

industries

object[]

required

Industry-specific transaction details.

Show child attributes

industries.industry_type

enum<string>

required

Type of industry for the transaction.

Available options:

flight,

lodging,

ecommerce,

saas

industries.industry_details

object

required

Detailed information specific to the industry type. Flight booking specific information.

Option 1
Option 2
Option 3
Option 4

Show child attributes

industries.industry_details.billing_address

object

Address information.

Show child attributes

industries.industry_details.billing_address.address_line_1

string

First line of the address.

industries.industry_details.billing_address.city

string

City name.

industries.industry_details.billing_address.state

string

State or province name.

industries.industry_details.billing_address.country

string

Country name.

industries.industry_details.billing_address.zipcode

string

Postal code or ZIP code.

industries.industry_details.guests

object[]

List of passengers for the flight.

Show child attributes

industries.industry_details.guests.name

string

Full name of the guest.

industries.industry_details.guests.age

integer

Age of the guest in years.

industries.industry_details.guests.class

string

Travel class or room type.

industries.industry_details.guests.nationality

string

Nationality of the guest.

industries.industry_details.guests.relationship_with_primary

string

Relationship with the primary booker.

industries.industry_details.itinerary

object[]

Flight itinerary details.

Show child attributes

industries.industry_details.itinerary.departure_airport

string

IATA code of the departure airport.

industries.industry_details.itinerary.arrival_airport

string

IATA code of the arrival airport.

industries.industry_details.itinerary.departure_date

string<date>

Date of departure in YYYY-MM-DD format.

industries.industry_details.itinerary.total_segments

integer

Total number of flight segments.

industries.industry_details.itinerary.flight_numbers

string[]

List of flight numbers.

industries.industry_details.itinerary.addons

object

Additional services selected.

Show child attributes

industries.industry_details.itinerary.addons.concierge

boolean

Indicates whether concierge service is selected.

industries.industry_details.itinerary.addons.luggage

boolean

Indicates whether additional luggage is selected.

industries.industry_details.itinerary.addons.meals

boolean

Indicates whether meal service is selected.

industries.industry_details.itinerary.addons.delay_protection

boolean

Indicates whether delay protection is selected.

industries.industry_details.itinerary.addons.travel_insurance

boolean

Indicates whether travel insurance is selected.

industries.industry_details.itinerary.addons.seats

boolean

Indicates whether seat selection is included.

industries.industry_details.fare_details

object

Fare and pricing information.

Show child attributes

industries.industry_details.fare_details.base_fare

string

Base fare amount before discounts.

industries.industry_details.fare_details.offer_fare

string

Final fare amount after discounts.

Indicates whether promotional offers were applied.

metadata

object

Additional metadata for the transaction.

Show child attributes

metadata.{key}

string

Example:

{
  "metadata_key_1": "metadata_value_1",
  "metadata_key_2": "metadata_value_2"
}

Response

Success response for submitting risk details.

status

string

Status of the request indicating success.

Example:

"SUCCESS"

message

string

Confirmation message indicating the risk details were successfully accepted.

Example:

"Risk details accepted"

⌘I

Payments API

v2025-01-01

Other Versions

Submit Risk Details

Headers

Body

Response