Skip to main content
PUT
/
import
/
settlements
/
emulate
Mark Sandbox Settlement processed
curl --request PUT \
  --url https://sandbox.cashfree.com/import/settlements/emulate \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '{
  "cf_ica_settlement_id": "10050",
  "status": "PROCESSED"
}'
{
  "cf_ica_settlement_id": 10050,
  "status": "SETTLED",
  "collection_amount_inr": 1000,
  "service_charge_inr": 19,
  "service_tax_inr": 3.42,
  "adjustment_amount_inr": 0,
  "settlement_charges_inr": 105.38,
  "settlement_tax_inr": 18.97,
  "settlement_amount_inr": 853.23,
  "settlement_foreign_currency_details": {
    "settlement_currency": "AED",
    "settlement_forex_rate": 23.4066,
    "settlement_amount": 36.4527
  },
  "payment_from": "2025-04-14T13:54:37+05:30",
  "payment_till": "2025-04-14T13:54:37+05:30",
  "settlement_utr": "60f05f9b-4d83-43cd-80e6-9deaf619de7f",
  "initiated_on": "2025-04-14T13:56:24+05:30",
  "settled_on": "2025-04-14T13:56:24+05:30"
}

Headers

ā€‹
x-client-id
string
required

Client ID generated from the merchant dashboard.

ā€‹
x-client-secret
string
required

Client secret generated from the merchant dashboard.

ā€‹
x-api-version
string
default:2025-01-01
required

API version to be used. Format is in YYYY-MM-DD.

Body

application/json
ā€‹
cf_ica_settlement_id
string
required

Unique Identifier of the settlement

Example:

"10050"

ā€‹
status
enum<string>
required
Available options:
PROCESSED
Example:

"PROCESSED"

Response

200

ā€‹
cf_ica_settlement_id
number

Unique ID of the settlement

Example:

10050

ā€‹
status
string

Current status of the settlement

Example:

"SETTLED"

ā€‹
collection_amount_inr
number

Total collected amount in INR

Example:

1000

ā€‹
service_charge_inr
number

Service charge in INR, if applicable

Example:

19

ā€‹
service_tax_inr
number

Service tax in INR

Example:

294.73

ā€‹
adjustment_amount_inr
number

Adjustment amount in INR

Example:

-18743.89

ā€‹
settlement_charges_inr
number

Charges related to the settlement in INR

Example:

0

ā€‹
settlement_tax_inr
number

Tax on settlement in INR

Example:

0

ā€‹
settlement_amount_inr
number

Total settlement amount in INR

Example:

65500.04

ā€‹
settlement_foreign_currency_details
object
ā€‹
payment_from
string

Start time of the payment period

Example:

"2024-08-28T15:36:33"

ā€‹
payment_till
string

End time of the payment period

Example:

"2024-08-28T15:37:49"

ā€‹
settlement_utr
string

Unique transaction reference (UTR) for the settlement

Example:

"123412"

ā€‹
initiated_on
string

Date and time when the settlement was initiated

Example:

"2024-08-28T17:24:55"

ā€‹
settled_on
string

Date and time when the settlement was completed

Example:

"2024-08-29T16:30:46"