> ## 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. # List senders ## OpenAPI ````yaml api-reference/openapi.yaml GET /v1/senders 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/senders: get: tags: - Senders summary: Listar remetentes operationId: listSenders parameters: - name: externalId in: query schema: type: string - name: status in: query schema: type: string enum: - ACTIVE - RESTRICTED - BLOCKED - INACTIVE - $ref: '#/components/parameters/Cursor' - $ref: '#/components/parameters/Limit' responses: '200': description: Lista paginada content: application/json: schema: $ref: '#/components/schemas/SenderList' '429': $ref: '#/components/responses/TooManyRequests' components: parameters: Cursor: name: cursor in: query description: Cursor opaco retornado em `pagination.nextCursor`. schema: type: string Limit: name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 20 schemas: SenderList: type: object required: - data - pagination properties: data: type: array items: $ref: '#/components/schemas/Sender' pagination: $ref: '#/components/schemas/Pagination' Sender: type: object required: - senderId - externalId - type - status - complianceLevel - createdAt - updatedAt properties: senderId: type: string externalId: type: string type: type: string enum: - INDIVIDUAL - BUSINESS firstName: type: string middleName: type: string lastName: type: string businessName: type: string email: type: string phoneNumber: type: string birthDate: type: string format: date nationality: type: string address: $ref: '#/components/schemas/SenderAddress' documents: type: array items: $ref: '#/components/schemas/SenderDocument' occupation: type: string employerName: type: string sourceOfFunds: type: string status: type: string enum: - ACTIVE - RESTRICTED - BLOCKED - INACTIVE complianceLevel: type: string enum: - LEVEL_0 - LEVEL_1 - LEVEL_2 - LEVEL_3 description: >- LEVEL_0 não transaciona. Requisitos e limites por nível são configurados por cliente. createdAt: type: string format: date-time updatedAt: type: string format: date-time nextLevel: type: object nullable: true description: >- Próximo nível de compliance e dados que faltam para alcançá-lo. Nulo no nível máximo. properties: level: type: string enum: - LEVEL_1 - LEVEL_2 - LEVEL_3 missingRequirements: type: array items: type: string example: - occupation - documents.ssn Pagination: type: object required: - limit - hasMore properties: limit: type: integer hasMore: type: boolean nextCursor: type: string nullable: true description: Nulo quando não há mais páginas. 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 SenderAddress: type: object required: - countryCode - city - line1 - zipcode properties: countryCode: type: string pattern: ^[A-Z]{2}$ stateCode: type: string maxLength: 32 description: Obrigatório para US. city: type: string line1: type: string line2: type: string zipcode: type: string SenderDocument: type: object properties: type: type: string enum: - passport - drivers_license - id - consular_id - ssn - itin - ein - other documentLast4: type: string example: '5678' countryCode: type: string stateCode: type: string nullable: true expireDate: type: string format: date nullable: true verificationStatus: type: string enum: - NOT_VERIFIED - VERIFIED - REJECTED responses: 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.