Payout Links Entity

The Payout Links Entity has the following parameters:

Response

Entity

{
  "id": "poutlk_00000000000001",
  "entity": "payout_link",
  "contact": {
    "name": "Gaurav Kumar",
    "email": "[e-mail]",
    "contact": "912345678"
  },
  "purpose": "refund",
  "status": "issued",
  "amount": 1000,
  "currency": "INR",
  "description": "Payout link for Gaurav Kumar",
  "short_url": "https://rzp.io/i/3x1Tw6",
  "created_at": 1545383037,
  "contact_id": "cont_00000000000001",
  "send_sms": true,
  "send_email": true,
  "fund_account_id": null,
  "cancelled_at": null,
  "attempt_count": 0,
  "receipt": "Receipt No. 1",
  "notes": {
    "notes_key_1":"Tea, Earl Grey, Hot",
    "notes_key_2":"Tea, Earl Grey… decaf."
  },
  "expire_by": 1545384058,
  "expired_at": 1545384658
}

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.

name : string The contact’s name. For example, Gaurav Kumar.

type : string Classification of the contact being created. For example, employee.

contact : string The contact’s phone number. For example, 9000090000.

email : string The contact’s email address. For example, [e-mail].

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

fund_account_id only if contact provides their account details : 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 only if the contact receives the amount in their account : 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.

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

status : string The Payout Link status. Possible values:

• pending
• issued
• processing
• processed
• cancelled
• rejected

Refer to the Payout Link Life Cycle section for more details.

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.

attempt_count : integer The number of attempts to complete the payout.

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

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

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.

created_at : integer Timestamp, in Unix, when the Payout Link was created.

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.

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 more about 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.