> ## 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. # List Transfers > Use this endpoint to retrieve a paginated list of transfers. You can filter by type, status, date range, and amount range. The default limit is 50 items, with a maximum of 200. Only returns transfers belonging to the same organization. ## OpenAPI ````yaml en/openapi/v3-current/ted.yaml get /v1/transfers openapi: 3.0.3 info: title: Bank Transfer (TED) Plugin API description: >- Complete API for Brazilian bank transfers (TED OUT, TED IN, P2P) through the Lerian platform, including transfer initiation, processing, status tracking, and cancellation. version: 1.1.9 servers: - url: https://ted.sandbox.lerian.net description: Sandbox (placeholder — not yet available for public access) security: - BearerAuth: [] - OAuth2ClientCredentials: - api - OAuth2Password: - api tags: - name: Transfers API description: Endpoints for initiating, processing, tracking, and cancelling transfers. - name: Webhooks description: >- Endpoints for registering and managing tenant-scoped webhook subscriptions for transfer events. - name: Webhook DLQ description: Endpoints for inspecting and retrying webhook dead-letter queue messages. paths: /v1/transfers: get: tags: - Transfers API summary: List Transfers description: >- Use this endpoint to retrieve a paginated list of transfers. You can filter by type, status, date range, and amount range. The default limit is 50 items, with a maximum of 200. Only returns transfers belonging to the same organization. operationId: listTransfers parameters: - $ref: '#/components/parameters/XOrganizationId' - name: type in: query description: Filter results by transfer type. schema: $ref: '#/components/schemas/TransferType' - name: status in: query description: Filter results by transfer status. schema: $ref: '#/components/schemas/TransferStatus' - name: createdFrom in: query description: The start of the date range filter in RFC3339 format. schema: type: string format: date-time - name: createdTo in: query description: The end of the date range filter in RFC3339 format. schema: type: string format: date-time - name: minAmount in: query description: >- The minimum transfer amount to include in the results. Must be 0 or greater. schema: type: number format: decimal minimum: 0 - name: maxAmount in: query description: >- The maximum transfer amount to include in the results. This filter has no upper bound. schema: type: number format: decimal minimum: 0 - name: limit in: query description: Maximum number of transfers to return. schema: type: integer minimum: 1 maximum: 200 default: 50 - name: offset in: query description: Number of transfers to skip. schema: type: integer minimum: 0 default: 0 - name: sortDirection in: query description: Sort direction for results ordered by createdAt. schema: type: string enum: - asc - desc default: desc responses: '200': description: >- Indicates that the request was successful and the matching transfers are returned. content: application/json: schema: $ref: '#/components/schemas/TransferList' examples: list: summary: Paginated transfers 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: >- Midaz organization scope for the request, used for downstream CRM, Fees, and Midaz calls. Required on org-scoped transfer routes in every deployment mode; a missing or non-UUID value returns 400. This is not the tenant identifier — tenantId is derived from the bearer JWT or authenticated context, never from this header. Background workers (TED IN poller, reconciliation) have no request header and, in single-tenant mode, fall back to the deployment's `ORGANIZATION_ID` env. schema: type: string format: uuid example: 019c96a0-0a98-7287-9a31-786e0809c769 schemas: TransferType: type: string enum: - TED_OUT - TED_IN - P2P description: >- The type of transfer. TED_OUT is an outgoing transfer to an external bank via JD SPB. TED_IN is an incoming transfer from an external bank. P2P is a peer-to-peer transfer within the same institution (same ISPB). example: TED_OUT TransferStatus: type: string enum: - CREATED - PENDING - PROCESSING - COMPLETED - REJECTED - FAILED - CANCELLED - RECEIVED description: >- The current status of the transfer. For TED OUT: CREATED → PENDING → PROCESSING → COMPLETED, REJECTED, or FAILED. For P2P: CREATED → PROCESSING → COMPLETED or FAILED (PENDING is an SPB-specific state and does not apply to P2P). Transfers can be CANCELLED while in CREATED or PENDING status. For TED IN: RECEIVED → PROCESSING → COMPLETED or FAILED. A COMPLETED TED IN can also transition to FAILED in the event of a chargeback. 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: >- For TED IN devolutions, the ID of the original incoming transfer being returned. example: 770e8400-e29b-41d4-a716-446655440001 devolutionCode: type: string description: >- BACEN devolution reason code, present only when the transfer is a devolution. example: '18' amount: type: number format: decimal example: 1000.5 feeAmount: type: number format: decimal example: 1.5 totalAmount: type: number format: decimal description: The transfer amount plus fees (`amount + feeAmount`). example: 1002 createdAt: type: string format: date-time example: '2026-02-01T15:30:00Z' updatedAt: type: string format: date-time description: Timestamp of the last status transition for this transfer. example: '2026-02-01T15:35:00Z' PaginationInfo: type: object required: - limit - offset - returned - totalCount - hasNextPage properties: limit: type: integer description: Maximum number of transfers requested. example: 50 offset: type: integer description: Number of transfers skipped. example: 0 returned: type: integer description: Number of transfers returned in this response. example: 2 totalCount: type: integer minimum: 0 description: The total number of matching items. example: 123 hasNextPage: type: boolean description: Whether there are more items beyond the current page. example: false ErrorResponse: type: object required: - error properties: error: type: object required: - code - service - category - message - requestId properties: code: type: string description: >- The stable error code. Plugin errors use the `BTF-XXXX` format; JD SPB business/auth rejections pass through the raw vendor code verbatim (e.g. `AAC90`, `ACE95`, `DVE01`), and transport-level JD failures surface the synthetic markers `TRANSPORT` or `JD_MISSING_CODE`. Match on this value rather than on the HTTP status. example: BTF-0010 service: type: string description: The service or domain that produced the error. example: plugin category: type: string description: Machine-readable error category used for retry decisions. enum: - deterministic - transient - rate_limit - plugin example: deterministic message: type: string description: A human-readable error summary. example: >- Transfers can only be initiated Monday-Friday between 06:30 and 17:00 Brasília time requestId: type: string description: The request correlation ID. Present even when empty. example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: type: object additionalProperties: true description: >- Structured validation or retry metadata when available. Field-level, header, path, and query validation details are all returned here. example: currentTime: '2026-02-01T18:30:00-03:00' operatingHours: Mon-Fri 06:30-17:00 UTC-3 responses: InvalidFilter: description: Indicates that one or more filter parameters are invalid. 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: Indicates that the request is missing a valid authentication token. 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: >- Indicates that the caller is authenticated but lacks permission for this operation, or the tenant is not licensed for this 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: >- Indicates that the rate limit has been exceeded. Retry after the number of seconds specified in the Retry-After header. headers: Retry-After: description: Seconds until rate limit resets 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: > Rate-limit responses use the dedicated `BTF-0429` code with the `rate_limit` category. Clients should back off using the HTTP status `429` and the `Retry-After` header. InternalServerError: description: Indicates that an unexpected internal error occurred. 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: >- Indicates that an external service (CRM, JD SPB, Midaz, or Fees) is temporarily unavailable. 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: >- JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id. OAuth2ClientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: /v1/login/oauth/access_token scopes: api: TED transfer API access OAuth2Password: type: oauth2 flows: password: tokenUrl: /v1/login/oauth/access_token scopes: api: TED transfer API access ````