Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB
X Payout Links

Cancel a payout link

Cancel a payout link that is in issued or pending state.

post/payout-links/{payout_link_id}/cancel

Response

Payout link cancelled

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