Fetch Single Subscription Payment

Fetch details of a specific payment associated with a subscription reference ID.

GET /api/v2/subscriptions/{subReferenceId}/payments/{paymentId}

Fetch Single Subscription Payment

cURL

curl --request GET \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/payments/{paymentId} \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Client-Secret: <x-client-secret>'

import requests

url = "https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/payments/{paymentId}"

headers = {
    "X-Client-Id": "<x-client-id>",
    "X-Client-Secret": "<x-client-secret>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Client-Id': '<x-client-id>', 'X-Client-Secret': '<x-client-secret>'}
};

fetch('https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/payments/{paymentId}', 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/api/v2/subscriptions/{subReferenceId}/payments/{paymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/payments/{paymentId}"

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

	req.Header.Add("X-Client-Id", "<x-client-id>")
	req.Header.Add("X-Client-Secret", "<x-client-secret>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/payments/{paymentId}")
  .header("X-Client-Id", "<x-client-id>")
  .header("X-Client-Secret", "<x-client-secret>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/payments/{paymentId}")

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

request = Net::HTTP::Get.new(url)
request["X-Client-Id"] = '<x-client-id>'
request["X-Client-Secret"] = '<x-client-secret>'

response = http.request(request)
puts response.read_body

200

{
  "status": "OK",
  "message": "Subscription Payment",
  "payment": {
    "paymentId": 2276563,
    "referenceId": 214308920,
    "cfOrderId": 236286405,
    "orderId": "ORD_24534",
    "subReferenceId": 5513463,
    "currency": "INR",
    "amount": 250,
    "cycle": 5,
    "status": "INITIALIZED",
    "remarks": null,
    "scheduledOn": "2021-09-13",
    "addedOn": "2021-09-09 11:05:19",
    "retryAttempts": 0,
    "failureReason": null,
    "merchantTxnId": null,
    "splitDetails": {
      "scheme": [
        {
          "merchantVendorId": "test-vendor-1",
          "percentage": 10
        },
        {
          "merchantVendorId": "test-vendor-2",
          "percentage": 10
        }
      ]
    }
  }
}

{
  "status": "ERROR",
  "subCode": "400",
  "message": "Invalid parameters provided"
}

{
  "status": "ERROR",
  "message": "Server encountered an unexpected condition."
}

Headers

X-Client-Id · string · required

Client ID provided by Cashfree.

Example:

"asdf1234"

X-Client-Secret · string · required

Client Secret provided by Cashfree.

Example:

"qwer9876"

Path Parameters

subReferenceId · integer · required

The reference ID of the subscription.

Example:

2568045

paymentId · integer · required

The payment ID whose details are to be fetched.

Example:

3027869

Response

200

application/json

Successful retrieval of the payment details.