Base URL:
https://api.yuciferpay.xyz
Interactive documentation is available at:
Swagger Docs
ReDoc
Every request must include your API key.
api-key: my-secret-key Content-Type: application/json
All routes that require a schedule_id expect the following format:
SCHEDULE-{user_id}-{serial_id}
Example:
SCHEDULE-12-001
Returns your YuciferPay user ID.
GET https://api.yuciferpay.xyz/user/id Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS",
"user_id":12
}
Returns all schedules belonging to your account.
GET https://api.yuciferpay.xyz/get_schedules Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS",
"data":[
{
"Schedule Id":"SCHEDULE-12-001",
"Account Name":"John Doe",
"Bank Name":"GTBank",
"Account No":"0123456789",
"Amount":"5000",
"Is_active":true,
"Paused":false,
"Pay date":"2026-06-22"
}
]
}
Returns information about one schedule.
GET https://api.yuciferpay.xyz/get_schedule/SCHEDULE-12-001 Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS",
"data":[
{
"Schedule Id":"SCHEDULE-12-001",
"Account Name":"John Doe",
"Bank Name":"GTBank",
"Account No":"0123456789",
"Amount":"5000",
"Is_active":true,
"Paused":false,
"Pay date":"2026-06-22"
}
]
}
Creates a new payment schedule.
POST https://api.yuciferpay.xyz/add_schedule
Headers
api-key: my-secret-key
Content-Type: application/json
Body
{
"serial_id":"001",
"acct_name":"John Doe",
"bank_name":"GTBank",
"acct_num":"0123456789",
"amount":"5000",
"date":"2026-06-22",
"frequency":4
}
frequency is an optional integer that specifies the interval, in weeks, between recurring payments.
If omitted, the default value is 4 (monthly).
Examples:
{
"code":200,
"message":"SUCCESS"
}
Updates an existing schedule. All fields are optional. Only supplied values will be changed.
PUT https://api.yuciferpay.xyz/schedule/edit/SCHEDULE-12-001
Headers
api-key: my-secret-key
Content-Type: application/json
Body
{
"acct_name":"John Doe",
"bank_name":"GTBank",
"acct_num":"0123456789",
"amount":"10000",
"date":"2026-06-25",
"frequency":4
}
frequency is an integer that specifies the interval, in weeks, between recurring payments.
If omitted, the default value is 4 (monthly).
Examples:
{
"code":200,
"message":"SUCCESS"
}
Deletes an existing schedule.
DELETE https://api.yuciferpay.xyz/schedule/SCHEDULE-12-001 Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS"
}
Temporarily pauses a schedule. Paused schedules will not be processed.
POST https://api.yuciferpay.xyz/schedule/SCHEDULE-12-001/pause Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS"
}
Reactivates a previously paused schedule.
POST https://api.yuciferpay.xyz/schedule/SCHEDULE-12-001/unpause Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS"
}
Returns every order belonging to your account.
GET https://api.yuciferpay.xyz/orders Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS",
"data":[
{
"Order id":"ORD-1001",
"Account Number":"0123456789",
"Account Name":"John Doe",
"Bank Name":"GTBank",
"Amount":"5000",
"Status":"success",
"Processed with":"Paystack",
"Reference Id":"REF12345",
"Is Queued":false,
"Created At":"2026-06-23",
"Updated At":"2026-06-23"
}
]
}
Returns orders that are currently processing.
GET https://api.yuciferpay.xyz/orders/active Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS",
"data":[]
}
Returns orders that failed during processing.
GET https://api.yuciferpay.xyz/orders/failed Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS",
"data":[]
}
Retries all failed orders belonging to your account.
POST https://api.yuciferpay.xyz/orders/retry Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS"
}
Enables automatic schedule execution.
POST https://api.yuciferpay.xyz/automation/enable Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS"
}
Disables automatic schedule execution.
POST https://api.yuciferpay.xyz/automation/disable Headers api-key: my-secret-key
{
"code":200,
"message":"SUCCESS"
}
GET /user/id to obtain your user ID.POST /add_schedule.GET /get_schedules.YuciferPay automatically generates interactive documentation via FastAPI. For a complete list of endpoints, schemas and response models, visit: