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

# Remittance statuses

> Each remittance has one lifecycle status. FX, funding, payout and settlement each have their own sub-status, shown separately.

## How statuses change

| From | To | When |
| - | - | - |
| Withdrawal created | `PROCESSING` | Withdrawal is valid. |
| Withdrawal created | `ON_HOLD` | Compliance alert on creation. |
| `PROCESSING` | `ON_HOLD` | Compliance alert during screening, before FX is contracted. |
| `ON_HOLD` | `PROCESSING` | Compliance review approved. |
| `ON_HOLD` | `REJECTED` | Compliance review declined. |
| `PROCESSING` | `REJECTED` | Failure before FX was contracted. |
| `PROCESSING` | `COMPLETED` | Pix credited to the beneficiary. |
| `PROCESSING` | `FUNDS_HELD_BRL` | FX contracted and Pix failed definitively, or the Pix key holder does not match the beneficiary. |
| `COMPLETED` | `RETURNED` | Pix returned by the receiving side. |

## What each status means

| Status | Meaning | What you do |
| - | - | - |
| `PROCESSING` | Created and in progress: FX, funding and Pix are being executed. | Nothing. Follow the notifications. Do not resend. |
| `ON_HOLD` | Under compliance review. The reason is not detailed. | Wait. The remittance moves to `PROCESSING` or `REJECTED`. |
| `COMPLETED` | Pix credited to the beneficiary. The receipt is available. | Nothing. For credit, follow the settlement. |
| `REJECTED` | Stopped before FX was contracted. | Check the reason. Request a new quote and create a new withdrawal if appropriate. |
| `FUNDS_HELD_BRL` | FX contracted. The Pix failed definitively or the key holder did not match. The amount is held in BRL. | Contact LB Pay support to follow the operational procedure. |
| `RETURNED` | Pix was returned. The amount is credited to the BRL Wallet. | Check the beneficiary’s details with the sender. |

## Sub-status by domain

| Domain | Value | Meaning |
| - | - | - |
| FX | `PENDING` | Not contracted yet. |
| | `PROCESSING` | Waiting for confirmation. |
| | `CONTRACTED` | FX contracted. |
| | `FAILED` | FX failed. The remittance ends as `REJECTED`. |
| | `EXPIRED` | FX expired. The remittance ends as `REJECTED`. |
| Funding | `PENDING` | Not confirmed yet. |
| | `RETRYING` | An attempt failed after FX. LB Pay keeps retrying. |
| | `CONFIRMED` | Funding confirmed. |
| Payout (Pix) | `PENDING` | Pix not sent yet. |
| | `PROCESSING` | Pix sent. |
| | `COMPLETED` | Beneficiary credited. |
| | `FAILED` | A Pix attempt failed. |
| | `EXPIRED` | A Pix attempt expired. Counts as a failed attempt. |
| | `RETURNED` | Pix returned. |
| Settlement | `NOT_APPLICABLE` | `PREFUNDED`. No settlement. |
| | `OPEN` | In a batch still collecting remittances. |
| | `CLOSED` | Batch cut-off reached; final amount. |
| | `DUE` | Batch due today. |
| | `OVERDUE` | Due date passed without payment. |
| | `COMPLETED` | Batch paid and reconciled. |

## Rules

* `REJECTED` only happens before FX is contracted.
* `ON_HOLD` only happens before FX is contracted.
* A funding failure after FX does not end the remittance. LB Pay keeps retrying and the remittance stays `PROCESSING`.
* Settlement is `NOT_APPLICABLE` for `PREFUNDED`.
* `COMPLETED` means the Pix was credited. It does not depend on settlement, which is followed separately.
* Without a response, FX or Pix stays in `PROCESSING` until it is confirmed, or goes to `FAILED` or `EXPIRED`. There is no “unknown” status.
* FX `FAILED` or `EXPIRED` ends the remittance as `REJECTED`. Pix `FAILED` or `EXPIRED` counts as a failed attempt.
* The status reason is generic. Compliance reasons are not detailed.


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