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

# Limites do beneficiário

> Limite de recebimento, utilizado e disponível do beneficiário nas janelas de 24h, 30d e 180d.



## OpenAPI

````yaml api-reference/openapi.yaml GET /v1/limits/beneficiaries/{beneficiaryId}
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/limits/beneficiaries/{beneficiaryId}:
    parameters:
      - name: beneficiaryId
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Limits
      summary: Limites do beneficiário
      description: >-
        Limite de recebimento, utilizado e disponível do beneficiário nas
        janelas de 24h, 30d e 180d.
      operationId: getBeneficiaryLimits
      responses:
        '200':
          description: Limites do beneficiário
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryLimits'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    BeneficiaryLimits:
      type: object
      required:
        - beneficiaryId
        - windows
        - checkedAt
      description: >-
        Limites de recebimento do beneficiário por janela móvel, somando todos
        os remetentes. Valores em USD equivalentes.
      properties:
        beneficiaryId:
          type: string
        windows:
          type: array
          items:
            $ref: '#/components/schemas/LimitWindow'
        checkedAt:
          type: string
          format: date-time
    LimitWindow:
      type: object
      required:
        - window
        - limit
        - used
        - available
      description: >-
        Limite em USD (fromCurrency). Janelas de 24h, 30d e 180d são móveis;
        DAILY é o dia corrente da conta.
      properties:
        window:
          type: string
          enum:
            - DAILY
            - 24H
            - 30D
            - 180D
        limit:
          $ref: '#/components/schemas/Money'
        used:
          $ref: '#/components/schemas/Money'
        available:
          $ref: '#/components/schemas/Money'
        resetsAt:
          type: string
          format: date-time
          nullable: true
          description: Preenchido para DAILY.
    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
    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'
  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.