Sign in
X Payout Links

Create a payout link

Send a payout link to a contact when fund account details are unavailable. expire_by must be at least 15 minutes in the future.

post/payout-links

Request body

contact_idstring required
amountinteger required

Amount in paise

currency'INR' required
purposestring required
descriptionstring
receiptstring
send_smsboolean
send_emailboolean
notesobject
expire_byinteger

Unix timestamp; must be ≥15 minutes from now

Response

Payout link created

idstring

Payout link ID (poutlk_*)

entity'payout_link'
contact_idstring
amountinteger

Amount in paise

currencystring
purposestring
status'pending' | 'issued' | 'processing' | 'processed' | 'cancelled' | 'rejected'
fund_account_idstring
payout_idstring
descriptionstring
receiptstring
notesobject
send_smsboolean
send_emailboolean
short_urlstring
attempt_countinteger
created_atinteger
cancelled_atinteger
expire_byinteger

Must be at least 15 minutes in the future

expired_atinteger

Changes

No recorded changes to this endpoint across all 1 revision of this API.