Postman Collection#
We have a Postman collection to make the integration quicker and easier. Refer to the Postman Collection section for more details.
Not available in test mode:
Currently, the Payout Link APIs are not available in test mode.
Payout Links enable you to make payouts to those contacts whose fund accounts details are not readily available with you. You can use these links to collect the customer's fund account details and then process refunds, reimbursement and cashbacks to them without additional follow up.
Watch the below video to learn how to create Payouts using our APIs.
We have a Postman collection to make the integration quicker and easier. Refer to the Postman Collection section for more details.
Use the below endpoint to create a payout link.
account_number
mandatoryData type string
. The account from which you want to make the payout.
Account details can be found on the RazorpayX Dashboard. For example, 7878780080316316
.
contact
Details of the contact to whom the payout link is to be sent.
id
mandatory if no other parameter in the array is usedstring
.cont_00000000000001
.name
mandatory if id is not usedstring
.id
parameter.Gaurav Kumar
.contact
either contact or email mandatory if id is not usedstring
.id
parameter.9123456789
.email
either contact or email mandatory if id is not usedstring
.id
parameter.gaurav.kumar@example.com
.type
optionalstring
.id
parameter.employee
.vendor
customer
employee
self
amount
mandatoryData type integer
. The amount, in paise, to be transferred from the business account to the contact's fund account. For example, if you want to transfer ₹10000, pass 1000000
against this parameter. The minimum value that can be passed is 100
.
The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.
currency
mandatoryData type string
. The currency in which the payout is being made. Here, it is INR
.
purpose
mandatoryData type string
. The purpose of the payout that is being created. For example, refund
.
Classifications available by default:
refund
cashback
payout
salary
utility bill
vendor bill
description
optionalData type string
. A user-entered description for the payout link. For example, Payout link for Gaurav Kumar
.
receipt
optionalData type string
. A user-entered receipt number for the payout. For example, Receipt No. 1
.
send_sms
Data type boolean
. Possible values:
true
- Razorpay sends the payout link to the provided contact number via SMS.false
(default) - You send the payout link to the contact.send_email
Data type boolean
. Possible values:
true
- Razorpay sends the payout link to the provided email address via email.false
(default) - You send the payout link to the contact.notes
optionalData type object
. User-entered notes for internal reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Beam me up Scotty”
.
id
Data type string
. The unique identifier of the payout link that is created. For example, poutlk_00000000000001
.
entity
Data type string
. The entity being created. Here it will be payout_link
.
contact_id
Data type string
. The unique identifier of the contact to whom the payout link is to be sent. For example, cont_00000000000001
.
contact
Details of the contact to whom the payout link is to be sent.
Use this only if you are not using the contact_id
parameter.
name
string
. The contact's name. For example, Gaurav Kumar
.type
string
. Classification for the contact being created. For example, employee
.contact
string
. The contact's phone number. For example, 9123456789
.email
string
. The contact's email address. For example, gaurav.kumar@example.com
.fund_account_id
Data type string
. The unique identifier of the contact's fund account to which the payout will be made. This field is populated only when the payout link moves to the processing
state. For example, fa_00000000000001
.
payout_id
Data type string
. The unique identifier for the payout made to the contact. This field is populated only when the payout link moves to the processed
state. For example, pout_00000000000001
.
purpose
Data type string
. The purpose of the payout. For example, refund
.
status
Data type string
. The payout link status. Possible values:
issued
processing
processed
cancelled
amount
Data type integer
. The amount, in paise, to be 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.
currency
Data type string
. The currency in which the payout is being made. Here, it is INR
.
description
Data type string
. A user-entered description for the payout link. For example, Payout link for Gaurav Kumar
.
attempt_count
Data type integer
. The number of attempts to complete the payout.
receipt
Data type string
. A user-entered receipt number for the payout. For example, Receipt No. 1
.
notes
Data type object
. User-entered notes for internal reference. This is a key-value pair. You can enter a maximum of 15 key-value pairs. For example, "note_key": "Beam me up Scotty”
.
short_url
Data type string
. A short link for the payout link that was created. This is the link that is shared with the contact.
send_sms
Data type boolean
. 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.send_email
Data type boolean
. 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.created_at
Data type integer
. Timestamp, in Unix, when the payout link was created.
cancelled_at
Data type integer
. Timestamp, in Unix, when the payout link was cancelled by you. This field is populated only when the payout link moves to the cancelled
state.
Use the below endpoint to fetch all payout links.
from
integer
. Timestamp, in Unix, from when payout links are to be fetched.to
integer
. Timestamp, in Unix, till when payout links are to be fetched.count
integer
. The number of payout links to be fetched. The default value is 10. The maximum value is 100. This can be used for pagination, in combination with skip
.skip
integer
. The numbers of payout links to be skipped. The default value is 0. This can be used for pagination, in combination with count
.id
string
. The unique identifier for the payout link. For example, poutlk_00000000000001
.contact_id
string
. The unique identifier of the contact to whom the payout link is to be sent. For example, cont_00000000000001
.contact_phone_number
string
. The contact's phone number. For example, 9123456789
.contact_email
string
. The contact's email address. For example, gaurav.kumar@example.com
.fund_account_id
string
. The unique identifier of the contact's fund account to which the payout was made. For example, fa_00000000000001
.purpose
string
. The purpose of the payout that is being created. For example, refund
.status
string
. The payout link status. Possible values:
issued
processing
processed
cancelled
receipt
string
. A user-entered receipt number for the payout. For example, Receipt No. 1
.short_url
string
. A short link for the payout link that was created. This is the link that is shared with the contact.Use the below endpoint to fetch details of a payout link.
id
mandatorystring
. The unique identifier for the payout link. For example, poutlk_00000000000001
.You can only cancel payout links in the issued
state.
Use the below endpoint to cancel a payout link.
id
mandatorystring
. The unique identifier for the payout link. For example, poutlk_00000000000003
.payout_link.issued
issued
state. This indicates that the payout link has been created.payout_link.processing
processing
state. This indicates that your contact has entered their fund account details and the payout is being processed.payout_link.processed
processed
state. This indicates that the payout has been successfully made.payout_link.attempted
payout_link.cancelled
cancelled
state. This indicates that you have cancelled the payout link.Triggered whenever a payout link moves to the issued
state. This indicates that the payout link has been created.
Triggered whenever a payout link moves to the processing
state. This indicates that your contact has entered their fund account details and the payout is being processed.
The fund_account_id
is populated at this stage.
Triggered whenever a payout link moves to the processed
state. This indicates that the payout has been successfully made.
Triggered whenever the underlying payout has reversed and another attempt is required on the payout link.
Triggered whenever a payout link moves to the cancelled
state. This indicates that you have cancelled the payout link.