Saltar al contenido principal
GET
/
v1
/
transfers
Listar Transferencias
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
  }
}

Autorizaciones

​
Authorization
string
header
requerido

Autenticación mediante token JWT Bearer. El token debe incluir un claim tenantId que coincida con el encabezado X-Tenant-Id.

Encabezados

​
X-Tenant-Id
string<uuid>
requerido

ID de organización utilizado como identificador de inquilino. Todos los datos están limitados a esta organización. Debe coincidir con el claim tenantId del JWT cuando la autenticación está habilitada.

Parámetros de consulta

​
type
enum<string>

Filtrar resultados por tipo de transferencia. El tipo de transferencia. TED_OUT es una transferencia saliente a un banco externo a través de JD SPB. TED_IN es una transferencia entrante de un banco externo. P2P es una transferencia entre pares dentro de la misma institución (mismo ISPB).

Opciones disponibles:
TED_OUT,
TED_IN,
P2P
Ejemplo:

"TED_OUT"

​
status
enum<string>

Filtrar resultados por estado de transferencia. El estado actual de la transferencia. Para TED OUT: CREATED → PENDING → PROCESSING → COMPLETED, REJECTED o FAILED. Para P2P: CREATED → PROCESSING → COMPLETED o FAILED (PENDING es un estado específico de SPB y no se aplica a P2P). Las transferencias pueden ser canceladas (CANCELLED) mientras están en estado CREATED o PENDING. Para TED IN: RECEIVED → PROCESSING → COMPLETED o FAILED. Un TED IN en estado COMPLETED también puede pasar a FAILED en caso de contracargo.

Opciones disponibles:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
REJECTED,
FAILED,
CANCELLED,
RECEIVED
Ejemplo:

"COMPLETED"

​
createdFrom
string<date-time>

El inicio del filtro de rango de fechas en formato RFC3339.

​
createdTo
string<date-time>

El fin del filtro de rango de fechas en formato RFC3339.

​
minAmount
number<decimal>

El monto mínimo de transferencia a incluir en los resultados.

Rango requerido: x >= 0.01
​
maxAmount
number<decimal>

El monto máximo de transferencia a incluir en los resultados.

Rango requerido: x <= 999999.99
​
limit
integer
predeterminado:50

Número máximo de transferencias a retornar.

Rango requerido: 1 <= x <= 200
​
offset
integer
predeterminado:0

Número de transferencias a omitir.

Rango requerido: x >= 0
​
sortDirection
enum<string>
predeterminado:desc

Dirección de ordenamiento para resultados ordenados por createdAt.

Opciones disponibles:
asc,
desc

Respuesta

Indica que la solicitud fue exitosa y se devuelven las transferencias coincidentes.

​
data
object[]
requerido
​
pagination
object
requerido