Razorpay Settlements is the process in which the money received from your customers is settled to your bank account.

Captured payments are automatically settled to the bank account submitted to us as part of your KYC verification as per your settlement cycle.

Use Cases🔗

Retrieve details for a specific settlement using the unique identifier linked to the settlement.
Retrieve information about all settlements.
Retrieve a list of all transactions settled to your account for a particular day or month.

Settlement Entity🔗

The Settlement entity has the following fields:

id

string The unique identifier of the settlement transaction. For example, setl_7IZKKI4Pnt2kEe

entity

string Indicates the type of entity. Here, it is settlement.

amount

integer The amount to be settled (in the smallest unit of currency). For example, settlement in INR, a value of 500 means 50000 paise (equivalent to ₹500).

status

string Indicates the state of the settlement. Possible values:

created
processed
failed

fees

integer This is the total fee charged for processing all payments received from customers settled to you in this settlement transaction.

tax

integer The total tax, in paise, charged on the fees collected to process all payments received from customers settled to you in this settlement transaction.

utr

string The Unique Transaction Reference (UTR) number available across banks, which can be used to track a particular settlement in your bank account. For example, 1597813219e1pq6w.

created_at

integer UNIX timestamp at which the settlement transaction was created.

You can manage settlements using APIs or from the Razorpay Dashboard.

 Example Entity
Copy  {
    "id": "setl_7IZKKI4Pnt2kEe",
    "entity": "settlement",
    "amount": 50000,
    "status" : "processed",
    "fees": 123,
    "tax": 12,
    "utr": "1597813219e1pq6w",
    "created_at": 1509622307
  }

Fetch All Settlements🔗

The following endpoint retrieves details of all settlements.

/settlements/

 Curl Java Python PHP  Node.JS Ruby Go Response
Copycurl -u <YOUR_KEY>:<YOUR_SECRET>\
- X GET \
https://api.razorpay.com/v1/settlements/

CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

List<Settlement> settlements = razorpay.settlement.fetchAll();

Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.settlement.all(options)

Copy$api = new Api($key_id, $secret);

$api->settlement->all($options);

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.settlements.all(options)

Copyrequire "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {"count": 2}

Razorpay::Settlement.all(para_attr)

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

options:= map[string]interface{}{
  "count": 2,
  "skip": 1,
}
body, err := client.Settlement.All(options, nil)

Copy{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "setl_DGlQ1Rj8os78Ec",
      "entity": "settlement",
      "amount": 9973635,
      "status": "processed",
      "fees": 471699,
      "tax": 42070,
      "utr": "1568176960vxp0rj",
      "created_at": 1568176960
    },
    {
      "id": "setl_4xbSwsPABDJ8oK",
      "entity": "settlement",
      "amount": 50000,
      "status": "processed",
      "fees": 123,
      "tax": 12,
      "utr": "RZRP173069230702",
      "created_at": 1509622306
    }
  ]
}

Query Parameters🔗

from optional

integer UNIX timestamp (in seconds) from when settlements are to be fetched.

to optional

integer UNIX timestamp (in seconds) till when settlements are to be fetched.

count optional

integer Number of settlement records to be fetched.

Default value: 10
Maximum value: 100
This can be used for pagination, in combination with skip.

skip optional

integer Number of settlement records to be skipped.

Default value:0.
This can be used for pagination, in combination with count.

Response Parameters🔗

Descriptions for the response parameters are present in the Settlements Entity parameters table.

Fetch Settlement Using ID🔗

The following endpoint retrieves the settlement using the ID.

/settlements/:id

 Curl Java Python PHP Node.JS Ruby Go Response
Copycurl -u <YOUR_KEY>:<YOUR_SECRET>\
- X GET \
https://api.razorpay.com/v1/settlements/setl_DGlQ1Rj8os78Ec

CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String settlementId = "setl_DGlQ1Rj8os78Ec";

Settlement settlement = razorpay.settlement.fetch(settlementId);

Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))
The following endpoint retrieves the
client.settlement.fetch(settlementId)

