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

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:2022-09-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<UUID>

Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors.

Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders

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
string