Docs Logo

Payout Links

Create Payout Links Using Contact Details

Create Payout Links Using Contact ID

Fetch All Payout Links

Fetch a Payout Link with ID

Cancel a Payout Link

Docs Logo

API Test keys

Api

X

Payout Links

Create

Use Contact Details

API Test keys

Api

X

Payout Links

Create

Use Contact Details

Create Payout Links Using Contact Details

POST
/v1/payout-links

Click to copy

Use this endpoint to create a Payout Link using customer's contact details such as email id or mobile number. You can choose to send the Payout Link to either contact details. Know more about

Payout Links

.

Is this page helpful?

Curl

1
curl -u <YOUR_KEY>:<YOUR_SECRET> \
2
-X POST https://api.razorpay.com/v1/payout-links \
3
-H "Content-Type: application/json" \
4
-d '{
5
  "account_number": "7878780080857996",
6
  "contact": {
7
    "name": "Gaurav Kumar",
8
    "contact": "912345678",
9
    "email": "gaurav.kumar@example.com",
10
    "type": "customer"
11
  }, // Only applicable when you have the contact details of the recipient. 
12
  "amount": 1000,
13
  "currency": "INR",
14
  "purpose": "refund",
15
  "description": "Payout link for Gaurav Kumar",
16
  "receipt": "Receipt No. 1",
17
  "send_sms": true,
18
  "send_email": true,
19
  "notes": {
20
    "notes_key_1":"Tea, Earl Grey, Hot",
21
    "notes_key_2":"Tea, Earl Grey… decaf."
22
  },
23
  "expire_by": 1545384058 // This parameter can be used only if you have enabled the expiry feature for Payout Links.
24
}'

Success

1
{
2
  "id": "poutlk_00000000000001",
3
  "entity": "payout_link",
4
  "contact": {
5
    "name": "Gaurav Kumar",
6
    "email": "gaurav.kumar@example.com",
7
    "contact": "912345678"
8
  },
9
  
10
  "purpose": "refund",
11
  "status": "issued",
12
  "amount": 1000,
13
  "currency": "INR",
14
  "description": "Payout link for Gaurav Kumar",
15
  "short_url": "https://rzp.io/i/3b1Tw6",
16
  "created_at": 1545383037,
17
  "contact_id": "cont_00000000000001",
18
  "send_sms": true,
19
  "send_email": true,
20
  "fund_account_id": null,
21
  "cancelled_at": null,
22
  "attempt_count": 0,
23
  "receipt": "Receipt No. 1",
24
  "notes": {
25
    "notes_key_1":"Tea, Earl Grey, Hot",
26
    "notes_key_2":"Tea, Earl Grey… decaf."
27
  },
28
  "expire_by": 1545384058,
29
  "expired_at": 1545384658
30
}
Request Parameters
account_number

*

string

The account from which you want to make the payout.
Account details can be found on the

RazorpayX Dashboard

. For example, 7878780080316316.
  • Pass your customer identifier if you want money to be deducted from RazorpayX Lite.
  • Pass your current account number if you want money to be deducted from your current account.

Watch Out!

  • This is NOT your contact's bank account number. Log in to your
    RazorpayX Dashboard
    and go to My Account & Settings → Banking → Customer Identifier.
  • This value is different for Test Mode and Live Mode.

contact

*

object

Details of the contact to whom the Payout Link is to be sent. Do not pass the id parameter.

Show child parameters (4)

amount

*

integer

The amount, in paise, to be transferred from the business account to the contact's fund account. For example, pass 1000000 to transfer an amount of ₹10,000. 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

*

string

The currency in which the payout is being made. Here, it is INR.

purpose

*

string

The purpose of the payout that is being created via the Payout Link. For example, refund.

Classifications available by default:

  • refund
  • cashback
  • payout
  • salary
  • utility bill
  • vendor bill

Additional purposes for payouts can be created via the

Dashboard

and then used in the API. You cannot create new payout purposes via the API.

description

*

string

