> ## 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. # Get a Transfer > Use this endpoint to retrieve the current status and details of a transfer, including its type, status history, sender and recipient details, amounts, and timestamps. Only returns transfers belonging to the same organization. ## OpenAPI ````yaml en/openapi/v3-current/ted.yaml get /v1/transfers/{transferId} 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/{transferId}: get: tags: - Transfers API summary: Get a Transfer description: >- Use this endpoint to retrieve the current status and details of a transfer, including its type, status history, sender and recipient details, amounts, and timestamps. Only returns transfers belonging to the same organization. operationId: getTransferStatus parameters: - $ref: '#/components/parameters/XOrganizationId' - name: transferId in: path required: true description: The unique identifier of the transfer. schema: type: string format: uuid responses: '200': description: Indicates that the transfer was found and its details are returned. content: application/json: schema: $ref: '#/components/schemas/Transfer' examples: tedOutCompleted: summary: TED OUT completed value: transferId: 019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d type: TED_OUT status: COMPLETED senderAccountId: 019c96a0-0c0c-7221-8cf3-13313fb60081 recipient: ispb: '00000000' branch: '0001' account: '1234567890' accountType: CACC holderName: Maria Santos holderDocument: '98765432100' amount: 1000.5 feeAmount: 1.5 totalAmount: 1002 confirmationNumber: '20260201001' controlNumber: '202602010001' createdAt: '2026-02-01T15:30:00-03:00' updatedAt: '2026-02-01T15:35:00-03:00' completedAt: '2026-02-01T15:35:00-03:00' statusHistory: - status: CREATED timestamp: '2026-02-01T15:30:00-03:00' reason: null - status: PENDING timestamp: '2026-02-01T15:30:05-03:00' reason: null - status: PROCESSING timestamp: '2026-02-01T15:30:10-03:00' reason: null - status: COMPLETED timestamp: '2026-02-01T15:35:00-03:00' reason: null tedInReceived: summary: TED IN received value: transferId: 019c96a0-ab20-7def-a1b2-1f2a3b4c5d6e type: TED_IN status: COMPLETED senderAccountId: 019c96a0-7e5a-7b3c-9d8e-2f1a0b3c4d5e recipient: ispb: '12345678' branch: '0001' account: '9876543210' accountType: CACC holderName: João Silva holderDocument: '12345678901' amount: 500 feeAmount: 0 totalAmount: 500 confirmationNumber: '20260201002' controlNumber: '202602010002' createdAt: '2026-02-01T16:00:00-03:00' updatedAt: '2026-02-01T16:00:05-03:00' completedAt: '2026-02-01T16:00:05-03:00' statusHistory: - status: RECEIVED timestamp: '2026-02-01T16:00:00-03:00' reason: null - status: COMPLETED timestamp: '2026-02-01T16:00:05-03:00' reason: null '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/TransferNotFound' '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: Transfer: type: object required: - transferId - type - status - senderAccountId - recipient - amount - feeAmount - totalAmount - createdAt - updatedAt - statusHistory properties: transferId: type: string format: uuid description: The unique identifier of the transfer. example: 019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d type: $ref: '#/components/schemas/TransferType' status: $ref: '#/components/schemas/TransferStatus' originalTransferId: type: string format: uuid nullable: true description: >- For TED IN devolutions, the ID of the original incoming transfer being returned. example: 019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d devolutionCode: type: string nullable: true description: >- BACEN devolution reason code, present only when the transfer is a devolution. example: '18' senderAccountId: type: string format: uuid description: >- UUID of the sender account. Always present. For TED IN, where the sender is an external bank with no local account, this is a synthetic identifier deterministically derived from the sender's document. example: 019c96a0-0c0c-7221-8cf3-13313fb60081 recipientAccountId: type: string format: uuid nullable: true description: >- UUID of the recipient account, when the recipient is represented as a Midaz account. example: 019c96a0-ac10-7efa-b1c2-2a3b4c5d6e7f recipient: $ref: '#/components/schemas/RecipientDetails' amount: type: number format: decimal description: The transfer amount without the fee. example: 1000.5 feeAmount: type: number format: decimal description: The fee charged for this transfer. example: 1.5 totalAmount: type: number format: decimal description: The total amount, calculated as the transfer amount plus the fee. example: 1002 confirmationNumber: type: string nullable: true maxLength: 20 description: The human-readable confirmation code, if available. example: '20260201001' controlNumber: type: string nullable: true maxLength: 20 description: The JD SPB control number, present for TED OUT and TED IN transfers. example: '202602010001' midazTransactionId: type: string format: uuid nullable: true description: The corresponding Midaz ledger transaction ID. example: 019c96a0-ac10-7efa-b1c2-2a3b4c5d6e7f description: type: string nullable: true maxLength: 140 description: The purpose or description of the transfer. example: Payment for services metadata: type: object nullable: true additionalProperties: true description: Custom metadata as key-value pairs. createdAt: type: string format: date-time description: The timestamp when the transfer was created. example: '2026-02-01T15:30:00-03:00' updatedAt: type: string format: date-time description: The timestamp of the last status update. example: '2026-02-01T15:35:00-03:00' completedAt: type: string format: date-time nullable: true description: >- The timestamp when the transfer was completed. Null if not yet completed. example: '2026-02-01T15:35:00-03:00' statusHistory: type: array description: The history of status transitions for this transfer. items: $ref: '#/components/schemas/StatusHistoryEntry' 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 RecipientDetails: type: object required: - ispb - account - holderDocument properties: ispb: type: string pattern: ^[0-9]{8}$ description: The 8-digit ISPB code identifying the recipient's bank. example: '00000000' branch: type: string pattern: ^[0-9]{4}$ description: The 4-digit branch code (agência). example: '0001' account: type: string pattern: ^[0-9]{1,20}$ description: The account number, from 1 to 20 digits. example: '1234567890' accountType: $ref: '#/components/schemas/AccountType' holderName: type: string minLength: 1 maxLength: 200 description: The full name of the account holder. example: Maria Santos holderDocument: type: string pattern: ^[0-9]{11}$|^[0-9]{14}$ description: >- The holder's document number. CPF (11 digits) for individuals or CNPJ (14 digits) for companies. example: '12345678901' StatusHistoryEntry: type: object required: - status - timestamp properties: status: $ref: '#/components/schemas/TransferStatus' timestamp: type: string format: date-time example: '2026-02-01T15:30:00-03:00' reason: type: string nullable: true maxLength: 500 description: The reason for the status change, if applicable. example: JD timeout after 3 retries 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 AccountType: type: string description: >- The account type following ISO 20022 codes. Known values include: CACC is a current account (Conta Corrente), SLRY is a salary account (Conta Salário), SVGS is a savings account (Conta Poupança), TRAN is a transactional account (Conta de Pagamento), and OTHR is any other account type. example: CACC responses: BadRequest: description: >- Indicates that the request contains invalid input. Check the field details for specific validation errors. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidInput: summary: Validation error value: error: code: BTF-0001 service: plugin category: deterministic message: >- The request contains invalid fields. Check the field details below. requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: recipientIspb: must be 8 digits amount: must be positive 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 TransferNotFound: description: >- Indicates that the transfer was not found or belongs to a different organization. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: transferNotFound: summary: Transfer ID invalid value: error: code: BTF-0200 service: plugin category: deterministic message: Transfer not found 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 ````