POST
/
terminal
Create Terminal
curl --request POST \
  --url https://sandbox.cashfree.com/pg/terminal \
  --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_id": "someTerminalID",
  "terminal_name": "Jane Doe",
  "terminal_email": "john@cashfree.com",
  "terminal_meta": null,
  "terminal_type": "STOREFRONT",
  "terminal_phone_no": "9876543210",
  "terminal_note": "POS Vertical",
  "terminal_address": "Bangalore"
}'
{
  "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:2025-01-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.

Body

application/json

Request Body to Create Terminal for SPOS

Request body to create a terminal

Response

200
application/json

Terminal created

Create terminal response object