> ## 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.

# Request a quote

> 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édito e saldo PREFUNDED são verificados na criação da remessa (POST /v1/remittances/withdrawals). Uma cotação pode ser usada por uma única remessa.

Com `usage = INVENTORY` a cotação é usada uma única vez para criar um Inventory Lot (POST /v1/inventories) e não pode ser usada em withdrawal; a resposta informa `inventoryExpiresAt`, a validade que o lote terá se for criado. Cotações sem `usage` são `REMITTANCE` e mantêm o comportamento atual.



## OpenAPI

````yaml api-reference/openapi.yaml POST /v1/fx/quotes
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=<hex(HMAC-SHA256(signingSecret, timestamp + "." +
    rawBody))>`. 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/fx/quotes:
    post:
      tags:
        - FX Quotes
      summary: Request an FX quote
      description: >-
        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édito e saldo PREFUNDED são verificados na criação
        da remessa (POST /v1/remittances/withdrawals). Uma cotação pode ser
        usada por uma única remessa.


        Com `usage = INVENTORY` a cotação é usada uma única vez para criar um
        Inventory Lot (POST /v1/inventories) e não pode ser usada em withdrawal;
        a resposta informa `inventoryExpiresAt`, a validade que o lote terá se
        for criado. Cotações sem `usage` são `REMITTANCE` e mantêm o
        comportamento atual.
      operationId: createFxQuote
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQuoteRequest'
            examples:
              fixedSource:
                summary: MSB envia USD 1.000
                value:
                  fromCurrency: USD
                  toCurrency: BRL
                  sourceAmount: '1000.00'
              fixedDestination:
                summary: Beneficiário recebe BRL 5.000
                value:
                  fromCurrency: USD
                  toCurrency: BRL
                  destinationAmount: '5000.00'
              inventory:
                summary: Cotação para contratar USD 100.000 de inventory
                value:
                  fromCurrency: USD
                  toCurrency: BRL
                  sourceAmount: '100000.00'
                  usage: INVENTORY
      responses:
        '201':
          description: Quote created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FxQuote'
        '400':
          $ref: '#/components/responses/BadRequest'
        '422':
          $ref: '#/components/responses/BusinessRuleViolation'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: Unique key to prevent duplicate creation or execution.
      schema:
        type: string
        minLength: 8
        maxLength: 128
  schemas:
    CreateQuoteRequest:
      type: object
      required:
        - fromCurrency
        - toCurrency
      description: >-
        Informe exatamente um entre `sourceAmount` (valor fixo em
        `fromCurrency`, enviado pela MSB) e `destinationAmount` (valor fixo em
        `toCurrency`, recebido pelo beneficiário).
      properties:
        fromCurrency:
          type: string
          enum:
            - USD
          description: 'v1: apenas USD.'
        toCurrency:
          type: string
          enum:
            - BRL
          description: 'v1: apenas BRL.'
        sourceAmount:
          $ref: '#/components/schemas/PositiveAmount'
        destinationAmount:
          $ref: '#/components/schemas/PositiveAmount'
        usage:
          $ref: '#/components/schemas/QuoteUsage'
      oneOf:
        - required:
            - sourceAmount
        - required:
            - destinationAmount
    FxQuote:
      type: object
      required:
        - quoteId
        - status
        - fromCurrency
        - toCurrency
        - source
        - destination
        - referenceRate
        - rate
        - spread
        - expiresAt
        - createdAt
      description: >-
        Preço único para a remessa, igual para PREFUNDED e CREDIT. O valor
        recebido pelo beneficiário (destination) não depende da modalidade de
        funding. A única tarifa é o spread: rate = referenceRate × (1 −
        spread.percentage / 100).
      properties:
        quoteId:
          type: string
          example: qt_01J9Z3
        status:
          type: string
          enum:
            - AVAILABLE
            - USED
            - EXPIRED
          description: >-
            AVAILABLE: pode ser usada até expiresAt. USED: consumida por uma
            remessa (REMITTANCE) ou por um Inventory Lot (INVENTORY). EXPIRED:
            venceu sem uso.
        fromCurrency:
          type: string
          enum:
            - USD
        toCurrency:
          type: string
          enum:
            - BRL
        source:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Valor em USD enviado pela MSB.
          example:
            currency: USD
            amount: '1000.00'
        destination:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Valor exato em BRL que o beneficiário recebe.
          example:
            currency: BRL
            amount: '5383.20'
        referenceRate:
          allOf:
            - $ref: '#/components/schemas/Rate'
          description: Taxa de referência de mercado sobre a qual o spread é calculado.
          example: '5.44000000'
        rate:
          allOf:
            - $ref: '#/components/schemas/Rate'
          description: Taxa aplicada à remessa, já com o spread.
          example: '5.39920000'
        spread:
          $ref: '#/components/schemas/FxSpread'
        expiresAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
        remittanceId:
          type: string
          nullable: true
          description: Remessa que usou a cotação; preenchido quando status = USED.
        externalId:
          type: string
          nullable: true
          description: externalId da remessa ou do Inventory que usou a cotação.
        usage:
          $ref: '#/components/schemas/QuoteUsage'
        inventoryId:
          type: string
          nullable: true
          description: >-
            Inventory Lot criado a partir da cotação; preenchido quando usage =
            INVENTORY e status = USED.
        inventoryExpiresAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            Somente usage = INVENTORY. Validade que o Inventory Lot terá se for
            criado com esta cotação. Não confundir com expiresAt, que é a
            validade da própria cotação.
    PositiveAmount:
      type: string
      pattern: ^(0\.(0[1-9]|[1-9][0-9]?)|[1-9][0-9]*(\.[0-9]{1,2})?)$
      description: Decimal como string, estritamente maior que zero.
      example: '1000.00'
    QuoteUsage:
      type: string
      enum:
        - REMITTANCE
        - INVENTORY
      default: REMITTANCE
      description: >-
        Uso da cotação. REMITTANCE (padrão): usada por um withdrawal. INVENTORY:
        usada para criar um Inventory Lot (POST /v1/inventories). Usar a cotação
        na operação errada retorna QUOTE_USAGE_MISMATCH. Enum extensível.
    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'
    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'
    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:
    BadRequest:
      description: Requisição inválida (VALIDATION_ERROR)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    BusinessRuleViolation:
      description: Requisição rejeitada por regra de negócio
      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.