Skip to main content
GET
/
terminal
/
{terminal_phone_no}
Get Terminal Status using Phone Number
curl --request GET \
  --url https://sandbox.cashfree.com/pg/terminal/{terminal_phone_no} \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "added_on": "023-10-12T11:12:39+05:30",
  "cf_terminal_id": 1838,
  "last_updated_on": "023-10-12T11:12:39+05:30",
  "terminal_address": "Bangalore",
  "terminal_email": "john@cashfree.com",
  "terminal_id": "test",
  "terminal_meta": {
    "terminal_operator": "dev test"
  },
  "terminal_name": "john doe",
  "terminal_note": "POS vertical",
  "terminal_phone_no": 9876543214,
  "terminal_status": "DOCS_AWAITED",
  "terminal_type": "STOREFRONT"
}

Documentation Index

Fetch the complete documentation index at: https://telr-docs.cashfree.com/llms.txt

Use this file to discover all available pages before exploring further.

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: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

​
terminal_phone_no
string
required

The terminal for which you want to view the order details.

Response

OK

Create terminal response object

​
added_on
string
​
cf_terminal_id
integer
​
last_updated_on
string
​
terminal_address
string
​
terminal_email
string
​
terminal_type
string
​
teminal_id
string
​
terminal_name
string
​
terminal_note
string
​
terminal_phone_no
string
​
terminal_status
string
​
terminal_meta
object

Terminal metadata, required field for storefront.