Saltar al contenido principal
GET
Listar Transferencias

Autorizaciones

Authorization
string
header
requerido

Autenticación mediante token JWT Bearer. El tenantId se deriva del token bearer o del contexto autenticado de la solicitud y no se proporciona a través de X-Organization-Id.

Encabezados

X-Organization-Id
string<uuid>
requerido

Alcance de organización Midaz para la solicitud, utilizado para las llamadas posteriores a CRM, Fees y Midaz. Es obligatorio en las rutas de transferencia con alcance de organización en todos los modos de despliegue; un valor faltante o que no sea un UUID devuelve 400. Este no es el identificador del tenant — el tenantId se deriva del JWT bearer o del contexto autenticado, nunca de este header. Los workers en segundo plano (poller de TED IN, conciliación) no tienen header de solicitud y, en modo single-tenant, recurren a la variable de entorno ORGANIZATION_ID del despliegue.

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. Debe ser 0 o mayor.

Rango requerido: x >= 0
maxAmount
number<decimal>

El monto máximo de transferencia a incluir en los resultados. Este filtro no tiene límite superior.

Rango requerido: x >= 0
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.

items
object[]
requerido
pagination
object
requerido