# Javali Bridge ## Guides ### Get started - [Overview](https://developers.javalibridge.com/en/guides/overview.md): LB Pay Cross-Border Payouts lets a money services business (MSB) in the United States send remittances in USD. The recipient receives BRL via Pix, usually within minutes. FX is contracted for each remittance, at the spot rate. LB Pay orchestrates the quote, FX, funding, Pix, reconciliation and settl… - [Participants](https://developers.javalibridge.com/en/guides/participants.md): Four parties take part in every remittance. LB Pay is the only counterpart the MSB deals with. No other institution is identified in the portal, API, receipts or messages. - [How it works](https://developers.javalibridge.com/en/guides/flow.md): A remittance happens in three phases. A quote is only a price: it is not linked to a sender or a beneficiary. The sender and the beneficiary are informed in the withdrawal, so both must be ready before it: the sender registered, active and at LEVEL_1 or above, and the beneficiary approved. They can… - [Key concepts](https://developers.javalibridge.com/en/guides/concepts.md): The building blocks of the product. Each one appears in the portal and in the API with the same name. - [Integration steps](https://developers.javalibridge.com/en/guides/integration.md): The API calls for a first remittance, in order. Each action opens the endpoint in the API Reference. ### Remittances - [Quotes](https://developers.javalibridge.com/en/guides/quotes.md): A quote is a price offer for an amount. It is only a price: it is not linked to a sender, does not check the sender, does not reserve limit, does not contract FX and does not create a remittance. - [Creating a withdrawal](https://developers.javalibridge.com/en/guides/withdrawal.md): A withdrawal sends money from a sender to a beneficiary in Brazil, and it is the only way to create a remittance in v1. It uses a quote for the price. In the withdrawal, the MSB informs who sends, who receives, why, and how the remittance is funded. - [Funding modes](https://developers.javalibridge.com/en/guides/funding.md): Every remittance is funded in one of three ways, chosen in the withdrawal. PREFUNDED and CREDIT use the same quote price. INVENTORY uses the rate of an Inventory Lot contracted in advance. - [USDC Inventory](https://developers.javalibridge.com/en/guides/inventory.md): USDC Inventory lets the MSB contract FX in advance, locking rate and volume in an Inventory Lot, and use that volume later in withdrawals. When contracting, the MSB takes on a payment promise in USDC. - [Order of execution](https://developers.javalibridge.com/en/guides/execution.md): After the withdrawal is created, LB Pay always follows the same order. Screening comes first. The Pix is sent last. - [Remittance statuses](https://developers.javalibridge.com/en/guides/statuses.md): Each remittance has one lifecycle status. FX, funding, payout and settlement each have their own sub-status, shown separately. - [Exceptions](https://developers.javalibridge.com/en/guides/exceptions.md): Most remittances go from PROCESSING to COMPLETED. These are the cases that need attention. ### Records and balances - [Senders and compliance levels](https://developers.javalibridge.com/en/guides/senders.md): The MSB registers its senders. Each sender has a compliance level. The level defines whether they can send and how much, in rolling windows of 24 hours, 30 days and 180 days. - [Beneficiaries and payment instructions](https://developers.javalibridge.com/en/guides/beneficiaries.md): Beneficiaries are the people and companies in Brazil that receive your payouts. LB Pay does not onboard them as its own customers. Instead, every payment instruction (Pix key) you register is screened before it can be used in a remittance. - [Wallets](https://developers.javalibridge.com/en/guides/wallets.md): Wallets show the money linked to the MSB’s remittances. Balances come from auditable entries and are never edited directly. - [Settlements and reconciliation](https://developers.javalibridge.com/en/guides/settlements.md): A settlement is what the MSB pays to LB Pay for remittances funded by credit. LB Pay reconciles every step internally. This section explains how you reconcile your own records. ### Operations - [Notifications (webhooks)](https://developers.javalibridge.com/en/guides/webhooks.md): LB Pay notifies your systems at each relevant change. There are 21 events in 7 groups. - [Limits and SLAs](https://developers.javalibridge.com/en/guides/limits.md): Commercial values are set in the agreement with each MSB. - [Responsibilities](https://developers.javalibridge.com/en/guides/responsibilities.md): What each party is responsible for. - [Glossary and FAQ](https://developers.javalibridge.com/en/guides/glossary.md): Terms used in the portal, the API and this guide. ## API reference ### Overview - [API conventions](https://developers.javalibridge.com/en/api-reference/conventions.md): Rules that apply to every endpoint of the LB Pay Cross-Border Payouts API: authentication, amounts, pagination, errors and webhook signatures. ### Health - [Health check](https://developers.javalibridge.com/en/api-reference/get-health.md): Situação da plataforma e de cada serviço. Não exige autenticação. Responde 200 inclusive em DEGRADED e MAINTENANCE; falha de conexão ou 5xx indica indisponibilidade. Em MAINTENANCE, cotações retornam SERVICE_UNAVAILABLE. Resultado pode ser cacheado por até 30s. ### FX Quotes - [Request a quote](https://developers.javalibridge.com/en/api-reference/create-fx-quote.md): Retorna o preço para o cliente: valores, taxa de referência, taxa aplicada e spread em %. A cotação não é vinculada a remetente nem a operação. Não valida remetente, não reserva limite, não contrata câmbio e não cria remessa. Elegibilidade do remetente, limites, habilitação de funding, limite de cré… - [Get a quote](https://developers.javalibridge.com/en/api-reference/get-fx-quote.md) ### Inventories - [Create an inventory lot](https://developers.javalibridge.com/en/api-reference/create-inventory.md): Cria um Inventory Lot a partir de uma cotação `usage = INVENTORY`, AVAILABLE e não expirada. Esta é a única operação de aceite: em uma chamada a LB Pay fecha com a MSB a taxa e o volume, cria a promessa de pagamento em USDC e cria o lote, que nasce ACTIVE com taxa, volume e validade da cotação. A ex… - [List inventory lots](https://developers.javalibridge.com/en/api-reference/list-inventories.md) - [Get an inventory lot](https://developers.javalibridge.com/en/api-reference/get-inventory.md): Taxa, validade e saldos do lote (total, disponível, reservado e utilizado). As remessas que consumiram o lote estão em GET /v1/remittances?inventoryId=. ### Remittances - [Create a withdrawal](https://developers.javalibridge.com/en/api-reference/create-withdrawal.md): Realiza um withdrawal do remetente para um beneficiário a partir de uma cotação, criando uma remessa do tipo WITHDRAWAL de forma idempotente. A cotação informa apenas o preço; remetente, beneficiário, finalidade e funding são informados aqui. Na criação a LB Pay, de forma síncrona: valida a cotação… - [List remittances](https://developers.javalibridge.com/en/api-reference/list-remittances.md) - [Get a remittance](https://developers.javalibridge.com/en/api-reference/get-remittance.md) - [Get the Pix receipt](https://developers.javalibridge.com/en/api-reference/get-remittance-receipt.md) ### Senders - [Create a sender](https://developers.javalibridge.com/en/api-reference/create-sender.md): Registra o remetente final (cliente da MSB). Idempotente por externalId: retorna 201 ao criar e 200 se já existir. - [List senders](https://developers.javalibridge.com/en/api-reference/list-senders.md) - [Get a sender](https://developers.javalibridge.com/en/api-reference/get-sender.md) - [Update a sender](https://developers.javalibridge.com/en/api-reference/update-sender.md) ### Beneficiaries - [Create a beneficiary](https://developers.javalibridge.com/en/api-reference/create-beneficiary.md): Cria o beneficiário e suas chaves Pix. Cada instrução entra em SCREENING e passa a APPROVED ou REJECTED de forma automática; o resultado é notificado por beneficiary.status_changed. A LB Pay não cadastra o beneficiário como cliente próprio. - [List beneficiaries](https://developers.javalibridge.com/en/api-reference/list-beneficiaries.md) - [Get a beneficiary](https://developers.javalibridge.com/en/api-reference/get-beneficiary.md) - [Update a beneficiary](https://developers.javalibridge.com/en/api-reference/update-beneficiary.md) ### Credit line - [Get the credit line](https://developers.javalibridge.com/en/api-reference/get-credit-line.md): Limite, utilização, reserva, disponível e capacidade atual de antecipação. Não se aplica a remessas PREFUNDED. ### Limits - [Get account limits](https://developers.javalibridge.com/en/api-reference/get-account-limits.md): Limite por remessa (mínimo e máximo) e limite diário da conta, com utilizado e disponível. - [Get sender limits](https://developers.javalibridge.com/en/api-reference/get-sender-limits.md): Limite, utilizado e disponível do remetente nas janelas de 24h, 30d e 180d. - [Get beneficiary limits](https://developers.javalibridge.com/en/api-reference/get-beneficiary-limits.md): Limite de recebimento, utilizado e disponível do beneficiário nas janelas de 24h, 30d e 180d. ### Wallets - [List wallets](https://developers.javalibridge.com/en/api-reference/list-wallets.md): Lista as wallets da conta com saldos (contábil, disponível, reservado, pendente). Use os filtros para obter uma wallet específica. - [List wallet transactions](https://developers.javalibridge.com/en/api-reference/list-wallet-transactions.md): Lançamentos imutáveis do ledger. Sem filtros, retorna os lançamentos de todas as wallets. ### Settlements - [List settlement batches](https://developers.javalibridge.com/en/api-reference/list-settlements.md): Lista os lotes diários. Use dueDate= para obter o valor a pagar no dia. - [Get a settlement batch](https://developers.javalibridge.com/en/api-reference/get-settlement.md) - [List batch items](https://developers.javalibridge.com/en/api-reference/list-settlement-items.md): Remessas que compõem o lote, paginadas. A soma de amount de todos os itens é igual ao amount do lote. ### Webhooks - [List webhook endpoints](https://developers.javalibridge.com/en/api-reference/list-webhooks.md) - [Register a webhook endpoint](https://developers.javalibridge.com/en/api-reference/create-webhook.md) - [Delete a webhook endpoint](https://developers.javalibridge.com/en/api-reference/delete-webhook.md) - [List webhook deliveries](https://developers.javalibridge.com/en/api-reference/list-webhook-deliveries.md) - [Retry a webhook delivery](https://developers.javalibridge.com/en/api-reference/retry-webhook-delivery.md) ## OpenAPI Specs - [openapi](/api-reference/openapi.yaml) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Brazilian Portuguese (53 pages)](https://developers.javalibridge.com/_llms/pt-br.txt): Documentation for Brazilian Portuguese. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.