Pular para o conteúdo principal
GET
Obter uma Transferência

Autorizações

Authorization
string
header
obrigatório

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.

Cabeçalhos

X-Organization-Id
string<uuid>
obrigatório

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.

Parâmetros de caminho

transferId
string<uuid>
obrigatório

O identificador único da transferência.

Resposta

Indica que a transferência foi encontrada e seus detalhes são retornados.

transferId
string<uuid>
obrigatório

O identificador único da transferência.

Exemplo:

"019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d"

type
enum<string>
obrigatório

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).

Opções disponíveis:
TED_OUT,
TED_IN,
P2P
Exemplo:

"TED_OUT"

status
enum<string>
obrigatório

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.

Opções disponíveis:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
REJECTED,
FAILED,
CANCELLED,
RECEIVED
Exemplo:

"COMPLETED"

senderAccountId
string<uuid>
obrigatório

UUID da conta do remetente. Sempre presente. Para TED IN, onde o remetente é um banco externo sem conta local, este é um identificador sintético derivado de forma determinística a partir do documento do remetente.

Exemplo:

"019c96a0-0c0c-7221-8cf3-13313fb60081"

recipient
object
obrigatório
amount
number<decimal>
obrigatório

O valor da transferência sem a tarifa.

Exemplo:

1000.5

feeAmount
number<decimal>
obrigatório

A tarifa cobrada por esta transferência.

Exemplo:

1.5

totalAmount
number<decimal>
obrigatório

O valor total, calculado como o valor da transferência mais a tarifa.

Exemplo:

1002

createdAt
string<date-time>
obrigatório

O timestamp de quando a transferência foi criada.

Exemplo:

"2026-02-01T15:30:00-03:00"

updatedAt
string<date-time>
obrigatório

O timestamp da última atualização de status.

Exemplo:

"2026-02-01T15:35:00-03:00"

statusHistory
object[]
obrigatório

O histórico de transições de status desta transferência.

originalTransferId
string<uuid> | null

Para devoluções TED IN, o ID da transferência de entrada original que está sendo devolvida.

Exemplo:

"019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d"

devolutionCode
string | null

Código BACEN do motivo da devolução, presente apenas quando a transferência é uma devolução.

Exemplo:

"18"

recipientAccountId
string<uuid> | null

UUID da conta do destinatário, quando o destinatário é representado como uma conta Midaz.

Exemplo:

"019c96a0-ac10-7efa-b1c2-2a3b4c5d6e7f"

confirmationNumber
string | null

O código de confirmação legível, se disponível.

Maximum string length: 20
Exemplo:

"20260201001"

controlNumber
string | null

O número de controle do JD SPB, presente para transferências TED OUT e TED IN.

Maximum string length: 20
Exemplo:

"202602010001"

midazTransactionId
string<uuid> | null

O ID da transação correspondente no ledger Midaz.

Exemplo:

"019c96a0-ac10-7efa-b1c2-2a3b4c5d6e7f"

description
string | null

A finalidade ou descrição da transferência.

Maximum string length: 140
Exemplo:

"Payment for services"

metadata
object | null

Metadados personalizados como pares chave-valor.

completedAt
string<date-time> | null

O timestamp de quando a transferência foi concluída. Nulo se ainda não concluída.

Exemplo:

"2026-02-01T15:35:00-03:00"