Pular para o conteúdo principal
GET
Lote de liquidação (resumo)

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

settlementId
string
obrigatório

Resposta

Settlement details

Lote diário de liquidação do crédito (CREDIT). Existe um lote por data de vencimento: reúne todas as remessas antecipadas cuja obrigação vence nessa data, inclusive as criadas em fins de semana. "Quanto pago hoje" = GET /v1/settlements?dueDate=. Ciclo: OPEN (acumulando; valor muda) → CLOSED (corte atingido; valor final) → DUE (vence hoje) → COMPLETED ou OVERDUE. v1 sem compensação: remessas antecipadas que terminam RETURNED ou FUNDS_HELD_BRL continuam no lote; o BRL correspondente fica na BRL Wallet. A contraparte é a LB Pay. Itens em GET /v1/settlements/{settlementId}/items.

settlementId
string
obrigatório
status
enum<string>
obrigatório

OPEN: acumulando. CLOSED: valor final, aguardando vencimento. DUE: vence hoje. OVERDUE: vencido sem pagamento. COMPLETED: pago e conciliado.

Opções disponíveis:
OPEN,
CLOSED,
DUE,
OVERDUE,
COMPLETED
dueDate
string<date>
obrigatório

Data de vencimento; única por lote.

cutoffAt
string<date-time>
obrigatório

Horário de corte do lote. Remessas criadas depois entram no lote seguinte.

itemCount
integer
obrigatório
Intervalo obrigatório: x >= 0
amount
object
obrigatório

Valor a pagar = principalTotal + fundingCostTotal. Muda enquanto OPEN; final a partir de CLOSED.

obligationType
enum<string>

Enum extensível.

Opções disponíveis:
CREDIT_REPAYMENT
direction
enum<string>

v1: apenas PAYABLE (a MSB paga). Enum extensível.

Opções disponíveis:
PAYABLE
periodStart
string<date-time>

Criação de remessa mais antiga incluída no lote.

periodEnd
string<date-time> | null

Criação de remessa mais recente incluída; final após o fechamento.

closedAt
string<date-time> | null
principalTotal
object

Soma dos valores antecipados.

fundingCostTotal
object

Soma dos custos de antecipação.

paymentInstructions
object | null

Dados para pagamento da obrigação, quando a MSB deve efetuá-lo.

reference
string | null
completedAt
string<date-time> | null