Bill Payment Response (Polling)

curl --request POST \
  --url https://sandbox.cashfree.com/bbps/cou/v1/billers/response/bill-payment \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "bill_fetch_ref_id": "REF20240501ABC123",
  "transaction_ref_id": "TXN20240501XYZ789"
}
'

import requests

url = "https://sandbox.cashfree.com/bbps/cou/v1/billers/response/bill-payment"

payload = {
    "bill_fetch_ref_id": "REF20240501ABC123",
    "transaction_ref_id": "TXN20240501XYZ789"
}
headers = {
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    bill_fetch_ref_id: 'REF20240501ABC123',
    transaction_ref_id: 'TXN20240501XYZ789'
  })
};

fetch('https://sandbox.cashfree.com/bbps/cou/v1/billers/response/bill-payment', 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/bbps/cou/v1/billers/response/bill-payment",
  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([
    'bill_fetch_ref_id' => 'REF20240501ABC123',
    'transaction_ref_id' => 'TXN20240501XYZ789'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-client-id: <api-key>",
    "x-client-secret: <api-key>"
  ],
]);

$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/bbps/cou/v1/billers/response/bill-payment"

	payload := strings.NewReader("{\n  \"bill_fetch_ref_id\": \"REF20240501ABC123\",\n  \"transaction_ref_id\": \"TXN20240501XYZ789\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")
	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/bbps/cou/v1/billers/response/bill-payment")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bill_fetch_ref_id\": \"REF20240501ABC123\",\n  \"transaction_ref_id\": \"TXN20240501XYZ789\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/bbps/cou/v1/billers/response/bill-payment")

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

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bill_fetch_ref_id\": \"REF20240501ABC123\",\n  \"transaction_ref_id\": \"TXN20240501XYZ789\"\n}"

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

{
  "status": "OK",
  "message": "Payment is still being processed",
  "data": {
    "status": "PROCESSING",
    "response": {
      "bill_payment_response": {
        "head": {
          "bill_fetch_ref_id": "REF20240501ABC123"
        },
        "reason": {
          "response_code": "PENDING",
          "response_reason": "Processing"
        },
        "txn": {
          "transaction_ref_id": "TXN20240501XYZ789"
        }
      }
    }
  }
}

Bill Payment

Bill Payment Response

Use this API to poll for the result of a previously submitted bill payment request. Call this using both bill_fetch_ref_id and transaction_ref_id from the Bill Payment Request API.

Polling strategy

Poll at increasing intervals until data.status is no longer "PROCESSING":

Attempt	Wait before this poll
1	5 seconds
2	15 seconds
3	30 seconds
4	1 minute
5+	3 minutes

Stop polling when data.status is "SUCCESS" or "FAILED". If the payment remains in a processing state beyond your retry limit, treat it as a timeout and raise a support ticket.

Response outcomes by `data.status`

PROCESSING: Payment is still in progress. Continue polling.
SUCCESS: Payment completed successfully.
FAILED: Payment failed.

POST

bbps

cou

billers

response

bill-payment

Bill Payment Response (Polling)

curl --request POST \
  --url https://sandbox.cashfree.com/bbps/cou/v1/billers/response/bill-payment \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "bill_fetch_ref_id": "REF20240501ABC123",
  "transaction_ref_id": "TXN20240501XYZ789"
}
'

import requests

url = "https://sandbox.cashfree.com/bbps/cou/v1/billers/response/bill-payment"

payload = {
    "bill_fetch_ref_id": "REF20240501ABC123",
    "transaction_ref_id": "TXN20240501XYZ789"
}
headers = {
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    bill_fetch_ref_id: 'REF20240501ABC123',
    transaction_ref_id: 'TXN20240501XYZ789'
  })
};

fetch('https://sandbox.cashfree.com/bbps/cou/v1/billers/response/bill-payment', 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/bbps/cou/v1/billers/response/bill-payment",
  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([
    'bill_fetch_ref_id' => 'REF20240501ABC123',
    'transaction_ref_id' => 'TXN20240501XYZ789'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-client-id: <api-key>",
    "x-client-secret: <api-key>"
  ],
]);

$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/bbps/cou/v1/billers/response/bill-payment"

	payload := strings.NewReader("{\n  \"bill_fetch_ref_id\": \"REF20240501ABC123\",\n  \"transaction_ref_id\": \"TXN20240501XYZ789\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")
	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/bbps/cou/v1/billers/response/bill-payment")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bill_fetch_ref_id\": \"REF20240501ABC123\",\n  \"transaction_ref_id\": \"TXN20240501XYZ789\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/bbps/cou/v1/billers/response/bill-payment")

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

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bill_fetch_ref_id\": \"REF20240501ABC123\",\n  \"transaction_ref_id\": \"TXN20240501XYZ789\"\n}"

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

{
  "status": "OK",
  "message": "Payment is still being processed",
  "data": {
    "status": "PROCESSING",
    "response": {
      "bill_payment_response": {
        "head": {
          "bill_fetch_ref_id": "REF20240501ABC123"
        },
        "reason": {
          "response_code": "PENDING",
          "response_reason": "Processing"
        },
        "txn": {
          "transaction_ref_id": "TXN20240501XYZ789"
        }
      }
    }
  }
}

Authorizations

x-client-id

string

header

required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret

string

header

required

Your unique client secret issued by Cashfree. Keep this confidential and never expose it in client-side code. You can find this in your Merchant Dashboard.

Body

application/json

Request parameters to poll a bill payment request.

bill_fetch_ref_id

string

required

The bill_fetch_ref_id received in the Bill Payment Request API response (data.bill_fetch_ref_id). Used to identify the original bill fetch.

Example:

"REF20240501ABC123"

transaction_ref_id

string

required

The transaction_ref_id received in the Bill Payment Request API response (data.transaction_ref_id). Used to identify this specific payment transaction.

Example:

"TXN20240501XYZ789"

Response

Success response for polling a bill payment request.

status

string

Always "OK" for all poll responses, regardless of the payment outcome.

Example:

"OK"

message

string

Human-readable description of the current payment state.

Example:

"Payment successful"

data

object

Response payload containing the payment status and full transaction details.

Show child attributes

Bill Payment Request Ticket Request

⌘I