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 issettlement
.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.
Fetch All Settlements🔗
The following endpoint retrieves details of all settlements.
Query Parameters🔗
from
optionalinteger
UNIX timestamp (in seconds) from when settlements are to be fetched.to
optionalinteger
UNIX timestamp (in seconds) till when settlements are to be fetched.count
optionalinteger
Number of settlement records to be fetched.- Default value: 10
- Maximum value: 100
- This can be used for pagination, in combination with
skip
.
skip
optionalinteger
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.
Path Parameter🔗
id
mandatorystring
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.
In the example request and response, we are fetching the settlement report for a particular day, that is 11/06/2022
.
Query Parameters🔗
year
mandatoryinteger
The year the settlement was received in theYYYY
format. For example,2022
.month
mandatoryinteger
The month the settlement was received in theMM
format. For example,06
.day
optionalinteger
The date on which the settlement was received in theDD
format. For example,11
.count
optionalinteger
Specifies the number of available settlements to be fetched. Maximumcount
can be 1000.skip
optionalinteger
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 torefund
ortransfer
that has been settled. For example,pay_DEApNNTR6xmqJy
. It isnull
forpayments
. 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.