Pular para o conteúdo principal
GET
Get an inventory lot with balances

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

inventoryId
string
obrigatório

Resposta

Inventory Lot

Inventory Lot: câmbio contratado antecipadamente pela MSB e promessa de pagamento em USDC. Cada aceite de cotação INVENTORY cria um lote independente, com taxa, volume e validade próprios. total = available + reserved + used. A obrigação em USDC existe independentemente de withdrawals e se refere ao volume não utilizado; o evento e a data de apuração e cobrança serão comunicados antes da disponibilidade geral.

inventoryId
string
obrigatório
Exemplo:

"inv_01JA2B"

quoteId
string
obrigatório

Cotação INVENTORY que originou o lote.

status
enum<string>
obrigatório

ACTIVE: dentro da validade, com volume disponível. DEPLETED: sem volume disponível (todo reservado ou utilizado); volta a ACTIVE se uma reserva for liberada dentro da validade. EXPIRED: passou de expiresAt; não aceita novos withdrawals. O tratamento do volume remanescente após a expiração será comunicado antes da disponibilidade geral. Enum extensível.

Opções disponíveis:
ACTIVE,
DEPLETED,
EXPIRED
fromCurrency
enum<string>
obrigatório
Opções disponíveis:
USD
toCurrency
enum<string>
obrigatório
Opções disponíveis:
BRL
rate
string
obrigatório

Taxa contratada entre a MSB e a LB Pay (BRL por USD), já com o spread. Aplicada a todas as remessas do lote.

Pattern: ^[0-9]+(\.[0-9]{1,8})?$
Exemplo:

"5.40000000"

total
object
obrigatório

Volume contratado.

available
object
obrigatório

Volume disponível para novos withdrawals.

reserved
object
obrigatório

Volume reservado por withdrawals em andamento.

used
object
obrigatório

Volume já utilizado por withdrawals.

expiresAt
string<date-time>
obrigatório

Validade do lote.

createdAt
string<date-time>
obrigatório
updatedAt
string<date-time>
obrigatório
externalId
string | null
referenceRate
string

BRL por USD, até 8 casas decimais.

Pattern: ^[0-9]+(\.[0-9]{1,8})?$
Exemplo:

"5.43210000"

spread
object

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

pendingSettlement
object | null

Obrigação em USDC referente ao volume não utilizado. null até a apuração, cujo evento será comunicado antes da disponibilidade geral.

settlementId
string | null

Lote de liquidação da obrigação, quando existir.

metadata
object