POST
/
terminal
/
soundbox

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 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 response object

vpa
string
cf_terminal_id
string
device_serial_no
string
merchant_name
string
language
string