Set Fleet Auto-Zero
POST/v1/fleet/auto-zero
Turns the nightly auto-zero on or off for your fleet. When it's on, every driver's unused sub-wallet balance returns to your fleet's wallet each night at 00:00 Africa/Lagos time (WAT). It's off until you turn it on.
Once this is on, your drivers start each day at ₦0. They can't pay from their wallet until you distribute funds to them again, so schedule your top-ups for after midnight before you turn it on.
Auth
Authorization: ApiKey <your fleet's API key> — server-side only.
Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | true to turn nightly auto-zero on, false to turn it off. |
Example request
curl https://api.lotgrids.com/v1/fleet/auto-zero \
-X POST \
-H "Authorization: ApiKey lg_live_f_8f21a9.9c2e1b7a..." \
-H "Content-Type: application/json" \
-d '{ "enabled": true }'
Example success response
200 OK
{
"autoZeroEnabled": true
}
What to expect
- It covers every driver in your fleet with a balance, including drivers you've removed. Each driver's whole balance is returned, including any part that came from their sign-up credit.
- A charge already paid from the sub-wallet isn't affected. If that session ends early after midnight, its refund stays in the driver's sub-wallet until the next night's run.
- Drivers aren't emailed about this. If they need to know, tell them from your own app.
- Each transfer appears in your Partner Dashboard's Transactions tab as
zero_balance_debitandzero_balance_credit, initiated bysystem. - Live and test keys have separate settings. To try it safely, turn it on with your test key; only your sandbox fleet is affected.
To return one driver's balance immediately instead of waiting for midnight, use Zero Driver Balance.
Error responses
400 invalid_argument
{ "error": { "code": "invalid_argument", "message": "enabled must be true or false." } }