Skip to main content
POST
/
terminal
/
payments
Get list of terminal transactions
curl --request POST \
  --url https://sandbox.cashfree.com/pg/terminal/payments \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "filter": {
    "start_date": "2023-08-04T13:12:58+05:30",
    "end_date": "2023-08-04T13:12:58+05:30",
    "cf_terminal_id": "1234",
    "terminal_vpa": "cf.epos@cash",
    "terminal_phone_no": "9696969696",
    "payment_status": "SUCCESS",
    "payment_group": "UPI",
    "sort_by": "start_date",
    "sort_order": "ASC"
  },
  "pagination": {
    "page_number": 1,
    "page_size": 50
  }
}
'
[
  {
    "cf_terminal_id": 12376123,
    "terminal_id": "abcd",
    "terminal_vpa": "cf.epose@cashfreensdlpb",
    "cf_payment_id": 12394,
    "payment_amount": 10.1,
    "payment_mode": "UPI_OFFLINE_STATIC",
    "payment_status": "SUCCESS",
    "payment_time": "2023-11-28T15:59:55+05:30"
  }
]

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.

Body

application/json

Request parameters to fetch a paginated list of terminal payment transactions.

​
filter
TerminalFilters · object

Use this object to filter terminal transactions based on various criteria.

Example:
{
  "start_date": "2023-08-04T13:12:58+05:30",
  "end_date": "2023-08-04T13:12:58+05:30",
  "cf_terminal_id": 1234,
  "terminal_vpa": "cf.epos@cash",
  "terminal_phone_no": "9696969696",
  "payment_status": "SUCCESS",
  "payment_group": "UPI",
  "sort_by": "start_date",
  "sort_order": "ASC"
}
​
pagination
TerminalPagination · object

Use this object to configure pagination for terminal transaction results.

Example:
{ "page_number": 1, "page_size": 50 }

Response

Success response for fetching a paginated list of terminal payment transactions.

​
cf_terminal_id
integer

Unique Cashfree terminal identifier.

​
terminal_id
string

Merchant-defined terminal identifier.

​
terminal_vpa
string

Virtual payment address (VPA) associated with the terminal.

​
cf_payment_id
integer

Unique Cashfree payment identifier.

​
payment_amount
number

Payment transaction amount in the specified currency.

​
payment_mode
string

Payment method used for the transaction (for example, UPI_OFFLINE_STATIC).

​
payment_status
string

Current status of the payment transaction (SUCCESS, FAILED, or PENDING).

​
payment_time
string

Timestamp when the payment was processed in ISO8601 format.

​
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": ""
}