Pular para o conteúdo principal
GET
/
v1
/
transfers
Listar Transferências
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant-Id: <x-tenant-id>'
{
  "data": [
    {
      "transferId": "019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d",
      "type": "TED_OUT",
      "status": "COMPLETED",
      "amount": 1000.5,
      "feeAmount": 1.5,
      "recipientHolderName": "Maria Santos",
      "createdAt": "2026-02-01T15:30:00-03:00"
    },
    {
      "transferId": "019c96a0-ab20-7def-a1b2-1f2a3b4c5d6e",
      "type": "TED_IN",
      "status": "COMPLETED",
      "amount": 500,
      "feeAmount": 0,
      "recipientHolderName": "João Silva",
      "createdAt": "2026-02-01T16:00:00-03:00"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "returned": 2,
    "totalCount": 2,
    "hasNextPage": false
  }
}

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 consulta

​
type
enum<string>

Filtrar resultados por tipo de transferência. 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>

Filtrar resultados por status da transferência. 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"

​
createdFrom
string<date-time>

O início do filtro de intervalo de datas no formato RFC3339.

​
createdTo
string<date-time>

O fim do filtro de intervalo de datas no formato RFC3339.

​
minAmount
number<decimal>

O valor mínimo da transferência a ser incluído nos resultados.

Intervalo obrigatório: x >= 0.01
​
maxAmount
number<decimal>

O valor máximo da transferência a ser incluído nos resultados.

Intervalo obrigatório: x <= 999999.99
​
limit
integer
padrão:50

Número máximo de transferências a retornar.

Intervalo obrigatório: 1 <= x <= 200
​
offset
integer
padrão:0

Número de transferências a pular.

Intervalo obrigatório: x >= 0
​
sortDirection
enum<string>
padrão:desc

Direção de ordenação para resultados ordenados por createdAt.

Opções disponíveis:
asc,
desc

Resposta

Indica que a solicitação foi bem-sucedida e as transferências correspondentes são retornadas.

​
data
object[]
obrigatório
​
pagination
object
obrigatório