Settlement APIs🔗
By default, the complete process takes a time of T+2 business days for domestic transactions and T+7 days for international transactions, T being the date of capture of payment.
This is called the settlement cycle. The settlement cycle is subject to bank approval and can vary based on your business vertical, risk factors and so on.
Postman Collection🔗
We have a Postman collection to make the integration quicker and easier. Click the Download Postman Collection button below to get started.
Instructions to use the Postman Collection
-
All Razorpay APIs are authorized using Basic Authorization.
- Add your API Keys to the API. Authorization → Type = Basic Auth → Username = <Your_Key_ID>; Password = <Your_Key_secret>.
-
Some APIs in the collection require data specific to your account such as
setl_id
(Settlement ID) as a path parameter.- For example, the Fetch Settlement by ID API requires you to add the
setl_id
as a path parameter. - Such parameters are enclosed in {} in the collection. For example, {setl_id}.
- The API throws an error if these values are incorrect or do not exist in your system.
- For example, the Fetch Settlement by ID API requires you to add the
Settlement Entity🔗
id
string
Unique identifier of the settlement transaction, for example,setl_7IZKKI4Pnt2kEe
entity
string
The name of the entity.amount
integer
The settlement amount in paise. For example, 50000 means ₹500. Settlements are always made in INR.status
string
The status of the settlement. Possible values are:created
processed
failed
fees
integer
This is the total fees charged to process all payments received from customers that are being 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 that are being settled to you in this settlement transaction.utr
string
Unique Transaction Reference number available across banks, which can be used to track a particular settlement in your bank account. For example,1597813219e1pq6w
.created_at
integer
Timestamp (in Unix format) when the settlement transaction was created.
Fetch 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 is 10. Maximum value is 100. This can be used for pagination, in combination withskip
.skip
optionalinteger
Number of settlement records to be skipped. Default value is 0. This can be used for pagination, in combination withcount
.
Fetch Settlement using ID🔗
Path Parameter
id
mandatorystring
Unique identifier of the settlement to be retrieved.
Settlement Recon🔗
The settlement recon API returns a list of all transactions such as payments, refunds, transfers and adjustment that have been settled to you for a particular day or month.
In the example request and response, we are fetching the settlement report for 11/09/2019
.
Query Parameters
year
mandatoryinteger
The year the settlement was received in theYYYY
format. For example,2020
.month
mandatoryinteger
The month the settlement was received in theMM
format. For example,09
.day
optionalinteger
The date on which the settlement was received in theDD
format. For example,03
.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
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
Timestamp (in Unix) at which the transaction was created. settled_at
-
integer
Timestamp (in Unix) when the transaction was settled. settlement_id
-
string
Unique identifier of the settlement transaction. description
-
string
Brief description about the transaction. For example,Invoice #inv_DEWHZlfIcdVIXL"
. notes
-
object
Notes for the transaction. For example.{\"comment\":\"Partial\"}
. payment_id
-
string
Unique identifier of the payment linked torefund
ortransfer
that has been settled. For example,pay_DEApNNTR6xmqJy
. It isnull
forpayments
. settlement_utr
-
string
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
The card issuer. 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
Unique identifier of any dispute that might have arisen for this transaction.