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

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

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/getCashgramStatus', 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/getCashgramStatus",
  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/getCashgramStatus"

	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/getCashgramStatus")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .asString();
require 'uri'
require 'net/http'

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

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": "Cashgram details retrieved",
  "data": {
    "cashgramStatus": "ACTIVE",
    "referenceId": 123456,
    "cashgramId": "JOHaN10",
    "cashgramLink": "http://csgr.am/abcdefg"
  }
}
{
  "status": "ERROR",
  "subCode": "404",
  "message": "Cashgram with id JOHaN10 does not exists"
}

Headers

Authorization
string
required

Bearer auth token

Content-Type
string
required

application/json

Query Parameters

cashgramId
string
required

ID of the Cashgram

Response

200

status
string
Example:

"SUCCESS"

subCode
string
Example:

"200"

message
string
Example:

"Cashgram details retrieved"

data
object