curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/payout-links
{
"entity":"collection",
"count":2,
"items":[
{
"id":"poutlk_00000000000001",
"entity":"payout_link",
"contact_id":"cont_00000000000001",
"contact":{
"name":"Gaurav Kumar",
"email":"gaurav.kumar@example.com",
"contact":"912345678"
},
"fund_account_id":"fa_00000000000001",
"purpose":"refund",
"status":"processed",
"amount":1000,
"currency":"INR",
"description":"Payout link for Gaurav Kumar",
"attempt_count": 1,
"receipt":"Receipt No. 1",
"notes":{
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
},
"short_url":"https://rzp.io/i/3b1Tw6",
"send_sms": true,
"send_email": true,
"cancelled_at":null,
"created_at":1545383037,
"expire_by": 1545384058,
"expired_at": 1545384658
},
{
"id":"poutlk_00000000000002",
"entity":"payout_link",
"contact_id":"cont_00000000000001",
"contact":{
"name":"Gaurav Kumar",
"contact":"912345678",
"email":"gaurav.kumar@example.com"
},
"fund_account_id":null,
"purpose":"refund",
"status":"issued",
"amount":1000,
"currency":"INR",
"description":"Payout link for Gaurav Kumar",
"attempt_count": 0,
"receipt":"Receipt No. 2",
"notes":{
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
},
"short_url":"https://rzp.io/i/3b1Tw6",
"send_sms": true,
"send_email": true,
"cancelled_at":null,
"created_at":1545383037,
"expire_by": 1545384058,
"expired_at": 1545384658
}
]
}
Fetch All Payout Links
Fetch all the Payout Links using the API.
GET
/
v1
/
payout-links
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/payout-links
{
"entity":"collection",
"count":2,
"items":[
{
"id":"poutlk_00000000000001",
"entity":"payout_link",
"contact_id":"cont_00000000000001",
"contact":{
"name":"Gaurav Kumar",
"email":"gaurav.kumar@example.com",
"contact":"912345678"
},
"fund_account_id":"fa_00000000000001",
"purpose":"refund",
"status":"processed",
"amount":1000,
"currency":"INR",
"description":"Payout link for Gaurav Kumar",
"attempt_count": 1,
"receipt":"Receipt No. 1",
"notes":{
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
},
"short_url":"https://rzp.io/i/3b1Tw6",
"send_sms": true,
"send_email": true,
"cancelled_at":null,
"created_at":1545383037,
"expire_by": 1545384058,
"expired_at": 1545384658
},
{
"id":"poutlk_00000000000002",
"entity":"payout_link",
"contact_id":"cont_00000000000001",
"contact":{
"name":"Gaurav Kumar",
"contact":"912345678",
"email":"gaurav.kumar@example.com"
},
"fund_account_id":null,
"purpose":"refund",
"status":"issued",
"amount":1000,
"currency":"INR",
"description":"Payout link for Gaurav Kumar",
"attempt_count": 0,
"receipt":"Receipt No. 2",
"notes":{
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
},
"short_url":"https://rzp.io/i/3b1Tw6",
"send_sms": true,
"send_email": true,
"cancelled_at":null,
"created_at":1545383037,
"expire_by": 1545384058,
"expired_at": 1545384658
}
]
}
Available in🇮🇳 India🇲🇾 Malaysia🇺🇸 United States
Use this endpoint to retrieve all the Payout Links created.
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/payout-links
{
"entity":"collection",
"count":2,
"items":[
{
"id":"poutlk_00000000000001",
"entity":"payout_link",
"contact_id":"cont_00000000000001",
"contact":{
"name":"Gaurav Kumar",
"email":"gaurav.kumar@example.com",
"contact":"912345678"
},
"fund_account_id":"fa_00000000000001",
"purpose":"refund",
"status":"processed",
"amount":1000,
"currency":"INR",
"description":"Payout link for Gaurav Kumar",
"attempt_count": 1,
"receipt":"Receipt No. 1",
"notes":{
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
},
"short_url":"https://rzp.io/i/3b1Tw6",
"send_sms": true,
"send_email": true,
"cancelled_at":null,
"created_at":1545383037,
"expire_by": 1545384058,
"expired_at": 1545384658
},
{
"id":"poutlk_00000000000002",
"entity":"payout_link",
"contact_id":"cont_00000000000001",
"contact":{
"name":"Gaurav Kumar",
"contact":"912345678",
"email":"gaurav.kumar@example.com"
},
"fund_account_id":null,
"purpose":"refund",
"status":"issued",
"amount":1000,
"currency":"INR",
"description":"Payout link for Gaurav Kumar",
"attempt_count": 0,
"receipt":"Receipt No. 2",
"notes":{
"notes_key_1":"Tea, Earl Grey, Hot",
"notes_key_2":"Tea, Earl Grey… decaf."
},
"short_url":"https://rzp.io/i/3b1Tw6",
"send_sms": true,
"send_email": true,
"cancelled_at":null,
"created_at":1545383037,
"expire_by": 1545384058,
"expired_at": 1545384658
}
]
}
Query Parameters
Pass any of the following parameters as required to retrieve Payout Links as necessary.The number of Payout Links to be retrieved. The default value is 10. The maximum value is 100. This can be used for pagination in combination with
skip.The numbers of Payout Links to be skipped. The default value is 0. This can be used for pagination in combination with
count.The unique identifier of the contact to whom the Payout Link was sent to. For example,
cont_00000000000001.The unique identifier of the contact’s fund account to which the payout was made. For example,
fa_00000000000001.Response Parameters
The Payout Link status. Possible values:
pendingissuedprocessingprocessedcancelledrejected
Refer to the Payout Link Life Cycle section for more details.
The amount, in paise, transferred from the business account to the contact’s fund account.
The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.
The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.
A short link for the Payout Link that was created. This is the link that was shared with the contact.
The unique identifier of the contact to whom the Payout Link was sent. For example,
cont_00000000000001.Possible values:
true: SMS sent to the provided contact number.false: SMS could not be sent to the provided contact number. This could be because the contact number provided was wrong.
Possible values:
true: Email sent to the provided email address.false: Email could not be sent to the provided email address. This could be because the email address provided was wrong.
The unique identifier of the contact’s fund account to which the payout was made. For example,
Fund Account id is returned only when the Payout Link moves to the
fa_00000000000001. Fund Account id is returned only when the Payout Link moves to the
processing state after the contact provides their account details.The unique identifier for the payout made to the contact. For example,
This value is returned only when the Payout Link moves to the
pout_00000000000001. This value is returned only when the Payout Link moves to the
processed state after the contact receives the amount in their account.Timestamp, in Unix, if the Payout Link was cancelled by you. This value is returned only when the Payout Link moves to the
cancelled state.User-entered notes for internal reference. This is a key-value pair. For example,
"note_key": "Beam me up Scotty”.Timestamp, in Unix, when the Payout Link was to expire. This is set at the time of creation of the Payout Link and is set at least 15 minutes ahead of the current time.
This value is returned only if you have enabled the expiry feature for Payout Links. Know how to set expiry to Payout Links.
This value is returned only if you have enabled the expiry feature for Payout Links. Know how to set expiry to Payout Links.
Last modified on November 17, 2026
Was this page helpful?