Add a description to communicate the context of the Payout Link to the recipient. For example, Cashback for Mr. Gaurav Kumar on the purchase on Earl Grey Tea.

receipt
string

A user-entered receipt number for the payout. For example, Receipt No. 1.

send_sms
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 via SMS.

send_email
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 via email.

notes
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”.

expire_by
integer

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 expiry feature for Payout Links. Know more about how to

set expiry

to Payout Links.

Response Parameters
id
string

The unique identifier of the Payout Link that is created. For example, poutlk_00000000000001.

entity
string

The entity being created. Here it will be payout_link.

contact
object

Details of the contact to whom the Payout Link is to be sent.

Show child parameters (4)

purpose
string

The purpose of the payout. For example, refund, cashback or payout.

status
string

The Payout Link status. Possible values:

amount
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
string

The currency in which the payout is being made. Here, it is INR.

description
string

A user-entered description for the Payout Link. For example, Payout link for Gaurav Kumar.

short_url
string

A short link for the Payout Link that was created. This is the link that is shared with the contact.

created_at
integer

Timestamp, in Unix, when the Payout Link was created.

contact_id
string

The unique identifier of the contact to whom the Payout Link has to be sent. For example, cont_00000000000001.

send_sms
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
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.

fund_account_id
string

The unique identifier of the contact's fund account to which the payout will be made. For example, fa_00000000000001.

Fund Account id is returned only when the Payout Link moves to the

processing state
.

payout_id
string

The unique identifier for the payout made to the contact. For example, pout_00000000000001.

This value is returned only when the Payout Link moves to the

processed state
.

cancelled_at
integer

Timestamp, in Unix, when the Payout Link was cancelled by you. This value is returned only when the Payout Link moves to the cancelled state.

attempt_count
integer

The number of attempts to complete the payout. For example, 0.

receipt
string

A user-entered receipt number for the payout. For example, Receipt No. 1.

notes
object

User-entered notes for internal reference. This is a key-value pair. For example, "note_key": "Beam me up Scotty”.

expire_by
integer

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.

expired_at
integer

Timestamp, in Unix, when the Payout Link expired. This is set at the time of creation of the Payout Link.

Create Payout Links Using Contact Details

POST
/v1/payout-links

Click to copy

Use this endpoint to create a Payout Link using customer's contact details such as email id or mobile number. You can choose to send the Payout Link to either contact details. Know more about

Payout Links

.

Is this page helpful?

Request Parameters
account_number

*

string

The account from which you want to make the payout.
Account details can be found on the

RazorpayX Dashboard

. For example, 7878780080316316.
  • Pass your customer identifier if you want money to be deducted from RazorpayX Lite.
  • Pass your current account number if you want money to be deducted from your current account.

Watch Out!

  • This is NOT your contact's bank account number. Log in to your
    RazorpayX Dashboard
    and go to My Account & Settings → Banking → Customer Identifier.
  • This value is different for Test Mode and Live Mode.

contact

*

object

Details of the contact to whom the Payout Link is to be sent. Do not pass the id parameter.

Show child parameters (4)

amount

*

integer

The amount, in paise, to be transferred from the business account to the contact's fund account. For example, pass 1000000 to transfer an amount of ₹10,000. 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

*

string

The currency in which the payout is being made. Here, it is INR.

purpose

*

string

The purpose of the payout that is being created via the Payout Link. For example, refund.

Classifications available by default:

  • refund
  • cashback
  • payout
  • salary
  • utility bill
  • vendor bill

Additional purposes for payouts can be created via the

Dashboard

and then used in the API. You cannot create new payout purposes via the API.

description

*

string

Add a description to communicate the context of the Payout Link to the recipient. For example, Cashback for Mr. Gaurav Kumar on the purchase on Earl Grey Tea.

receipt
string

A user-entered receipt number for the payout. For example, Receipt No. 1.

send_sms
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 via SMS.

send_email
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 via email.

notes
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”.

