Skip to main content
GET
/
payout
/
v1.2
/
getBalance
Get Balance V1.2
curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1.2/getBalance \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
import requests

url = "https://payout-api.cashfree.com/payout/v1.2/getBalance"

headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'}
};

fetch('https://payout-api.cashfree.com/payout/v1.2/getBalance', 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://payout-api.cashfree.com/payout/v1.2/getBalance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://payout-api.cashfree.com/payout/v1.2/getBalance"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://payout-api.cashfree.com/payout/v1.2/getBalance")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://payout-api.cashfree.com/payout/v1.2/getBalance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'

response = http.request(request)
puts response.read_body
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Ledger balance for the account",
  "data": {
    "balance": "214735.50",
    "availableBalance": "173980.50"
  }
}
{
"status": "ERROR",
"subCode": "403",
"message": "APIs not enabled. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1)"
}
{
"status": "ERROR",
"subCode": "422",
"message": "Specified paymentInstrumentId not available."
}
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)

Headers

Authorization
string
required

Bearer auth token

Content-Type
string
required

application/json

Query Parameters

paymentInstrumentId
string

Specify the fund source ID from where you want the amount to be debited.

Response

200

status
string
Example:

"SUCCESS"

subCode
string
Example:

"200"

message
string
Example:

"Ledger balance for the account"

data
object