Skip to main content
GET
/
terminal
/
{cf_terminal_id}
/
payments
Get Terminal Transaction
curl --request GET \
  --url https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}/payments \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "$ref": "#/components/examples/terminal_payments_entity_list_example/value/0"
}

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 key in the Merchant Dashboard.

Headers

​
x-api-version
string
default:2025-01-01
required

API version to be used.

​
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<UUID>

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
integer
required

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

Query Parameters

​
utr
string
required

Utr of the transaction.

Response

Fetch Terminal Transaction.

terminal payment entity full object.

​
cf_payment_id
integer<int64>
​
order_id
string
​
entity
string
​
error_details
ErrorDetailsInPayments · object

The error details are present only for failed payments.

Example:
{
  "error_code": "TRANSACTION_DECLINED",
  "error_description": "issuer bank or payment service provider declined the transaction",
  "error_reason": "auth_declined",
  "error_source": "customer",
  "error_code_raw": "ZM",
  "error_description_raw": "INVALID / INCORRECT MPIN",
  "error_subcode_raw": ""
}
​
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
AuthorizationInPayments · object

If preauth enabled for account you will get this body.

Example:
{
  "action": "CAPTURE",
  "status": "PENDING",
  "captured_amount": 100,
  "start_time": "2022-02-09T18:04:34+05:30",
  "end_time": "2022-02-19T18:04:34+05:30",
  "approve_by": "2022-02-09T18:04:34+05:30",
  "action_reference": "6595231908096894505959",
  "action_time": "2022-08-03T16:09:51"
}
​
customer_details
CustomerDetails · object

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

Example:
{
  "customer_id": "7112AAA812234",
  "customer_email": "john@cashfree.com",
  "customer_phone": "9908734801",
  "customer_name": "John Doe",
  "customer_bank_account_number": "1518121112",
  "customer_bank_ifsc": "XITI0000001",
  "customer_bank_code": 3333,
  "customer_uid": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10"
}
​
payment_method
Card · object

The following code samples show the payment method object payload for different payment methods.

Example:
{
  "channel": "link",
  "card_number": "XXXXXXXXXXXX4738",
  "card_network": "visa",
  "card_type": "credit_card",
  "card_sub_type": "R",
  "card_country": "IN",
  "card_bank_name": "HDFC Bank",
  "card_network_reference_id": "100212023061229",
  "instrument_id": "3fc5814b-e732-4a71-b2ee-94b4f147d9e1"
}
​
payment_gateway_details
PaymentGatewayDetails · object

payment gateway details present in the webhook response.