Copy$api = new Api($key_id, $secret);

$api->settlement->fetch($settlementId);

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.settlements.fetch(settlementId)

Copyrequire "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

settlementId = "setl_DGlQ1Rj8os78Ec"

Razorpay::Settlement.fetch(settlementId)

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.Settlement.Fetch("<settlementId>", nil, nil)

Copy{
    "id": "setl_DGlQ1Rj8os78Ec",
    "entity": "settlement",
    "amount": 9973635,
    "status": "processed",
    "fees": 471699,
    "tax": 42070,
    "utr": "1568176960vxp0rj",
    "created_at": 1568176960
}

Path Parameter🔗

id mandatory: string The unique identifier of the settlement to be retrieved.

Response Parameters🔗

Descriptions for the response parameters are present in the Settlements Entity parameters table.

Settlement Recon🔗

The settlement recon API returns a list of all transactions such as payments, refunds, transfers and adjustments that have been settled to your account for a particular day or month.

/settlements/recon/combined?year=yyyy&month=mm

In the example request and response, we are fetching the settlement report for a particular day, that is 11/06/2022.

 Curl Java Python PHP Node.JS Ruby Go Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET \
https://api.razorpay.com/v1/settlements/recon/combined?year=2022&month=06&day=11 \

CopyRazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject params = new JSONObject();
params.put("year", 2022);
params.put("month", 6);
params.put("day",11);
            
List<Settlement> settlements = razorpay.settlement.reports(params);

Copyimport razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.settlement.report({
  "year": 2022,
  "month": 06,
  "day": 11
})

Copy$api = new Api($key_id, $secret);

$api->settlement->settlementRecon(array('year' => 2022, 'month' => 06, 'day'=>11));

Copyvar instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.settlements.settlementRecon({
  "year": 2022,
  "month": 06,
  "day": 11
})

Copyrequire "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

para_attr = {
  "year": 2022,
  "month": 6,
  "day":11
}
Razorpay::Settlement.reports(para_attr)

Copyimport ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

data:= map[string]interface{}{
    "year": 2022,
    "month": 6,
}
body, err := client.Settlement.Reports(data, nil)

Copy{
  "entity": "collection",
  "count": 4,
  "items": [
    {
      "entity_id": "pay_DEXrnipqTmWVGE",
      "type": "payment",
      "debit": 0,
      "credit": 97100,
      "amount": 100000,
      "currency": "INR",
      "fee": 2900,
      "tax": 0,
      "on_hold": false,
      "settled": true,
      "created_at": 1567692556,
      "settled_at": 1568176960,
      "settlement_id": "setl_DGlQ1Rj8os78Ec",
      "posted_at": null,
      "credit_type": "default",
      "description": "Recurring Payment via Subscription",
      "notes": "Beam me up Scotty.",
      "payment_id": null,
      "settlement_utr": "1568176960vxp0rj",
      "order_id": "order_DEXrnRiR3SNDHA",
      "order_receipt": null,
      "method": "card",
      "card_network": "MasterCard",
      "card_issuer": "KARB",
      "card_type": "credit",
      "dispute_id": null
    },
    {
      "entity_id": "rfnd_DGRcGzZSLyEdg1",
      "type": "refund",
      "debit": 242500,
      "credit": 0,
      "amount": 242500,
      "currency": "INR",
      "fee": 0,
      "tax": 0,
      "on_hold": false,
      "settled": true,
      "created_at": 1568107224,
      "settled_at": 1568176960,
      "settlement_id": "setl_DGlQ1Rj8os78Ec",
      "posted_at": null,
      "credit_type": "default",
      "description": null,
      "notes": "Beam me up Scotty.",
      "payment_id": "pay_DEXq1pACSqFxtS",
      "settlement_utr": "1568176960vxp0rj",
      "order_id": "order_DEXpmZgffXNvuI",
      "order_receipt": null,
      "method": "card",
      "card_network": "MasterCard",
      "card_issuer": "KARB",
      "card_type": "credit",
      "dispute_id": null
    },
    {
      "entity_id": "trf_DEUoCEtdsJgvl7",
      "type": "transfer",
      "debit": 100296,
      "credit": 0,
      "amount": 100000,
      "currency": "INR",
      "fee": 296,
      "tax": 46,
      "on_hold": false,
      "settled": true,
      "created_at": 1567681786,
      "settled_at": 1568176960,
      "settlement_id": "setl_DGlQ1Rj8os78Ec",
      "posted_at": null,
      "credit_type": "default",
      "description": null,
      "notes": null,
      "payment_id": "pay_DEApNNTR6xmqJy",
      "settlement_utr": "1568176960vxp0rj",
      "order_id": null,
      "order_receipt": null,
      "method": null,
      "card_network": null,
      "card_issuer": null,
      "card_type": null,
      "dispute_id": null
    },
    {
      "entity_id": "adj_EhcHONhX4ChgNC",
      "type": "adjustment",
      "debit": 0,
      "credit": 1012,
      "amount": 1012,
      "currency": "INR",
      "fee": 0,
      "tax": 0,
      "on_hold": false,
      "settled": true,
      "created_at": 1567681786,
      "settled_at": 1568176960,
      "settlement_id": "setl_DGlQ1Rj8os78Ec",
      "posted_at": null,
      "description": "test reason",
      "notes": null,
      "payment_id": null,
      "settlement_utr": null,
      "order_id": null,
      "order_receipt": null,
      "method": null,
      "card_network": null,
      "card_issuer": null,
      "card_type": null,
      "dispute_id": null
    }
  ]
}

