Create Terminal

Use this API to create new terminals to use softPOS.

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

Body

application/json

Request Body to Create Terminal for SPOS

Request body to create a terminal

terminal_id · string · required

merchant’s internal terminal id

Required string length: 3 - 100

terminal_phone_no · string · required

phone number assigned to the terminal

Required string length: 10

terminal_name · string · required

terminal name to be assigned by merchants

Required string length: 3 - 100

terminal_email · string · required

terminal email ID of the AGENT/STOREFRONT assigned by merchants.

Required string length: 1 - 100

terminal_type · string · required

mention the terminal type. possible values - AGENT, STOREFRONT.

Required string length: 1 - 100

terminal_address · string

address of the terminal. required for STOREFRONT

Required string length: 1 - 100

terminal_note · string

additional note for terminal

Required string length: 1 - 100

terminal_meta · object

terminal metadata. required field for storefront.

Show child attributes

Response

200

application/json

Terminal created

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