expire_by
integer

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 expiry feature for Payout Links. Know more about how to

set expiry

to Payout Links.

Response Parameters
id
string

The unique identifier of the Payout Link that is created. For example, poutlk_00000000000001.

entity
string

The entity being created. Here it will be payout_link.

contact
object

Details of the contact to whom the Payout Link is to be sent.

Show child parameters (4)

purpose
string

The purpose of the payout. For example, refund, cashback or payout.

status
string

The Payout Link status. Possible values:

amount
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
string

The currency in which the payout is being made. Here, it is INR.

description
string

A user-entered description for the Payout Link. For example, Payout link for Gaurav Kumar.

short_url
string

A short link for the Payout Link that was created. This is the link that is shared with the contact.

created_at
integer

Timestamp, in Unix, when the Payout Link was created.

contact_id
string

The unique identifier of the contact to whom the Payout Link has to be sent. For example, cont_00000000000001.

send_sms
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
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.

fund_account_id
string

The unique identifier of the contact's fund account to which the payout will be made. For example, fa_00000000000001.

Fund Account id is returned only when the Payout Link moves to the

processing state
.

payout_id
string

The unique identifier for the payout made to the contact. For example, pout_00000000000001.

This value is returned only when the Payout Link moves to the

processed state
.

cancelled_at
integer

Timestamp, in Unix, when the Payout Link was cancelled by you. This value is returned only when the Payout Link moves to the cancelled state.

attempt_count
integer

The number of attempts to complete the payout. For example, 0.

receipt
string

A user-entered receipt number for the payout. For example, Receipt No. 1.

notes
object

User-entered notes for internal reference. This is a key-value pair. For example, "note_key": "Beam me up Scotty”.

expire_by
integer

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.

expired_at
integer

Timestamp, in Unix, when the Payout Link expired. This is set at the time of creation of the Payout Link.

Curl

1
curl -u <YOUR_KEY>:<YOUR_SECRET> \
2
-X POST https://api.razorpay.com/v1/payout-links \
3
-H "Content-Type: application/json" \
4
-d '{
5
  "account_number": "7878780080857996",
6
  "contact": {
7
    "name": "Gaurav Kumar",
8
    "contact": "912345678",
9
    "email": "gaurav.kumar@example.com",
10
    "type": "customer"
11
  }, // Only applicable when you have the contact details of the recipient. 
12
  "amount": 1000,
13
  "currency": "INR",
14
  "purpose": "refund",
15
  "description": "Payout link for Gaurav Kumar",
16
  "receipt": "Receipt No. 1",
17
  "send_sms": true,
18
  "send_email": true,
19
  "notes": {
20
    "notes_key_1":"Tea, Earl Grey, Hot",
21
    "notes_key_2":"Tea, Earl Grey… decaf."
22
  },
23
  "expire_by": 1545384058 // This parameter can be used only if you have enabled the expiry feature for Payout Links.
24
}'

Success

1
{
2
  "id": "poutlk_00000000000001",
3
  "entity": "payout_link",
4
  "contact": {
5
    "name": "Gaurav Kumar",
6
    "email": "gaurav.kumar@example.com",
7
    "contact": "912345678"
8
  },
9
  
10
  "purpose": "refund",
11
  "status": "issued",
12
  "amount": 1000,
13
  "currency": "INR",
14
  "description": "Payout link for Gaurav Kumar",
15
  "short_url": "https://rzp.io/i/3b1Tw6",
16
  "created_at": 1545383037,
17
  "contact_id": "cont_00000000000001",
18
  "send_sms": true,
19
  "send_email": true,
20
  "fund_account_id": null,
21
  "cancelled_at": null,
22
  "attempt_count": 0,
23
  "receipt": "Receipt No. 1",
24
  "notes": {
25
    "notes_key_1":"Tea, Earl Grey, Hot",
26
    "notes_key_2":"Tea, Earl Grey… decaf."
27
  },
28
  "expire_by": 1545384058,
29
  "expired_at": 1545384658
30
}