POST
/
terminal

Authorizations

x-client-id
string
headerrequired

Client app ID. You can find your app id in the Merchant Dashboard.

x-client-secret
string
headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

x-api-version
string
default: 2023-08-01required

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

Response

200 - application/json

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