> ## 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. # Iniciar uma Transferência > Use este endpoint para iniciar uma transferência validando os dados do remetente, verificando horários de funcionamento e limites de uso, detectando duplicatas e calculando a tarifa. Nenhum fundo é retido nesta etapa. O `initiationId` retornado é válido por 24 horas e deve ser confirmado através do endpoint Processar Transferência. Use o cabeçalho `X-Idempotency` para garantir a deduplicação. ## OpenAPI ````yaml pt/openapi/v3-current/ted.yaml post /v1/transfers/initiate 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/initiate: post: tags: - Transfers API summary: Iniciar uma Transferência description: >- Use este endpoint para iniciar uma transferência validando os dados do remetente, verificando horários de funcionamento e limites de uso, detectando duplicatas e calculando a tarifa. Nenhum fundo é retido nesta etapa. O `initiationId` retornado é válido por 24 horas e deve ser confirmado através do endpoint Processar Transferência. Use o cabeçalho `X-Idempotency` para garantir a deduplicação. operationId: initiateTransfer parameters: - $ref: '#/components/parameters/XOrganizationId' - $ref: '#/components/parameters/XIdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InitiateTransferRequest' examples: tedOut: summary: TED OUT para banco externo value: senderAccountId: 019c96a0-0c0c-7221-8cf3-13313fb60081 recipient: ispb: '00000000' branch: '0001' account: '1234567890' accountType: CACC holderName: João Silva holderDocument: '12345678901' amount: 1000.5 description: Payment for services metadata: invoiceId: INV-2024-001 p2p: summary: P2P (mesma instituição) value: senderAccountId: 019c96a0-0c0c-7221-8cf3-13313fb60081 recipient: ispb: '12345678' branch: '0001' account: '9876543210' accountType: CACC holderName: Maria Santos holderDocument: '98765432100' amount: 500 description: Transfer to friend responses: '200': description: >- Indica que a transferência foi iniciada com sucesso e está aguardando confirmação. Chamadas repetidas com a mesma chave `X-Idempotency` reproduzem a resposta em cache. Consulte [Tentativas e idempotência](/pt/reference/retries-idempotency) para mais detalhes. content: application/json: schema: $ref: '#/components/schemas/InitiateTransferResponse' examples: success: summary: Iniciação com tarifa value: initiationId: 019c96a0-aa10-7abc-d1e2-8c9d0e1f2a3b feeAmount: 1.5 totalAmount: 1002 estimatedCompletionAt: '2026-02-01T18:00:00-03:00' expiresAt: '2026-02-02T15:30:00-03:00' status: PENDING_CONFIRMATION freeTransfer: summary: Sem tarifa configurada value: initiationId: 019c96a0-aa20-7bcd-e1f2-9d0e1f2a3b4c feeAmount: 0 totalAmount: 1000.5 estimatedCompletionAt: '2026-02-01T18:00:00-03:00' expiresAt: '2026-02-02T15:30:00-03:00' status: PENDING_CONFIRMATION '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/AccountNotFound' '409': $ref: '#/components/responses/DuplicateTransfer' '422': $ref: '#/components/responses/OperatingHoursViolation' '429': $ref: '#/components/responses/RateLimitExceeded' '500': $ref: '#/components/responses/InternalServerError' '502': $ref: '#/components/responses/BadGateway' '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 XIdempotencyKey: name: X-Idempotency in: header required: true description: >- Chave de idempotência obrigatória para tentativas seguras. Use um UUID v4 ou identificador de negócio único. Se a mesma chave for enviada novamente e a solicitação original já tiver sido processada, a resposta em cache será retornada. Consulte [Tentativas e idempotência](/pt/reference/retries-idempotency) para detalhes. schema: type: string maxLength: 255 example: 019c96a0-aa10-7abc-d1e2-8c9d0e1f2a3b schemas: InitiateTransferRequest: type: object required: - senderAccountId - recipient - amount - purpose properties: senderAccountId: type: string format: uuid description: O ID da conta Midaz do remetente. example: 019c96a0-0c0c-7221-8cf3-13313fb60081 recipient: $ref: '#/components/schemas/RecipientDetails' amount: type: number format: decimal minimum: 0.01 maximum: 999999.99 description: O valor da transferência em BRL. example: 1000.5 purpose: type: string pattern: ^[0-9]{1,4}$ maxLength: 4 description: > Código FinlddCli do SPB do BACEN que identifica a finalidade da transferência. Deve conter entre 1 e 4 dígitos ASCII. Códigos FinlddCli comuns: * `1` — Pagamento de Impostos, Tributos e Taxas * `3` — Pagamentos de Dividendos * `10` — Crédito em Conta * `100` — Depósito Judicial Consulte o _Dicionário de Domínios_ (`FinlddCli`) do BACEN para a tabela completa de códigos ativos. **Nota:** o plugin atualmente aceita valores de FinlddCli de até 4 dígitos. Códigos de 5 dígitos do catálogo BACEN (como `99999` — _Outros_) ainda não são suportados e retornarão um erro de validação. example: '10' description: type: string maxLength: 140 description: Descrição em texto livre da transferência. example: Payment for services metadata: type: object additionalProperties: true description: Metadados personalizados como pares chave-valor. example: invoiceId: INV-2024-001 orderId: ORD-2024-123 InitiateTransferResponse: type: object required: - initiationId - feeAmount - totalAmount - estimatedCompletionAt - expiresAt - status properties: initiationId: type: string format: uuid description: >- O ID de iniciação único. Use este valor no endpoint Processar Transferência para confirmar a transferência. example: 019c96a0-aa10-7abc-d1e2-8c9d0e1f2a3b feeAmount: type: number format: decimal description: >- O valor da tarifa calculada. Retorna 0.00 se as tarifas estiverem desabilitadas para esta organização. example: 1.5 totalAmount: type: number format: decimal description: >- O valor total, calculado como o valor da transferência mais a tarifa. example: 1002 estimatedCompletionAt: type: string format: date-time description: O horário estimado de conclusão da transferência. example: '2026-02-01T18:00:00-03:00' expiresAt: type: string format: date-time description: O horário em que esta iniciação expira, 24 horas após a criação. example: '2026-02-02T15:30:00-03:00' status: $ref: '#/components/schemas/InitiationStatus' feeEntries: type: array description: >- Detalhamento das tarifas cobradas. Cada entrada corresponde a uma tarifa aplicada durante a transferência. items: type: object properties: label: type: string description: Identificador da tarifa. example: ted_transfer_fee amount: type: number format: decimal description: Valor da tarifa. example: 1.5 creditAccount: type: string description: Conta que recebe o crédito da tarifa. example: platform-fee-account sourceAccount: type: string description: Conta debitada pela tarifa. example: sender-account isDeductible: type: boolean description: >- Se a tarifa é deduzida do valor da transferência (true) ou adicionada por cima (false). example: false packageAppliedId: type: string format: uuid nullable: true description: ID do pacote de tarifas aplicado a esta transferência, se houver. example: 019c96a0-ad10-7fab-c1d2-3b4c5d6e7f8a RecipientDetails: type: object required: - ispb - account - holderDocument properties: ispb: type: string pattern: ^[0-9]{8}$ description: O código ISPB de 8 dígitos que identifica o banco do destinatário. example: '00000000' branch: type: string pattern: ^[0-9]{4}$ description: O código da agência de 4 dígitos. example: '0001' account: type: string pattern: ^[0-9]{1,20}$ description: O número da conta, de 1 a 20 dígitos. example: '1234567890' accountType: $ref: '#/components/schemas/AccountType' holderName: type: string minLength: 1 maxLength: 200 description: O nome completo do titular da conta. example: Maria Santos holderDocument: type: string pattern: ^[0-9]{11}$|^[0-9]{14}$ description: >- O número do documento do titular. CPF (11 dígitos) para pessoas físicas ou CNPJ (14 dígitos) para empresas. example: '12345678901' InitiationStatus: type: string enum: - PENDING_CONFIRMATION - PROCESSED - EXPIRED description: >- O status da iniciação. PENDING_CONFIRMATION indica que a iniciação está aguardando confirmação através do endpoint Processar Transferência. PROCESSED indica que uma transferência foi criada. EXPIRED indica que a iniciação expirou após 24 horas. example: PENDING_CONFIRMATION 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 AccountType: type: string description: >- O tipo de conta seguindo os códigos ISO 20022. Os valores conhecidos incluem: CACC é uma conta corrente, SLRY é uma conta salário, SVGS é uma conta poupança, TRAN é uma conta de pagamento, e OTHR é qualquer outro tipo de conta. example: CACC responses: BadRequest: description: >- Indica que a requisição contém entrada inválida. Verifique os detalhes do campo para erros de validação específicos. 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: 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 AccountNotFound: description: Indica que a conta do remetente não foi encontrada no CRM. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: accountNotFound: summary: Invalid sender account value: error: code: BTF-0500 service: crm category: deterministic message: Sender account does not exist in CRM requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f DuplicateTransfer: description: >- Indica que uma transferência idêntica foi detectada dentro da janela de deduplicação de 60 segundos. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: duplicate: summary: Same transfer submitted twice value: error: code: BTF-0012 service: plugin category: deterministic message: Identical transfer submitted 15 seconds ago requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: originalTransferId: 019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d detectedAt: '2026-02-01T15:30:15-03:00' OperatingHoursViolation: description: >- Indica que a transferência foi tentada fora do horário de funcionamento do BACEN (segunda a sexta, 06:30-17:00 horário de Brasília). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: outsideHours: summary: After 17:00 value: error: code: BTF-0010 service: plugin category: deterministic message: >- Transfers can only be initiated Monday-Friday between 06:30 and 17:00 Brasília time requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: currentTime: '2026-02-01T18:30:00-03:00' nextAvailableTime: '2026-02-03T06:30:00-03:00' 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 BadGateway: description: >- Indica que o JD SPB rejeitou a requisição na camada de autenticação ou configuração (certificado de assinatura, credenciais ou configuração). O código bruto do fornecedor JD (AAC*, AAE*) é repassado literalmente no campo `code`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: jdAuthRejected: summary: JD SPB auth rejection value: error: code: AAC90 service: jd_spb category: deterministic message: JD SPB rejected the signing certificate or credentials 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 ````