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

Cancel

API Test keys

Api

X

Payout Links

Cancel

Cancel a Payout Link

POST
/v1/payout-links/:id/cancel

Click to copy

Use this endpoint to cancel a Payout Link. You can only cancel Payout Links in the issued state. Know more about the

Payout Link Life Cycle section

.

Is this page helpful?

Curl

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
    -X POST https://api.razorpay.com/v1/payout-links/poutlk_00000000000003/cancel

Success

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

*

string

The unique identifier for the Payout Link you want to cancel. For example, poutlk_00000000000003.

Response Parameters
id
string

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

entity
string

The entity created. Here it will be payout_link.

contact
object

Details of the contact to whom the Payout Link was 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, that was 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 was to be 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 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 was 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
after the contact provides their account details.

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
after the contact would receive the amount in their account.

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.

Cancel a Payout Link

POST
/v1/payout-links/:id/cancel

Click to copy

Use this endpoint to cancel a Payout Link. You can only cancel Payout Links in the issued state. Know more about the

Payout Link Life Cycle section

.

Is this page helpful?

Path Parameters
id

*

string

The unique identifier for the Payout Link you want to cancel. For example, poutlk_00000000000003.

Response Parameters
id
string

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

entity
string

The entity created. Here it will be payout_link.

contact
object

Details of the contact to whom the Payout Link was 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, that was 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 was to be 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 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 was 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
after the contact provides their account details.

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
after the contact would receive the amount in their account.

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_ID]:[YOUR_KEY_SECRET] \
2
    -X POST https://api.razorpay.com/v1/payout-links/poutlk_00000000000003/cancel

Success

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