> ## 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. # Get an inventory lot > 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=. ## OpenAPI ````yaml api-reference/openapi.yaml GET /v1/inventories/{inventoryId} openapi: 3.0.3 info: title: LB Pay Cross-Border Payouts API version: 1.21.0 description: > Cross-border payouts API da LB Pay — v1: USD→BRL (fromCurrency/toCurrency), câmbio contratado remessa a remessa (SPOT) e pagamento via Pix. ## Princípios - Cotação e operação são domínios separados. A cotação (`POST /v1/fx/quotes`) é apenas preço e não cria remessa. A remessa nasce da operação que o cliente quer realizar — na v1, um withdrawal para um beneficiário: `POST /v1/fx/quotes` → `POST /v1/remittances/withdrawals`. - A cotação é apenas preço: um único preço, igual para PREFUNDED e CREDIT, válido para qualquer remetente do cliente. A única tarifa da remessa é o spread de câmbio, em percentual. O custo da antecipação (CREDIT) segue o contrato e é cobrado no lote de liquidação. Remetente, beneficiário, finalidade e funding são informados no withdrawal. - USDC Inventory: o cliente pode contratar câmbio antecipadamente. Uma cotação com `usage = INVENTORY` é usada uma única vez para criar um Inventory Lot (`POST /v1/inventories`), que fixa taxa, volume e validade e gera a promessa de pagamento em USDC. O lote é consumido depois por withdrawals com `funding.mode = INVENTORY`. - Valores monetários são strings decimais. Valores de requisição devem ser maiores que zero. - Listas usam paginação por cursor (`cursor`, `limit`; resposta com `nextCursor`). ## Rate limiting Respostas 429 trazem `Retry-After` (segundos). Clientes devem respeitar o header e aplicar backoff exponencial com jitter. ## Erros Todo erro retorna `ApiError`. O campo `code` segue o catálogo em `components.x-error-catalog`; novos códigos podem ser adicionados sem mudança de versão — clientes devem tratar códigos desconhecidos pelo HTTP status. ## Webhooks Eventos documentados em `x-webhooks`. Cada entrega é um `POST` com envelope `WebhookEvent` e os headers: - `LBPay-Event-Id`: igual a `eventId`; use para deduplicar (entrega é at-least-once). - `LBPay-Timestamp`: unix epoch (segundos) do envio. - `LBPay-Signature`: `v1=`. Rejeite se a assinatura não bater ou se |agora − timestamp| > 300s. Responda 2xx em até 10s; falhas são reenviadas com backoff exponencial por até 24h. A ordem de entrega não é garantida — use `occurredAt` e o estado do recurso, ou consulte o recurso via GET. ## Chaves de conciliação Toda remessa é rastreável pelas mesmas chaves em todos os objetos: `externalId` (ID da MSB, único por cliente e imutável) · `quoteId` · `remittanceId` · `settlementId` (CREDIT) · `transactionId` (pagamento Pix) · `inventoryId` (INVENTORY). - Quote → `remittanceId`, `externalId` (preenchidos quando a cotação é usada por um withdrawal) - Remittance → `externalId`, `quoteId` (null em INVENTORY), `inventoryId` (INVENTORY), `settlement.settlementId`, `payout.transactionId` - Inventory → `quoteId` (cotação que originou o lote), `externalId`; remessas do lote em `GET /v1/remittances?inventoryId=` - SettlementItem → `remittanceId`, `externalId`, `quoteId`, `transactionId` - WalletTransaction → `remittanceId`, `externalId`, `quoteId`, `settlementId` - Receipt → `remittanceId`, `externalId`, `quoteId`, `transactionId` - Webhooks de remessa → snapshot completo da Remittance servers: - url: https://api.lbpay.example.com description: Example production URL - replace before use - url: https://sandbox.lbpay.example.com description: Example sandbox URL - replace before use security: - BearerAuth: [] tags: - name: Health - name: FX Quotes - name: Inventories - name: Remittances - name: Senders - name: Beneficiaries - name: Credit Line - name: Limits - name: Wallets - name: Settlements - name: Webhooks paths: /v1/inventories/{inventoryId}: get: tags: - Inventories summary: Get an inventory lot with balances description: >- 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=. operationId: getInventory parameters: - $ref: '#/components/parameters/InventoryId' responses: '200': description: Inventory Lot content: application/json: schema: $ref: '#/components/schemas/Inventory' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' components: parameters: InventoryId: name: inventoryId in: path required: true schema: type: string schemas: Inventory: type: object required: - inventoryId - quoteId - status - fromCurrency - toCurrency - rate - total - available - reserved - used - expiresAt - createdAt - updatedAt description: >- 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. properties: inventoryId: type: string example: inv_01JA2B externalId: type: string nullable: true quoteId: type: string description: Cotação INVENTORY que originou o lote. status: $ref: '#/components/schemas/InventoryStatus' fromCurrency: type: string enum: - USD toCurrency: type: string enum: - BRL referenceRate: $ref: '#/components/schemas/Rate' rate: allOf: - $ref: '#/components/schemas/Rate' description: >- Taxa contratada entre a MSB e a LB Pay (BRL por USD), já com o spread. Aplicada a todas as remessas do lote. example: '5.40000000' spread: $ref: '#/components/schemas/FxSpread' total: allOf: - $ref: '#/components/schemas/InventoryAmount' description: Volume contratado. available: allOf: - $ref: '#/components/schemas/InventoryAmount' description: Volume disponível para novos withdrawals. reserved: allOf: - $ref: '#/components/schemas/InventoryAmount' description: Volume reservado por withdrawals em andamento. used: allOf: - $ref: '#/components/schemas/InventoryAmount' description: Volume já utilizado por withdrawals. pendingSettlement: allOf: - $ref: '#/components/schemas/Money' nullable: true description: >- Obrigação em USDC referente ao volume não utilizado. null até a apuração, cujo evento será comunicado antes da disponibilidade geral. settlementId: type: string nullable: true description: Lote de liquidação da obrigação, quando existir. expiresAt: type: string format: date-time description: Validade do lote. createdAt: type: string format: date-time updatedAt: type: string format: date-time metadata: type: object additionalProperties: true InventoryStatus: type: string enum: - ACTIVE - DEPLETED - EXPIRED description: >- 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. Rate: type: string pattern: ^[0-9]+(\.[0-9]{1,8})?$ description: BRL por USD, até 8 casas decimais. example: '5.43210000' FxSpread: type: object required: - percentage - amount description: 'Spread de câmbio: única tarifa da remessa.' properties: percentage: type: string pattern: ^[0-9]+(\.[0-9]{1,4})?$ example: '0.75' description: Percentual sobre referenceRate (0.75 = 0,75%). amount: allOf: - $ref: '#/components/schemas/Money' description: >- Valor do spread em USD. Referência para conciliação em caso de arredondamento. example: currency: USD amount: '7.50' InventoryAmount: type: object required: - source - destination description: >- Volume nas duas moedas. O controle é feito em BRL (destination); o USD (source) é calculado na taxa do lote. properties: source: allOf: - $ref: '#/components/schemas/Money' description: Equivalente em USD. destination: allOf: - $ref: '#/components/schemas/Money' description: Valor em BRL. Money: type: object required: - currency - amount description: >- Valor monetário (saldos, extratos, custos). Pode ser zero. Para valores de requisição use PositiveMoney. properties: currency: type: string enum: - USD - BRL description: v1 suporta apenas USD e BRL. amount: type: string pattern: ^[0-9]+(\.[0-9]{1,2})?$ description: Decimal como string; nunca float binário. example: '1000.00' ApiError: type: object required: - code - message - requestId properties: code: type: string description: >- Código do catálogo `x-error-catalog`. Extensível: trate códigos desconhecidos pelo HTTP status. example: QUOTE_EXPIRED message: type: string requestId: type: string retryable: type: boolean description: >- Indica se a mesma requisição pode ser repetida (com a mesma Idempotency-Key). details: type: array items: type: object properties: field: type: string reason: type: string responses: NotFound: description: Recurso não encontrado no tenant autenticado content: application/json: schema: $ref: '#/components/schemas/ApiError' TooManyRequests: description: Limite de requisições excedido (RATE_LIMITED) headers: Retry-After: description: Segundos até nova tentativa schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.