> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getflick.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Event reference

> The events Flick sends and what each one means.

Read `data.status` to route an event. `data.transaction_status` carries the outcome.

## Collections

| `status` | Meaning | What to do |
| - | - | - |
| `charge.success` | Funds received against a virtual account, card or transfer. | Credit the order. Check `transaction_message`. |
| `charge.pending` | Recorded but not settled. | Wait. A `charge.success` follows. |
| `wallet.credited` | Credit into a one-to-one account. HMAC-signed. | Credit the wallet. |

### `transaction_message` on a success

| Value | Meaning |
| - | - |
| `settled` | Funds are in your balance. |
| `awaiting settlement` | Confirmed but not yet in your balance. `time_to_settlement` gives the window, usually `T+1`. |

> [!WARNING]
>
> `charge.success` with `awaiting settlement` means the payer has paid, not that you
> have the money. Release goods on this if your risk appetite allows; do not treat
> your Flick balance as already increased.

## Payouts

| `status` | Meaning |
| - | - |
| `transfer.success` | Payout reached the beneficiary. |
| `transfer.failed` | Payout rejected. Funds return to your balance. |
| `transfer.refund` | Previously successful payout reversed by the beneficiary bank. |

> [!NOTE]
>
> `transfer.refund` can arrive days later. A payout is not final on
> `transfer.success` alone.

## Direct debit

| `status` | Meaning |
| - | - |
| `mandate.active` | Mandate approved, you may debit. |
| `mandate.cancelled` | Mandate withdrawn. Stop debiting. |

Poll [mandate status](https://docs.getflick.co/api-reference) if you need current state outside the event flow.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.