> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Listar Transferências > Use este endpoint para recuperar uma lista paginada de transferências. Você pode filtrar por tipo, status, intervalo de datas e intervalo de valores. O limite padrão é de 50 itens, com máximo de 200. Retorna apenas transferências pertencentes à mesma organização. ## OpenAPI ````yaml pt/openapi/v3-current/ted.yaml get /v1/transfers openapi: 3.0.3 info: title: API do Plugin de Transferência Bancária (TED) description: >- API completa para transferências bancárias brasileiras (TED OUT, TED IN, P2P) através da plataforma Lerian, incluindo iniciação de transferências, processamento, acompanhamento de status e cancelamento. version: 1.1.9 servers: - url: https://ted.sandbox.lerian.net description: Sandbox (placeholder — ainda não disponível para acesso público) security: - BearerAuth: [] - OAuth2ClientCredentials: - api - OAuth2Password: - api tags: - name: Transfers API description: Endpoints para iniciar, processar, acompanhar e cancelar transferências. - name: Webhooks description: >- Endpoints para registrar e gerenciar assinaturas de webhook com escopo de tenant para eventos de transferência. - name: Webhook DLQ description: >- Endpoints para inspecionar e reprocessar mensagens da dead-letter queue de webhooks. paths: /v1/transfers: get: tags: - Transfers API summary: Listar Transferências description: >- Use este endpoint para recuperar uma lista paginada de transferências. Você pode filtrar por tipo, status, intervalo de datas e intervalo de valores. O limite padrão é de 50 itens, com máximo de 200. Retorna apenas transferências pertencentes à mesma organização. operationId: listTransfers parameters: - $ref: '#/components/parameters/XOrganizationId' - name: type in: query description: Filtrar resultados por tipo de transferência. schema: $ref: '#/components/schemas/TransferType' - name: status in: query description: Filtrar resultados por status da transferência. schema: $ref: '#/components/schemas/TransferStatus' - name: createdFrom in: query description: O início do filtro de intervalo de datas no formato RFC3339. schema: type: string format: date-time - name: createdTo in: query description: O fim do filtro de intervalo de datas no formato RFC3339. schema: type: string format: date-time - name: minAmount in: query description: >- O valor mínimo da transferência a ser incluído nos resultados. Deve ser 0 ou maior. schema: type: number format: decimal minimum: 0 - name: maxAmount in: query description: >- O valor máximo da transferência a ser incluído nos resultados. Este filtro não possui limite superior. schema: type: number format: decimal minimum: 0 - name: limit in: query description: Número máximo de transferências a retornar. schema: type: integer minimum: 1 maximum: 200 default: 50 - name: offset in: query description: Número de transferências a pular. schema: type: integer minimum: 0 default: 0 - name: sortDirection in: query description: Direção de ordenação para resultados ordenados por createdAt. schema: type: string enum: - asc - desc default: desc responses: '200': description: >- Indica que a solicitação foi bem-sucedida e as transferências correspondentes são retornadas. content: application/json: schema: $ref: '#/components/schemas/TransferList' examples: list: summary: Transferências paginadas value: items: - transferId: 019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d type: TED_OUT status: COMPLETED amount: 1000.5 feeAmount: 1.5 totalAmount: 1002 createdAt: '2026-02-01T15:30:00-03:00' updatedAt: '2026-02-01T15:35:00-03:00' - transferId: 019c96a0-ab20-7def-a1b2-1f2a3b4c5d6e type: TED_IN status: COMPLETED amount: 500 feeAmount: 0 totalAmount: 500 createdAt: '2026-02-01T16:00:00-03:00' updatedAt: '2026-02-01T16:05:00-03:00' pagination: limit: 50 offset: 0 returned: 2 totalCount: 2 hasNextPage: false '400': $ref: '#/components/responses/InvalidFilter' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimitExceeded' '500': $ref: '#/components/responses/InternalServerError' '503': $ref: '#/components/responses/ServiceUnavailable' components: parameters: XOrganizationId: name: X-Organization-Id in: header required: true description: >- Escopo da organização Midaz para a requisição, usado para chamadas downstream ao CRM, Fees e Midaz. Obrigatório nas rotas de transferência com escopo de organização em todos os modos de implantação; um valor ausente ou que não seja UUID retorna 400. Este não é o identificador do tenant — o tenantId é derivado do JWT bearer ou do contexto autenticado, nunca deste cabeçalho. Workers em segundo plano (poller de TED IN, conciliação) não possuem cabeçalho de requisição e, no modo single-tenant, recorrem à variável de ambiente `ORGANIZATION_ID` da implantação. schema: type: string format: uuid example: 019c96a0-0a98-7287-9a31-786e0809c769 schemas: TransferType: type: string enum: - TED_OUT - TED_IN - P2P description: >- O tipo de transferência. TED_OUT é uma transferência de saída para um banco externo via JD SPB. TED_IN é uma transferência de entrada de um banco externo. P2P é uma transferência ponto a ponto dentro da mesma instituição (mesmo ISPB). example: TED_OUT TransferStatus: type: string enum: - CREATED - PENDING - PROCESSING - COMPLETED - REJECTED - FAILED - CANCELLED - RECEIVED description: >- O status atual da transferência. Para TED OUT: CREATED → PENDING → PROCESSING → COMPLETED, REJECTED ou FAILED. Para P2P: CREATED → PROCESSING → COMPLETED ou FAILED (PENDING é um estado específico do SPB e não se aplica a P2P). Transferências podem ser canceladas (CANCELLED) enquanto estiverem com status CREATED ou PENDING. Para TED IN: RECEIVED → PROCESSING → COMPLETED ou FAILED. Um TED IN em status COMPLETED também pode transitar para FAILED em caso de estorno. example: COMPLETED TransferList: type: object required: - items - pagination properties: items: type: array items: $ref: '#/components/schemas/TransferSummary' pagination: $ref: '#/components/schemas/PaginationInfo' TransferSummary: type: object required: - transferId - type - status - amount - feeAmount - totalAmount - createdAt - updatedAt properties: transferId: type: string format: uuid example: 770e8400-e29b-41d4-a716-446655440003 type: $ref: '#/components/schemas/TransferType' status: $ref: '#/components/schemas/TransferStatus' originalTransferId: type: string format: uuid description: >- Para devoluções de TED IN, o ID da transferência de entrada original que está sendo devolvida. example: 770e8400-e29b-41d4-a716-446655440001 devolutionCode: type: string description: >- Código de motivo de devolução do BACEN, presente apenas quando a transferência é uma devolução. example: '18' amount: type: number format: decimal example: 1000.5 feeAmount: type: number format: decimal example: 1.5 totalAmount: type: number format: decimal description: O valor da transferência mais as tarifas (`amount + feeAmount`). example: 1002 createdAt: type: string format: date-time example: '2026-02-01T15:30:00Z' updatedAt: type: string format: date-time description: Timestamp da última transição de status desta transferência. example: '2026-02-01T15:35:00Z' PaginationInfo: type: object required: - limit - offset - returned - totalCount - hasNextPage properties: limit: type: integer description: Número máximo de transferências solicitadas. example: 50 offset: type: integer description: Número de transferências puladas. example: 0 returned: type: integer description: Número de transferências retornadas nesta resposta. example: 2 totalCount: type: integer minimum: 0 description: O número total de itens correspondentes. example: 123 hasNextPage: type: boolean description: Se há mais itens além da página atual. example: false ErrorResponse: type: object required: - error properties: error: type: object required: - code - service - category - message - requestId properties: code: type: string description: >- O código de erro estável. Erros do plugin usam o formato `BTF-XXXX`; rejeições de negócio/autenticação do JD SPB repassam o código bruto do fornecedor literalmente (por exemplo, `AAC90`, `ACE95`, `DVE01`), e falhas de transporte no nível do JD expõem os marcadores sintéticos `TRANSPORT` ou `JD_MISSING_CODE`. Faça a correspondência com base neste valor, e não no status HTTP. example: BTF-0010 service: type: string description: O serviço ou domínio que produziu o erro. example: plugin category: type: string description: >- Categoria de erro legível por máquina usada para decisões de reprocessamento. enum: - deterministic - transient - rate_limit - plugin example: deterministic message: type: string description: Um resumo do erro legível por humanos. example: >- Transferências só podem ser iniciadas de segunda a sexta entre 06:30 e 17:00 horário de Brasília requestId: type: string description: O ID de correlação da requisição. Presente mesmo quando vazio. example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: type: object additionalProperties: true description: >- Metadados estruturados de validação ou reprocessamento quando disponíveis. Detalhes de validação em nível de campo, cabeçalho, caminho e consulta são todos retornados aqui. example: currentTime: '2026-02-01T18:30:00-03:00' operatingHours: Mon-Fri 06:30-17:00 UTC-3 responses: InvalidFilter: description: Indica que um ou mais parâmetros de filtro são inválidos. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidDateRange: summary: Invalid date range value: error: code: BTF-0002 service: plugin category: deterministic message: Invalid filter parameters requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: createdTo: must be >= createdFrom Unauthorized: description: Indica que a requisição não possui um token de autenticação válido. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unauthorized: summary: Missing authorization value: error: code: BTF-0401 service: plugin category: deterministic message: Missing or invalid authentication token requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f Forbidden: description: >- Indica que o chamador está autenticado mas não tem permissão para esta operação, ou o tenant não está licenciado para este endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: notLicensed: summary: Tenant not licensed value: error: code: BTF-0403 service: plugin category: deterministic message: Tenant is not licensed to use this endpoint requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f permissionDenied: summary: Caller lacks permission value: error: code: BTF-0405 service: plugin category: deterministic message: Caller lacks permission for this resource requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f RateLimitExceeded: description: >- Indica que o limite de requisições foi excedido. Tente novamente após o número de segundos especificado no cabeçalho Retry-After. headers: Retry-After: description: Segundos até o limite de requisições ser redefinido schema: type: integer example: 60 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimitExceeded: summary: Too many requests value: error: code: BTF-0429 service: plugin category: rate_limit message: >- Too many requests. Retry after the interval indicated by the `Retry-After` header. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f description: > As respostas de rate-limit usam o código dedicado `BTF-0429` com a categoria `rate_limit`. Os clientes devem aplicar backoff usando o status HTTP `429` e o cabeçalho `Retry-After`. InternalServerError: description: Indica que ocorreu um erro interno inesperado. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internalError: summary: Internal error value: error: code: BTF-9000 service: plugin category: plugin message: Unexpected error while processing the request requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f ServiceUnavailable: description: >- Indica que um serviço externo (CRM, JD SPB, Midaz ou Fees) está temporariamente indisponível. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: crmUnavailable: summary: CRM service down value: error: code: BTF-0502 service: crm category: transient message: >- Unable to validate account. The CRM service is temporarily unavailable. Try again later. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f jdUnavailable: summary: JD SPB unavailable value: error: code: TRANSPORT service: jd_spb category: transient message: >- Unable to submit transfer. The JD SPB service is temporarily unavailable. Try again later. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f midazUnavailable: summary: Midaz ledger unavailable value: error: code: BTF-2000 service: midaz category: transient message: >- Unable to process transfer. The Midaz ledger service is temporarily unavailable. Try again later. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f feeServiceUnavailable: summary: Fee service unavailable (fail-closed mode) value: error: code: BTF-3000 service: fees category: transient message: >- Unable to calculate fee. The fee service is temporarily unavailable. Try again later. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f dlqInspectorUnavailable: summary: DLQ inspector not configured value: error: code: BTF-9005 service: plugin category: deterministic message: DLQ inspector is not configured requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Autenticação por token JWT Bearer. O tenantId é derivado do token bearer ou do contexto de requisição autenticado e não é fornecido por meio do X-Organization-Id. OAuth2ClientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: /v1/login/oauth/access_token scopes: api: Acesso à API de transferências TED OAuth2Password: type: oauth2 flows: password: tokenUrl: /v1/login/oauth/access_token scopes: api: Acesso à API de transferências TED ````