Skip to main content
GET
Get remittance status and details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

remittanceId
string
required

Response

Remittance details

status descreve o ciclo de vida; o detalhe de cada domínio fica em fx, funding, payout e settlement.

Não existe status de resultado desconhecido: sem resposta, o domínio permanece PROCESSING até confirmação, ou vai para FAILED/EXPIRED.

Ordem de execução: screening → câmbio → funding → Pix. O câmbio só é contratado após o screening; uma remessa pode ir para ON_HOLD na criação ou durante o screening, sempre antes de fx.status = CONTRACTED.

Funding: PREFUNDED debita o USD da MSB nos EUA antes do Pix; CREDIT antecipa o BRL e gera obrigação de liquidação. Falha de funding após o câmbio não encerra a remessa: a LB Pay continua tentando (funding.status = RETRYING) e a remessa permanece PROCESSING.

Antes do Pix a LB Pay confirma que o titular da chave corresponde ao documento do beneficiário. Divergência impede o Pix e leva a FUNDS_HELD_BRL (payout.failureCode = PIX_KEY_OWNER_MISMATCH).

COMPLETED significa Pix concluído e não depende da liquidação. REJECTED só ocorre antes de fx.status = CONTRACTED; após o câmbio, falha definitiva de Pix leva a FUNDS_HELD_BRL e devolução a RETURNED.

INVENTORY: taxa e volume foram contratados no Inventory Lot (inventoryId); quoteId é null e valores vêm do lote (fx.rate = taxa do lote). A operação de câmbio é executada por remessa; fx.status = CONTRACTED só após a confirmação da execução. Em REJECTED o volume reservado volta ao lote.

remittanceId
string
required
type
enum<string>
required

Operação que originou a remessa. WITHDRAWAL: envio do remetente para um beneficiário no Brasil via Pix. Enum extensível: ignore tipos desconhecidos.

Available options:
WITHDRAWAL
externalId
string
required

ID da MSB para a remessa. Único por cliente e imutável; chave de conciliação.

quoteId
string | null
required

null somente em remessas INVENTORY.

status
enum<string>
required
Available options:
PROCESSING,
ON_HOLD,
COMPLETED,
REJECTED,
FUNDS_HELD_BRL,
RETURNED
senderId
string
required
beneficiaryId
string
required
source
object
required

Valor monetário (saldos, extratos, custos). Pode ser zero. Para valores de requisição use PositiveMoney.

destination
object
required

Valor monetário (saldos, extratos, custos). Pode ser zero. Para valores de requisição use PositiveMoney.

fx
object
required
funding
object
required
payout
object
required
settlement
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
inventoryId
string | null

Inventory Lot que financiou a remessa; somente funding.mode = INVENTORY.

senderQuote
object | null

Dados da operação de câmbio da MSB com o remetente (usuário final). Obrigatório em INVENTORY. Não é informativo: é gravado na remessa como recebido e usado na formalização da operação. Não altera valores da remessa, taxa do lote nem cobrança. Não confundir com a cotação da LB Pay (quoteId) nem com a taxa do Inventory Lot.

A estrutura pode receber novos campos.

statusReason
string | null

Código genérico; motivos de compliance não são detalhados.

paymentInstructionId
string
purpose
enum<string>

Finalidade declarada; mapeada internamente para a natureza da operação de câmbio. Enum extensível.

Available options:
FAMILY_MAINTENANCE,
GIFT,
PERSONAL_SAVINGS,
EDUCATION,
MEDICAL,
SERVICES_PAYMENT,
GOODS_PAYMENT,
SALARY,
OTHER
senderRelationship
enum<string>

Relação do remetente com o beneficiário.

Available options:
SELF,
FAMILY,
FRIEND,
EMPLOYER,
EMPLOYEE,
BUSINESS_PARTNER,
OTHER
spread
object

Spread de câmbio: única tarifa da remessa.

metadata
object