POST
/
terminal
/
soundbox
curl --request POST \
  --url https://sandbox.cashfree.com/pg/terminal/soundbox \
  --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 '{
  "vpa": "cf.vpa-epos-gamma1018696837085fad68@sim",
  "cf_terminal_id": 3708,
  "device_serial_no": "abtest123",
  "merchant_name": "merchant-test",
  "language": "English"
}'
{
  "vpa": "cf.vpa-epos-gamma1018696837085fad68@sim",
  "cf_terminal_id": 3708,
  "device_serial_no": "abtest123",
  "merchant_name": "merchant-test",
  "language": "English"
}

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.

Body

application/json
Request body to onboard soundbox vpa
​
vpa
string
required

Terminal Vpa ,that need to onboard on soundbox

​
cf_terminal_id
string
required

cashfree terminal id.

​
device_serial_no
string
required

Device Serial No of soundbox

​
merchant_name
string

Merchant Name that need to onboard on soundbox

​
language
string

language of soundbox,currently English, Hindi, Tamil

Response

200
application/json
Soundbox vpa onboarded Successfully

soundbox response object

​
vpa
string
​
cf_terminal_id
string
​
device_serial_no
string
​
merchant_name
string
​
language
string

Was this page helpful?