GET
/
terminal
/
{cf_terminal_id}
/
payments

Authorizations

x-client-id
string
headerrequired

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

x-client-secret
string
headerrequired

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

Headers

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

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_terminal_id
string
required

Provide the Cashfree terminal ID for which the details have to be updated.

Query Parameters

utr
string
required

Utr of the transaction.

Response

200 - application/json

terminal payment entity full object

cf_payment_id
string
order_id
string
entity
string
error_details
object

The error details are present only for failed payments

is_captured
boolean
order_amount
number

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

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_currency
string
payment_amount
number
payment_time
string

This is the time when the payment was initiated

payment_completion_time
string

This is the time when the payment reaches its terminal state

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_message
string
bank_reference
string
auth_id
string
authorization
object

If preauth enabled for account you will get this body

customer_details
object

The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.

payment_method
object

payment method card object in payment entity