Query Parameters🔗

year mandatory: integer The year the settlement was received in the YYYY format. For example, 2022.
month mandatory: integer The month the settlement was received in the MM format. For example, 06.
day optional: integer The date on which the settlement was received in the DD format. For example, 11.
count optional: integer Specifies the number of available settlements to be fetched. Maximum count can be 1000.
skip optional: integer Specifies the number of available settlements to be skipped when fetching a count.

Response Parameters🔗

entity_id

string The unique identifier of the transaction that has been settled.

type

string Indicates the type of transaction. Possible values:

payment
refund
transfer
adjustment

debit

integer The amount, in paise, that has been debited from your account.

credit

integer The amount, in paise, that has been credited to your account.

amount

integer The total amount, in paise, debited or credited from your account.

currency

string The 3-letter ISO currency code for the transaction.

fee

integer The fees, in paise, charged to processing the transaction.

tax

integer The tax on the fee, in paise, charged to processing the transaction.

on_hold

boolean Indicates whether the account settlement for transfer is on hold. Possible values:

true
false

settled

boolean Indicates whether the transaction has been settled or not. Possible values:

true
false

created_at

integer UNIX timestamp at which the transaction was created.

settled_at

integer UNIX timestamp when the transaction was settled.

settlement_id

string The unique identifier of the settlement transaction.

description

string Brief description about the transaction. For example, Recurring Payment via Subscription.

notes

object Notes for the transaction. For example, Beam me up Scotty.

payment_id

string The unique identifier of the payment linked to refund or transfer that has been settled. For example, pay_DEApNNTR6xmqJy. It is null for payments.

settlement_utr

string The unique reference number linked to the settlement. For example, KKBKH14156891582.

order_id

string Order ID linked to the payment made by the customer that has been settled. For example, order_DEXrnRiR3SNDHA.

order_receipt

string Receipt number entered while creating the Order.

method

string The payment method used to complete the payment. Possible values:

card
netbanking
wallet
emi
upi

card_network

string The card network used to process the payment. Possible values are:

American Express
Diners Club
Maestro
MasterCard
RuPay
Visa
unknown

card_issuer

string This is a 4-character code denoting the issuing bank. For example, KARB.

This attribute will not be set for international cards, that is, for cards issued by foreign banks.

card_type

string The card type used to process the payment. Possible values:

credit
debit

dispute_id

string The unique identifier of any dispute, if any, for this transaction.