GET
/
orders
/
{order_id}
/
payments

Authorizations

x-client-id
string
header
required

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

x-client-secret
string
header
required

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

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

order_id
string
required

The id which uniquely identifies your order

Response

200 - application/json
auth_id
string
authorization
object

If preauth enabled for account you will get this body

bank_reference
string
cf_payment_id
string
entity
string
error_details
object

The error details are present only for failed payments

international_payment
object

International payment details

is_captured
boolean
order_amount
number

Order amount can be different from payment amount if you collect service fee from the customer

order_id
string
payment_amount
number
payment_completion_time
string

This is the time when the payment reaches its terminal state

payment_currency
string
payment_gateway_details
object

payment gateway details present in the webhook response

payment_group
string

Type of payment group. One of ['prepaid_card', 'upi_ppi_offline', 'cash', 'upi_credit_card', 'paypal', 'net_banking', 'cardless_emi', 'credit_card', 'bank_transfer', 'pay_later', 'debit_card_emi', 'debit_card', 'wallet', 'upi_ppi', 'upi', 'credit_card_emi']

payment_message
string
payment_method
object

payment method card object in payment entity

payment_status
enum<string>

The transaction status can be one of ["SUCCESS", "NOT_ATTEMPTED", "FAILED", "USER_DROPPED", "VOID", "CANCELLED", "PENDING"]

Available options:
SUCCESS,
NOT_ATTEMPTED,
FAILED,
USER_DROPPED,
VOID,
CANCELLED,
PENDING
payment_time
string

This is the time when the payment was initiated