PATCH
/
terminal
/
{cf_terminal_id}
/
status
curl --request PATCH \
  --url https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}/status \
  --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 '{
  "terminal_status": "ACTIVE"
}'
[
  {
    "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": "Cashfree Payments India Pvt Ltd, Vaishnavi Summit, No. 6/B, Summit, 80 Feet Rd, Koramangala 1A Block, Koramangala 3 Block, Koramangala, Bengaluru, Karnataka 560034",
    "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:2023-08-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

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.

Body

application/json
Request Body to update terminal status for SPOS.

Request body to update terminal status.

​
terminal_status
string
required

Status of the terminal to be updated. possible values - ACTIVE, INACTIVE.

Response

200
application/json
Updated Terminal Status
​
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

Was this page helpful?