Pular para o conteúdo principal
GET
/
v1
/
transfers
/
{transferId}
Obter uma Transferência
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/{transferId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant-Id: <x-tenant-id>'
{
  "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
    }
  ]
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticação por token JWT Bearer. O token deve incluir uma claim tenantId que corresponda ao cabeçalho X-Tenant-Id.

Cabeçalhos

​
X-Tenant-Id
string<uuid>
obrigatório

ID da organização usado como identificador do tenant. Todos os dados são limitados a esta organização. Deve corresponder à claim tenantId do JWT quando a autenticação está habilitada.

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> | null
obrigatório

UUID da conta do remetente. Pode ser nulo para transferências TED_IN onde o remetente é externo.

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

​
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

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"