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"
}
'import requests
url = "https://sandbox.cashfree.com/pg/terminal/soundbox"
payload = {
"vpa": "cf.vpa-epos-gamma1018696837085fad68@sim",
"cf_terminal_id": 3708,
"device_serial_no": "abtest123",
"merchant_name": "merchant-test",
"language": "English"
}
headers = {
"x-api-version": "<x-api-version>",
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-version': '<x-api-version>',
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
vpa: 'cf.vpa-epos-gamma1018696837085fad68@sim',
cf_terminal_id: 3708,
device_serial_no: 'abtest123',
merchant_name: 'merchant-test',
language: 'English'
})
};
fetch('https://sandbox.cashfree.com/pg/terminal/soundbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/pg/terminal/soundbox",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'vpa' => 'cf.vpa-epos-gamma1018696837085fad68@sim',
'cf_terminal_id' => 3708,
'device_serial_no' => 'abtest123',
'merchant_name' => 'merchant-test',
'language' => 'English'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-version: <x-api-version>",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/pg/terminal/soundbox"
payload := strings.NewReader("{\n \"vpa\": \"cf.vpa-epos-gamma1018696837085fad68@sim\",\n \"cf_terminal_id\": 3708,\n \"device_serial_no\": \"abtest123\",\n \"merchant_name\": \"merchant-test\",\n \"language\": \"English\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/pg/terminal/soundbox")
.header("x-api-version", "<x-api-version>")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vpa\": \"cf.vpa-epos-gamma1018696837085fad68@sim\",\n \"cf_terminal_id\": 3708,\n \"device_serial_no\": \"abtest123\",\n \"merchant_name\": \"merchant-test\",\n \"language\": \"English\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/terminal/soundbox")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vpa\": \"cf.vpa-epos-gamma1018696837085fad68@sim\",\n \"cf_terminal_id\": 3708,\n \"device_serial_no\": \"abtest123\",\n \"merchant_name\": \"merchant-test\",\n \"language\": \"English\"\n}"
response = http.request(request)
puts response.read_body{
"vpa": "cf.vpa-epos-gamma1018696837085fad68@sim",
"cf_terminal_id": 3708,
"device_serial_no": "abtest123",
"merchant_name": "merchant-test",
"language": "English"
}{
"message": "bad URL, please check API documentation",
"code": "request_failed",
"type": "invalid_request_error"
}{
"message": "authentication Failed",
"code": "request_failed",
"type": "authentication_error"
}{
"message": "something is not found",
"code": "somethind_not_found",
"type": "invalid_request_error"
}{
"message": "order with same id is already present",
"code": "order_already_exists",
"type": "invalid_request_error"
}{
"message": "something is not found",
"code": "request_invalid",
"type": "idempotency_error"
}{
"message": "Too many requests from IP. Check headers",
"code": "request_failed",
"type": "rate_limit_error"
}{
"message": "internal Server Error",
"code": "internal_error",
"type": "api_error"
}Onboard Soundbox Vpa
Use this API to onboard a terminal Vpa to 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"
}
'import requests
url = "https://sandbox.cashfree.com/pg/terminal/soundbox"
payload = {
"vpa": "cf.vpa-epos-gamma1018696837085fad68@sim",
"cf_terminal_id": 3708,
"device_serial_no": "abtest123",
"merchant_name": "merchant-test",
"language": "English"
}
headers = {
"x-api-version": "<x-api-version>",
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-version': '<x-api-version>',
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
vpa: 'cf.vpa-epos-gamma1018696837085fad68@sim',
cf_terminal_id: 3708,
device_serial_no: 'abtest123',
merchant_name: 'merchant-test',
language: 'English'
})
};
fetch('https://sandbox.cashfree.com/pg/terminal/soundbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/pg/terminal/soundbox",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'vpa' => 'cf.vpa-epos-gamma1018696837085fad68@sim',
'cf_terminal_id' => 3708,
'device_serial_no' => 'abtest123',
'merchant_name' => 'merchant-test',
'language' => 'English'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-version: <x-api-version>",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/pg/terminal/soundbox"
payload := strings.NewReader("{\n \"vpa\": \"cf.vpa-epos-gamma1018696837085fad68@sim\",\n \"cf_terminal_id\": 3708,\n \"device_serial_no\": \"abtest123\",\n \"merchant_name\": \"merchant-test\",\n \"language\": \"English\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-version", "<x-api-version>")
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/pg/terminal/soundbox")
.header("x-api-version", "<x-api-version>")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vpa\": \"cf.vpa-epos-gamma1018696837085fad68@sim\",\n \"cf_terminal_id\": 3708,\n \"device_serial_no\": \"abtest123\",\n \"merchant_name\": \"merchant-test\",\n \"language\": \"English\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/terminal/soundbox")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vpa\": \"cf.vpa-epos-gamma1018696837085fad68@sim\",\n \"cf_terminal_id\": 3708,\n \"device_serial_no\": \"abtest123\",\n \"merchant_name\": \"merchant-test\",\n \"language\": \"English\"\n}"
response = http.request(request)
puts response.read_body{
"vpa": "cf.vpa-epos-gamma1018696837085fad68@sim",
"cf_terminal_id": 3708,
"device_serial_no": "abtest123",
"merchant_name": "merchant-test",
"language": "English"
}{
"message": "bad URL, please check API documentation",
"code": "request_failed",
"type": "invalid_request_error"
}{
"message": "authentication Failed",
"code": "request_failed",
"type": "authentication_error"
}{
"message": "something is not found",
"code": "somethind_not_found",
"type": "invalid_request_error"
}{
"message": "order with same id is already present",
"code": "order_already_exists",
"type": "invalid_request_error"
}{
"message": "something is not found",
"code": "request_invalid",
"type": "idempotency_error"
}{
"message": "Too many requests from IP. Check headers",
"code": "request_failed",
"type": "rate_limit_error"
}{
"message": "internal Server Error",
"code": "internal_error",
"type": "api_error"
}Authorizations
Client app ID. You can find your app id in the Merchant Dashboard.
Client secret key. You can find your secret key in the Merchant Dashboard.
Headers
API version to be used
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
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
Request body to onboard soundbox vpa
Request body to onboard soundbox vpa
Terminal Vpa ,that need to onboard on soundbox
cashfree terminal id.
Device Serial No of soundbox
Merchant Name that need to onboard on soundbox
language of soundbox,currently English, Hindi, Tamil
Was this page helpful?