curl --request POST \
--url https://sandbox.cashfree.com/pg/vba/notificationgroup \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>' \
--data '
{
"notification_group_name": "finance_team",
"notification_group_emails": [
"user@cashfree.com"
],
"notification_group_phone_numbers": [
"9876543210"
]
}
'import requests
url = "https://sandbox.cashfree.com/pg/vba/notificationgroup"
payload = {
"notification_group_name": "finance_team",
"notification_group_emails": ["user@cashfree.com"],
"notification_group_phone_numbers": ["9876543210"]
}
headers = {
"x-client-id": "<x-client-id>",
"x-client-secret": "<x-client-secret>",
"x-api-version": "<x-api-version>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<x-client-id>',
'x-client-secret': '<x-client-secret>',
'x-api-version': '<x-api-version>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
notification_group_name: 'finance_team',
notification_group_emails: ['user@cashfree.com'],
notification_group_phone_numbers: ['9876543210']
})
};
fetch('https://sandbox.cashfree.com/pg/vba/notificationgroup', 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/vba/notificationgroup",
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([
'notification_group_name' => 'finance_team',
'notification_group_emails' => [
'user@cashfree.com'
],
'notification_group_phone_numbers' => [
'9876543210'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-version: <x-api-version>",
"x-client-id: <x-client-id>",
"x-client-secret: <x-client-secret>"
],
]);
$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/vba/notificationgroup"
payload := strings.NewReader("{\n \"notification_group_name\": \"finance_team\",\n \"notification_group_emails\": [\n \"user@cashfree.com\"\n ],\n \"notification_group_phone_numbers\": [\n \"9876543210\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("x-client-secret", "<x-client-secret>")
req.Header.Add("x-api-version", "<x-api-version>")
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/vba/notificationgroup")
.header("x-client-id", "<x-client-id>")
.header("x-client-secret", "<x-client-secret>")
.header("x-api-version", "<x-api-version>")
.header("Content-Type", "application/json")
.body("{\n \"notification_group_name\": \"finance_team\",\n \"notification_group_emails\": [\n \"user@cashfree.com\"\n ],\n \"notification_group_phone_numbers\": [\n \"9876543210\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/vba/notificationgroup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["x-client-secret"] = '<x-client-secret>'
request["x-api-version"] = '<x-api-version>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"notification_group_name\": \"finance_team\",\n \"notification_group_emails\": [\n \"user@cashfree.com\"\n ],\n \"notification_group_phone_numbers\": [\n \"9876543210\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"notification_group": {
"notification_group_name": "finance_team",
"notification_group_emails": [
"user@cashfree.com"
],
"notification_group_phone_numbers": [
"9876543210"
],
"notification_group_created_on": "2019-08-24T14:15:22Z",
"notification_group_last_updated_on": "2019-08-24T14:15:22Z"
}
}{
"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": "something is not found",
"code": "bank_processing_failure",
"type": "api_error"
}Create VBA Notification Group
Use this API to create a notification group. The recipients in the group will receive notifications regarding the payment details.
curl --request POST \
--url https://sandbox.cashfree.com/pg/vba/notificationgroup \
--header 'Content-Type: application/json' \
--header 'x-api-version: <x-api-version>' \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>' \
--data '
{
"notification_group_name": "finance_team",
"notification_group_emails": [
"user@cashfree.com"
],
"notification_group_phone_numbers": [
"9876543210"
]
}
'import requests
url = "https://sandbox.cashfree.com/pg/vba/notificationgroup"
payload = {
"notification_group_name": "finance_team",
"notification_group_emails": ["user@cashfree.com"],
"notification_group_phone_numbers": ["9876543210"]
}
headers = {
"x-client-id": "<x-client-id>",
"x-client-secret": "<x-client-secret>",
"x-api-version": "<x-api-version>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<x-client-id>',
'x-client-secret': '<x-client-secret>',
'x-api-version': '<x-api-version>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
notification_group_name: 'finance_team',
notification_group_emails: ['user@cashfree.com'],
notification_group_phone_numbers: ['9876543210']
})
};
fetch('https://sandbox.cashfree.com/pg/vba/notificationgroup', 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/vba/notificationgroup",
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([
'notification_group_name' => 'finance_team',
'notification_group_emails' => [
'user@cashfree.com'
],
'notification_group_phone_numbers' => [
'9876543210'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-version: <x-api-version>",
"x-client-id: <x-client-id>",
"x-client-secret: <x-client-secret>"
],
]);
$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/vba/notificationgroup"
payload := strings.NewReader("{\n \"notification_group_name\": \"finance_team\",\n \"notification_group_emails\": [\n \"user@cashfree.com\"\n ],\n \"notification_group_phone_numbers\": [\n \"9876543210\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("x-client-secret", "<x-client-secret>")
req.Header.Add("x-api-version", "<x-api-version>")
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/vba/notificationgroup")
.header("x-client-id", "<x-client-id>")
.header("x-client-secret", "<x-client-secret>")
.header("x-api-version", "<x-api-version>")
.header("Content-Type", "application/json")
.body("{\n \"notification_group_name\": \"finance_team\",\n \"notification_group_emails\": [\n \"user@cashfree.com\"\n ],\n \"notification_group_phone_numbers\": [\n \"9876543210\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/vba/notificationgroup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["x-client-secret"] = '<x-client-secret>'
request["x-api-version"] = '<x-api-version>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"notification_group_name\": \"finance_team\",\n \"notification_group_emails\": [\n \"user@cashfree.com\"\n ],\n \"notification_group_phone_numbers\": [\n \"9876543210\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"notification_group": {
"notification_group_name": "finance_team",
"notification_group_emails": [
"user@cashfree.com"
],
"notification_group_phone_numbers": [
"9876543210"
],
"notification_group_created_on": "2019-08-24T14:15:22Z",
"notification_group_last_updated_on": "2019-08-24T14:15:22Z"
}
}{
"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": "something is not found",
"code": "bank_processing_failure",
"type": "api_error"
}Headers
client id generated from the merchant dashboard
client secret generated from the merchant dashboard
API version to be used. The accepted format is YYYY-MM-DD.
2024-07-10T00:00:00.000Z Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree Payments.
"4dfb9780-46fe-11ee-be56-0242ac120002"
Body
PG VBA Notification Group Create Request
It is the name you create to identify the notification group. The parameter allows alphanumeric characters, hyphen (-), and underscore ( _ ).
"finance_team"
It is the email addresses of the recipients who receive the notifications.
It is the phone number of the recipients who receive the notifications.
Response
Success Response.
Show child attributes
Show child attributes
