# Update Scheduled Payout

**Method:** `PUT`

**Path:** `/payouts/v3/payments/banks/{paymentReferenceId}`

**Category:** Payouts

**Authentication:** Required

## Description

Updates the scheduled date of a payout. Only payouts with status
SCHEDULED can be updated. Provide the new schedule date in
ISO 8601 UTC format.


## Path Parameters

- `paymentReferenceId` (`string`) **required** — Unique identifier of the payment in Pine Labs database.

## Request Body

Content-Type: `application/json`

- `scheduleAt` (`string`) — New scheduled time for executing the payout (ISO 8601 UTC).

### Example Request

```json
{
  "scheduleAt": "2025-07-05T16:05:00Z"
}
```

## Responses

- `200` — Payout schedule updated successfully.
- `400` — 
- `401` — 
- `403` — 
- `404` — 
- `500` — 

### Response Schema

- `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 address of the beneficiary.
- `phone` (`string`) — Mobile number of the beneficiary.
- `amount` (`object`) — 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).
  - `currency` (`string`) **required** — Three-letter ISO 4217 currency code.

- `mode` (`UPI | IMPS | NEFT | RTGS`) — Payment mode used for the payout.
- `status` (`SCHEDULED | PENDING | PROCESSING | PROCESSED | SUCCESS | FAILED`) — 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. 
- `message` (`string`) — Message corresponding to the payout status.
- `scheduledAt` (`string`) — Scheduled execution time in UTC. Empty string when cancelled.
- `remarks` (`string`) — Description or reference text for the transaction.
- `_links` (`PayoutLink[]`) — HATEOAS navigation links.
  - `rel` (`string`) — Relation type of the link.
  - `href` (`string`) — URL of the related resource.


### Example Response

```json
{
  "clientReferenceId": "test4feb0-10",
  "requestReferenceId": "req-7c85bda19bf141c981b94e750c6041b6",
  "paymentReferenceId": "txn-f9e00a80a357418d908a67bd30cdbc37",
  "payeeName": "Kevin Bob",
  "accountNumber": "919000664016",
  "branchCode": "PYTM0123456",
  "vpa": "9876543210@examplebank",
  "email": "s.john@g.com",
  "phone": "9000664016",
  "amount": {
    "value": 4900,
    "currency": "INR"
  },
  "mode": "IMPS",
  "status": "SCHEDULED",
  "message": "Payment instruction pending to be executed",
  "scheduledAt": "2025-07-05T16:05:00Z",
  "remarks": "Test transaction",
  "_links": [
    {
      "rel": "status",
      "href": "/payouts/v3/payments?paymentReferenceId=txn-b03ee63e412a4ecf88b6bdb08a6632c3"
    }
  ]
}
```

---

Reference: https://localhost:3000/api/payouts/update-scheduled-payout