Ctrl K
Create Schedule Payment
POST/api/v1/transfer/schedule-payment
Schedules recurring or one-time payments.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| amount | integer | Yes | Amount in kobo. |
| start_date | string | No | YYYY-MM-DD HH:mm:ss (future date). |
| payout_type | string | Yes | "recurring" or "one-time". |
| frequency | string | Yes | "day", "week", "month". |
| source_wallet_id | string | Yes | Source wallet ID. |
| destination_type | string | Yes | "wallet" or "bank". |
| description | string | No | Narration. |
| destination_id | string | Yes | Wallet ID or bank account number. |
| destination_code | string | Cond. | Bank code if "bank". |
| end_date | string | No | End date for recurring (YYYY-MM-DD HH:mm:ss). |
1
Request Example
(cURL)
curl -X POST "https://api.piggyvest.business/api/v1/transfer/schedule-payment" \\-H "Authorization: Bearer YOUR_SECRET_KEY" \\-H "Content-Type: application/json" \\-d '{ "amount": 500000, "start_date": "2024-07-20 20:00:00", "payout_type": "recurring", "frequency": "month", "source_wallet_id": "bcc018ee-0c3d-4ad1-8906-583bb21274e2", "destination_type": "wallet", "description": "Monthly subscription payments", "destination_id": "70087c27-08a6-4638-9d1f-f8075e75cb60"}'2
Success Response(200)
(JSON)
{ "status": true, "message": "Transaction fetched successfully", "data": { "schedule_payment_id": "4b9353ea-cf7a-4900-b6f6-53e7aec89d40" }}3
Error Response(400)
(JSON)
{ "status": false, "message": "An error occurred"}