CCancel a Scheduled Payout

PUT/payouts/v3/payments/banks/{paymentReferenceId}/cancel

Cancels a scheduled payout. Only payouts with status SCHEDULED can be cancelled. Once cancelled, the payout cannot be reinstated.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Path Parameters

Field	Details
`paymentReferenceId` `string`required	Unique identifier of the payment in Pine Labs database. Constraints Minimum length: 1 characterMaximum length: 50 characters

Header Parameters

Field	Details
`Request-Timestamp` `string`date-time	ISO 8601 UTC timestamp of the request. Used for idempotency and audit.
`Request-ID` `string`	Use a global unique identifier [GUID] for the request. Constraints Minimum length: 1 characterMaximum length: 50 characters

Response

Field	Details
`clientReferenceId` `string`	Unique identifier to track the payout.
`requestReferenceId` `string`	Unique identifier of the request in Pine Labs database.
`paymentReferenceId` `string`	Unique identifier of the payment in Pine Labs database.
`payeeName` `string`	Name of the beneficiary.
`accountNumber` `string`	Beneficiary's bank account number (may be masked).
`branchCode` `string`	IFSC code of the beneficiary's bank.
`vpa` `string`	VPA handle of the beneficiary (for UPI payouts).
`email` `string`email	Email address of the beneficiary.
`phone` `string`	Mobile number of the beneficiary.
`amount` `object`2 nested fields	Payout monetary amount with currency. For payout creation, minimum ₹1 (100 paisa), maximum ₹10 lakh (100000000 paisa).
`value` `integer`required	Amount in the smallest currency unit (paisa for INR). Minimum ₹1 (100), maximum ₹10 lakh (100000000). Constraints Minimum value: 100Maximum value: 100000000
`currency` `string`required	Three-letter ISO 4217 currency code. Constraints Default value: INR
`mode` `string`	Payment mode used for the payout. Allowed values: `UPIIMPSNEFTRTGS`
`status` `string`	Current payout status. SCHEDULED: Request successfully received. PENDING: Funding account has insufficient balance. PROCESSING: Sent to bank, not yet processed. PROCESSED: Bank processed, confirmation pending. SUCCESS: Amount debited and credited successfully. FAILED: Transaction failed. Allowed values: `SCHEDULEDPENDINGPROCESSINGPROCESSEDSUCCESSFAILED`
`message` `string`	Message corresponding to the payout status.
`scheduledAt` `string`date-time	Scheduled execution time in UTC. Empty string when cancelled.
`remarks` `string`	Description or reference text for the transaction.
`_links` `PayoutLink[]`2 nested fields	HATEOAS navigation links.

Status Codes

`200`	Payout cancelled successfully.
`400`	The request was malformed or missing required fields.
`401`	Authentication failed — missing, expired, or invalid Bearer token.
`403`	The authenticated client does not have permission for this operation.
`404`	The requested resource does not exist.
`500`	An unexpected error occurred on the server.

Run

Request

curl --request PUT \
  --url https://pluraluat.v2.pinepg.in/payouts/v3/payments/banks/txn-f9e00a80a357418d908a67bd30cdbc37/cancel \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Request-ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Request-Timestamp: 2024-10-01T10:30:00Z'

Status:

{
  "clientReferenceId": "0171c4c0-f50a-4151-b39b-63c87a3c0cd6",
  "requestReferenceId": "req-ba50808e45ce4d19a86988e7d90df3ad",
  "paymentReferenceId": "txn-b03ee63e412a4ecf88b6bdb08a6632c3",
  "payeeName": "Kevin Bob",
  "accountNumber": "*******1415",
  "branchCode": "SBIN0011123",
  "amount": {
    "currency": "INR",
    "value": 4900
  },
  "mode": "IMPS",
  "status": "SCHEDULED",
  "message": "Payment instruction scheduled for execution",
  "scheduledAt": "2025-07-16T10:26:06Z",
  "remarks": "REFUND",
  "_links": [
    {
      "rel": "status",
      "href": "/payouts/v3/payments?paymentReferenceId=txn-b03ee63e412a4ecf88b6bdb08a6632c3"
    }
  ]
}