Mark Order For Settlement

Use this API to pass the CBRICS ID to Cashfree and mark an order for settlement.

POST /orders/settlements

Mark Order For Settlement

cURL

curl --request POST \
  --url https://sandbox.cashfree.com/pg/orders/settlements \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "order_id": "order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H",
  "meta_data": {
    "cbriks_id": "CBRIKS_004",
    "settlement_date": "2024-04-12"
  }
}
'

import requests

url = "https://sandbox.cashfree.com/pg/orders/settlements"

payload = {
    "order_id": "order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H",
    "meta_data": {
        "cbriks_id": "CBRIKS_004",
        "settlement_date": "2024-04-12"
    }
}
headers = {
    "x-api-version": "<x-api-version>",
    "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-api-version': '<x-api-version>',
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    order_id: 'order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H',
    meta_data: {cbriks_id: 'CBRIKS_004', settlement_date: '2024-04-12'}
  })
};

fetch('https://sandbox.cashfree.com/pg/orders/settlements', 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/orders/settlements",
  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([
    'order_id' => 'order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H',
    'meta_data' => [
        'cbriks_id' => 'CBRIKS_004',
        'settlement_date' => '2024-04-12'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-version: <x-api-version>",
    "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/pg/orders/settlements"

	payload := strings.NewReader("{\n  \"order_id\": \"order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H\",\n  \"meta_data\": {\n    \"cbriks_id\": \"CBRIKS_004\",\n    \"settlement_date\": \"2024-04-12\"\n  }\n}")

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

	req.Header.Add("x-api-version", "<x-api-version>")
	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/pg/orders/settlements")
  .header("x-api-version", "<x-api-version>")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order_id\": \"order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H\",\n  \"meta_data\": {\n    \"cbriks_id\": \"CBRIKS_004\",\n    \"settlement_date\": \"2024-04-12\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/pg/orders/settlements")

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

request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order_id\": \"order_2642712eXjxRSJ5RfEZqHBfWeTwT4rm7H\",\n  \"meta_data\": {\n    \"cbriks_id\": \"CBRIKS_004\",\n    \"settlement_date\": \"2024-04-12\"\n  }\n}"

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

202

Example

{}

This API supports only merchants linked with the National Stock Exchange (NSE) or Bombay Stock Exchange (BSE).

Authorizations

XClientID & XClientSecretXClientID & XPartnerAPIKeyXClientID & XClientSignatureHeaderXPartnerMerchantID & XPartnerAPIKey

x-client-id · string · header · required

Client app ID. You can find your app id in the Merchant Dashboard.

x-client-secret · string · header · required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-api-version · string · default: 2025-01-01 · required

API version to be used.

x-request-id · string

Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

x-idempotency-key · string<UUID>

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Body

application/json

Request parameters to pass the CBRICS ID to Cashfree and mark an order for settlement.

order_id · string · required

OrderId of the order.

meta_data · object · required

Show child attributes

Response

202

application/json

Success response for passing the CBRICS ID to Cashfree and mark an order for settlement.

The response is of type object.