PATCH
/
terminal
/
{cf_terminal_id}
/
soundbox
curl --request PATCH \
  --url https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}/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,
  "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: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.

Path Parameters

cf_terminal_id
integer
required

Provide the Cashfree terminal ID for which the details have to be updated.

Body

application/json

Request body to update soundbox vpa

Response

200
application/json

Soundbox vpa updated Successfully

soundbox response object