---
title: "Cancel a payout link"
method: POST
path: "/payout-links/{payout_link_id}/cancel"
tags: ["X Payout Links"]
---

# Cancel a payout link

`POST /payout-links/{payout_link_id}/cancel`

## Request

- Base URL: `https://api.razorpay.com/v1`
- URL: `https://api.razorpay.com/v1/payout-links/{payout_link_id}/cancel`
- Auth: one of:
  - HTTP basic
  - OAuth 2
    - Authorization code: `https://mcp.razorpay.com/authorize`
    - Client credentials
    - Token URL: `https://mcp.razorpay.com/token` scopes: `read_only`
- TypeScript: <https://skmtc.dev/curlec/apis/razorpay-api/docs/payout-links/:payout_link_id/cancel/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Response `200`

Payout link cancelled

- PayoutLink: Payout link sent to a contact when fund account details are unavailable.
  - `id` string: Payout link ID (poutlk_*)
  - `entity` 'payout_link'
  - `contact_id` string
  - `contact` object
    - `name` string
    - `email` string
    - `contact` string
    - `type` string
  - `amount` integer: Amount in paise
  - `currency` string
  - `purpose` string
  - `status` 'pending' | 'issued' | 'processing' | 'processed' | 'cancelled' | 'rejected'
  - `fund_account_id` string
  - `payout_id` string
  - `description` string
  - `receipt` string
  - `notes` object
  - `send_sms` boolean
  - `send_email` boolean
  - `short_url` string
  - `attempt_count` integer
  - `created_at` integer
  - `cancelled_at` integer
  - `expire_by` integer: Must be at least 15 minutes in the future
  - `expired_at` integer

## Other responses

- `400`: Bad request. Invalid parameters or missing required fields.
- `401`: Authentication failed. Invalid or missing API key credentials.
- `429`: Rate limit exceeded. Implement exponential backoff with jitter before retrying.
- `500`: Internal server error.

---

[API](https://skmtc.dev/curlec/apis/razorpay-api.md) - [All operations](https://skmtc.dev/curlec/apis/razorpay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/curlec/apis/razorpay-api/revisions/824ca9e6faef?raw)