Ctrl K
Cancel/Re-Activate Payment
PATCH/api/v1/transfer/schedule-payment/:schedule_payment_id
Updates payment status.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| schedule_payment_id | string | Yes | Payment ID. |
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| is_active | boolean | Yes | False to cancel, true to reactivate. |
| next_charge_attempt | string | No | Next attempt date (YYYY-MM-DD HH:mm:ss). |
1
Request Example
(cURL)
curl -X PATCH "https://api.piggyvest.business/api/v1/transfer/schedule-payment/4b9353ea-cf7a-4900-b6f6-53e7aec89d40" \\-H "Authorization: Bearer YOUR_SECRET_KEY" \\-H "Content-Type: application/json" \\-d '{ "is_active": false}'Success Response (200): (Confirmation message.)
Note: Cannot reactivate if end_date has passed.