curl --request PATCH \
--url https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id} \
--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 '
{
"terminal_email": "john@cashfree.com",
"terminal_phone_no": "9876543210",
"terminal_meta": null,
"terminal_status": "DOCS_AWAITED",
"terminal_type": "STOREFRONT"
}
'import requests
url = "https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}"
payload = {
"terminal_email": "john@cashfree.com",
"terminal_phone_no": "9876543210",
"terminal_meta": None,
"terminal_status": "DOCS_AWAITED",
"terminal_type": "STOREFRONT"
}
headers = {
"x-api-version": "<x-api-version>",
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-api-version': '<x-api-version>',
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
terminal_email: 'john@cashfree.com',
terminal_phone_no: '9876543210',
terminal_meta: null,
terminal_status: 'DOCS_AWAITED',
terminal_type: 'STOREFRONT'
})
};
fetch('https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}', 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/{cf_terminal_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'terminal_email' => 'john@cashfree.com',
'terminal_phone_no' => '9876543210',
'terminal_meta' => null,
'terminal_status' => 'DOCS_AWAITED',
'terminal_type' => 'STOREFRONT'
]),
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/{cf_terminal_id}"
payload := strings.NewReader("{\n \"terminal_email\": \"john@cashfree.com\",\n \"terminal_phone_no\": \"9876543210\",\n \"terminal_meta\": null,\n \"terminal_status\": \"DOCS_AWAITED\",\n \"terminal_type\": \"STOREFRONT\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}")
.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 \"terminal_email\": \"john@cashfree.com\",\n \"terminal_phone_no\": \"9876543210\",\n \"terminal_meta\": null,\n \"terminal_status\": \"DOCS_AWAITED\",\n \"terminal_type\": \"STOREFRONT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.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 \"terminal_email\": \"john@cashfree.com\",\n \"terminal_phone_no\": \"9876543210\",\n \"terminal_meta\": null,\n \"terminal_status\": \"DOCS_AWAITED\",\n \"terminal_type\": \"STOREFRONT\"\n}"
response = http.request(request)
puts response.read_body[
{
"added_on": "023-10-12T11:12:39+05:30",
"cf_terminal_id": 1838,
"last_updated_on": "023-10-12T11:12:39+05:30",
"terminal_address": "Cashfree Payments India Pvt Ltd RMZ Eco world, Building 7 10th Floor, Devarabeesanahalli, Marathalli Outer Ring road, Bangalore - 560103",
"terminal_email": "john@cashfree.com",
"terminal_id": "test",
"terminal_meta": {
"terminal_operator": "dev test"
},
"terminal_name": "john doe",
"terminal_note": "POS vertical",
"terminal_phone_no": 9876543214,
"terminal_status": "DOCS_AWAITED",
"terminal_type": "STOREFRONT"
}
]{
"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"
}Update Terminal
Use this API to update the terminal details. Email, Phone Number, and Terminal Meta are updatable for āStorefrontā. Only account status change is possible in case of āAgentā.
curl --request PATCH \
--url https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id} \
--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 '
{
"terminal_email": "john@cashfree.com",
"terminal_phone_no": "9876543210",
"terminal_meta": null,
"terminal_status": "DOCS_AWAITED",
"terminal_type": "STOREFRONT"
}
'import requests
url = "https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}"
payload = {
"terminal_email": "john@cashfree.com",
"terminal_phone_no": "9876543210",
"terminal_meta": None,
"terminal_status": "DOCS_AWAITED",
"terminal_type": "STOREFRONT"
}
headers = {
"x-api-version": "<x-api-version>",
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-api-version': '<x-api-version>',
'x-client-id': '<api-key>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
terminal_email: 'john@cashfree.com',
terminal_phone_no: '9876543210',
terminal_meta: null,
terminal_status: 'DOCS_AWAITED',
terminal_type: 'STOREFRONT'
})
};
fetch('https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}', 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/{cf_terminal_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'terminal_email' => 'john@cashfree.com',
'terminal_phone_no' => '9876543210',
'terminal_meta' => null,
'terminal_status' => 'DOCS_AWAITED',
'terminal_type' => 'STOREFRONT'
]),
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/{cf_terminal_id}"
payload := strings.NewReader("{\n \"terminal_email\": \"john@cashfree.com\",\n \"terminal_phone_no\": \"9876543210\",\n \"terminal_meta\": null,\n \"terminal_status\": \"DOCS_AWAITED\",\n \"terminal_type\": \"STOREFRONT\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}")
.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 \"terminal_email\": \"john@cashfree.com\",\n \"terminal_phone_no\": \"9876543210\",\n \"terminal_meta\": null,\n \"terminal_status\": \"DOCS_AWAITED\",\n \"terminal_type\": \"STOREFRONT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/terminal/{cf_terminal_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.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 \"terminal_email\": \"john@cashfree.com\",\n \"terminal_phone_no\": \"9876543210\",\n \"terminal_meta\": null,\n \"terminal_status\": \"DOCS_AWAITED\",\n \"terminal_type\": \"STOREFRONT\"\n}"
response = http.request(request)
puts response.read_body[
{
"added_on": "023-10-12T11:12:39+05:30",
"cf_terminal_id": 1838,
"last_updated_on": "023-10-12T11:12:39+05:30",
"terminal_address": "Cashfree Payments India Pvt Ltd RMZ Eco world, Building 7 10th Floor, Devarabeesanahalli, Marathalli Outer Ring road, Bangalore - 560103",
"terminal_email": "john@cashfree.com",
"terminal_id": "test",
"terminal_meta": {
"terminal_operator": "dev test"
},
"terminal_name": "john doe",
"terminal_note": "POS vertical",
"terminal_phone_no": 9876543214,
"terminal_status": "DOCS_AWAITED",
"terminal_type": "STOREFRONT"
}
]{
"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.
Path Parameters
Provide the Cashfree terminal ID for which the details have to be updated.
Body
Request Body to update terminal for SPOS.
Request body to update terminal details.
Mention the terminal type to be updated. Possible values - AGENT, STOREFRONT.
Mention the updated email ID of the terminal.
Terminal phone number to be updated.
10Terminal metadata.
Show child attributes
Show child attributes
Was this page helpful?