curl --request POST \
--url https://sandbox.cashfree.com/pg/vba/payments \
--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 '
{
"status": "SUCCESS",
"start_date": "1995-11-10 18:12:22",
"end_date": "2023-11-10 12:10:10",
"virtual_account_id": "User01",
"pagination": {
"cursor": ">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
"limit": 10
}
}
'import requests
url = "https://sandbox.cashfree.com/pg/vba/payments"
payload = {
"status": "SUCCESS",
"start_date": "1995-11-10 18:12:22",
"end_date": "2023-11-10 12:10:10",
"virtual_account_id": "User01",
"pagination": {
"cursor": ">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
"limit": 10
}
}
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({
status: 'SUCCESS',
start_date: '1995-11-10 18:12:22',
end_date: '2023-11-10 12:10:10',
virtual_account_id: 'User01',
pagination: {
cursor: '>- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==',
limit: 10
}
})
};
fetch('https://sandbox.cashfree.com/pg/vba/payments', 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/payments",
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([
'status' => 'SUCCESS',
'start_date' => '1995-11-10 18:12:22',
'end_date' => '2023-11-10 12:10:10',
'virtual_account_id' => 'User01',
'pagination' => [
'cursor' => '>- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==',
'limit' => 10
]
]),
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/payments"
payload := strings.NewReader("{\n \"status\": \"SUCCESS\",\n \"start_date\": \"1995-11-10 18:12:22\",\n \"end_date\": \"2023-11-10 12:10:10\",\n \"virtual_account_id\": \"User01\",\n \"pagination\": {\n \"cursor\": \">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\",\n \"limit\": 10\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/payments")
.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 \"status\": \"SUCCESS\",\n \"start_date\": \"1995-11-10 18:12:22\",\n \"end_date\": \"2023-11-10 12:10:10\",\n \"virtual_account_id\": \"User01\",\n \"pagination\": {\n \"cursor\": \">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\",\n \"limit\": 10\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/vba/payments")
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 \"status\": \"SUCCESS\",\n \"start_date\": \"1995-11-10 18:12:22\",\n \"end_date\": \"2023-11-10 12:10:10\",\n \"virtual_account_id\": \"User01\",\n \"pagination\": {\n \"cursor\": \">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\",\n \"limit\": 10\n }\n}"
response = http.request(request)
puts response.read_body{
"cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
"limit": "10",
"payments": {
"payment_details": [
{
"virtual_account_id": "User01",
"utr": "912345678912",
"remitter_account": "026291800001191",
"remitter_name": "Doe John",
"amount": "10",
"reference_id": "001",
"credit_ref_number": "2382053846",
"txtime": "2007-06-28 15:28:08",
"is_settled": "1",
"txstatus": "SUCCESS"
}
]
}
}{
"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"
}Get VBA Payments
Use this API to get all the payment details regarding a virtual bank account.
curl --request POST \
--url https://sandbox.cashfree.com/pg/vba/payments \
--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 '
{
"status": "SUCCESS",
"start_date": "1995-11-10 18:12:22",
"end_date": "2023-11-10 12:10:10",
"virtual_account_id": "User01",
"pagination": {
"cursor": ">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
"limit": 10
}
}
'import requests
url = "https://sandbox.cashfree.com/pg/vba/payments"
payload = {
"status": "SUCCESS",
"start_date": "1995-11-10 18:12:22",
"end_date": "2023-11-10 12:10:10",
"virtual_account_id": "User01",
"pagination": {
"cursor": ">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
"limit": 10
}
}
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({
status: 'SUCCESS',
start_date: '1995-11-10 18:12:22',
end_date: '2023-11-10 12:10:10',
virtual_account_id: 'User01',
pagination: {
cursor: '>- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==',
limit: 10
}
})
};
fetch('https://sandbox.cashfree.com/pg/vba/payments', 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/payments",
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([
'status' => 'SUCCESS',
'start_date' => '1995-11-10 18:12:22',
'end_date' => '2023-11-10 12:10:10',
'virtual_account_id' => 'User01',
'pagination' => [
'cursor' => '>- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==',
'limit' => 10
]
]),
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/payments"
payload := strings.NewReader("{\n \"status\": \"SUCCESS\",\n \"start_date\": \"1995-11-10 18:12:22\",\n \"end_date\": \"2023-11-10 12:10:10\",\n \"virtual_account_id\": \"User01\",\n \"pagination\": {\n \"cursor\": \">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\",\n \"limit\": 10\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/payments")
.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 \"status\": \"SUCCESS\",\n \"start_date\": \"1995-11-10 18:12:22\",\n \"end_date\": \"2023-11-10 12:10:10\",\n \"virtual_account_id\": \"User01\",\n \"pagination\": {\n \"cursor\": \">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\",\n \"limit\": 10\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/pg/vba/payments")
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 \"status\": \"SUCCESS\",\n \"start_date\": \"1995-11-10 18:12:22\",\n \"end_date\": \"2023-11-10 12:10:10\",\n \"virtual_account_id\": \"User01\",\n \"pagination\": {\n \"cursor\": \">- eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==\",\n \"limit\": 10\n }\n}"
response = http.request(request)
puts response.read_body{
"cursor": "eyJzZWFyY2hBZnRlciI6eyJsaXN0IjpbMTg4NjcxNDVdLCJlbXB0eSI6ZmFsc2V9LCJyZWNvbkFQSVR5cGUiOiJMRURHRVIifQ==",
"limit": "10",
"payments": {
"payment_details": [
{
"virtual_account_id": "User01",
"utr": "912345678912",
"remitter_account": "026291800001191",
"remitter_name": "Doe John",
"amount": "10",
"reference_id": "001",
"credit_ref_number": "2382053846",
"txtime": "2007-06-28 15:28:08",
"is_settled": "1",
"txstatus": "SUCCESS"
}
]
}
}{
"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 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.
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.
"4dfb9780-46fe-11ee-be56-0242ac120002"
Body
Request parameters to get payment details of the virtual bank account.
It is the status of the payment.
ALL, SUCCESS, REJECTED "SUCCESS"
It is the specific start date and time to retrieve the payment details associated with the virtual bank account. Allowed format - YYYYY-MM-DD HH:MM:SS
"1995-11-10 18:12:22"
It is the specific end date and time to retrieve the payment details associated with the virtual bank account. Allowed format - YYYY-MM-DD HH:MM:SS
"2023-11-10 12:10:10"
It is the unique ID you created to identify the virtual bank account. The API retrieves all payment details with respect to this ID.
"User01"
It contains parameters to mange and control the retrieval of paginated data.
Show child attributes
Show child attributes
Was this page helpful?