Sometimes you need to submit a payout before the funds that cover it have landed in your balance. By default, Glomo rejects that payout with an insufficient-balance error, and you have to submit it again after you top up.
Payout queueing removes that retry loop. When it is enabled on your account, a payout that your balance cannot cover is accepted and held with the status queued. Glomo releases it automatically once your balance covers it. You do not have to do anything else.
Payout queueing is enabled per account by Glomo. Contact your Glomo account manager to enable it.
When you create a payout, Glomo compares your balance in the source currency against the payout amount plus fees. If the balance is not sufficient, the payout is created with the status queued.
Glomo then monitors your balance and releases the payout automatically as soon as the balance covers it. The payout continues as any other payout does: it moves to in_progress, and then to success or failed.
Note the following:
- Queued payouts are released in FIFO order, per currency. Within a source currency, the payout that was queued first is released first. Each currency has its own order, so a queued EUR payout has no effect on your queued AED payouts.
- A payout your balance covers is not queued. It processes immediately, even if you have other payouts in the queue.
Fees and the FX rate are fixed when the payout is created, not when it is released. The rate you see at creation is the rate Glomo applies when the payout is released.
A queued payout leaves the queue in one of these ways:
| Outcome | Description |
|---|---|
| Released | Your balance covers the payout. The payout moves to in_progress and continues to success or failed. |
| Expired | The payout stays queued for 30 days. It moves to failed with error_code set to QUEUE_EXPIRED. No funds were held at any point. |
| Cancelled | You cancel the payout. You can do this at any time while the payout is queued. Nothing is reversed, because no funds were held. |
| Review needed | Glomo needs more information before the payout can be processed. The payout moves to action_required. See Action Required State. |
To cancel a queued payout, use the Cancel a payout API or the Glomo dashboard. See Cancel a Payout.
A queued payout has status set to queued. The status appears in the create response, in Retrieve a payout (GET /v1/payouts/:id), and in List all payouts (GET /v1/payouts).
To list only your queued payouts, use the status filter:
GET /v1/payouts?status=queuedGlomo sends a payout webhook with event_type set to queued when the payout enters the queue, and another webhook when it leaves. No new webhook type was added. See Payout Webhooks.
Glomo keeps rejecting a payout that your balance does not cover at the time you create it, with this message:
Account has insufficient balance to process this transaction. Additional amount required: N.