Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 1.67 KB

Settlements.md

File metadata and controls

56 lines (42 loc) · 1.67 KB
Raw

Settlements

Method HTTP request Description
PGOrderFetchSettlement Get /orders/{order_id}/settlements Get Settlements by Order ID

PGOrderFetchSettlement

PGOrderFetchSettlement($x_api_version, $order_id, $x_request_id = null, $x_idempotency_key = null, GuzzleHttp\Client $http_client = null)

Get Settlements by Order ID (Docs)

Example

$x_api_version = "2022-09-01";
$order_id = "order_id";
try {
  $result = $cashfree->PGOrderFetchSettlement($x_api_version, $order_id, null, null, null);
} catch (Exception $e) {
  echo 'Exception when calling PGOrderFetchSettlement: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
orderId string The id which uniquely identifies your order
xApiVersion string API version to be used. Format is in YYYY-MM-DD [default to "2022-09-01"]
xRequestId string Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

Response

{
  "cf_payment_id": 553338,
  "order_id": "order-12-127",
  "entity": "settlement",
  "order_amount": 100,
  "payment_time": "2021-07-13T13:13:59+05:30",
  "service_charge": 10,
  "service_tax": 1.8,
  "settlement_amount": 88.2,
  "cf_settlement_id": 6121238,
  "transfer_id": 238,
  "transfer_time": "2021-07-25T12:57:52+05:30",
  "transfer_utr": "N87912312",
  "order_currency": "INR",
  "settlement_currency": "INR"
}