Saltar al contenido principal
GET
Obtener una Transferencia

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 ruta

transferId
string<uuid>
requerido

El identificador único de la transferencia.

Respuesta

Indica que la transferencia fue encontrada y se devuelven sus detalles.

transferId
string<uuid>
requerido

El identificador único de la transferencia.

Ejemplo:

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

type
enum<string>
requerido

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>
requerido

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"

senderAccountId
string<uuid>
requerido

UUID de la cuenta del remitente. Siempre presente. Para TED IN, donde el remitente es un banco externo sin cuenta local, este es un identificador sintético derivado de forma determinística del documento del remitente.

Ejemplo:

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

recipient
object
requerido
amount
number<decimal>
requerido

El monto de la transferencia sin la tarifa.

Ejemplo:

1000.5

feeAmount
number<decimal>
requerido

La tarifa cobrada por esta transferencia.

Ejemplo:

1.5

totalAmount
number<decimal>
requerido

El monto total, calculado como el monto de la transferencia más la tarifa.

Ejemplo:

1002

createdAt
string<date-time>
requerido

La marca de tiempo de cuando se creó la transferencia.

Ejemplo:

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

updatedAt
string<date-time>
requerido

La marca de tiempo de la última actualización de estado.

Ejemplo:

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

statusHistory
object[]
requerido

El historial de transiciones de estado de esta transferencia.

originalTransferId
string<uuid> | null

Para devoluciones TED IN, el ID de la transferencia entrante original que se está devolviendo.

Ejemplo:

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

devolutionCode
string | null

Código BACEN de motivo de devolución, presente solo cuando la transferencia es una devolución.

Ejemplo:

"18"

recipientAccountId
string<uuid> | null

UUID de la cuenta del destinatario, cuando el destinatario está representado como una cuenta de Midaz.

Ejemplo:

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

confirmationNumber
string | null

El código de confirmación legible, si está disponible.

Maximum string length: 20
Ejemplo:

"20260201001"

controlNumber
string | null

El número de control JD SPB, presente para transferencias TED OUT y TED IN.

Maximum string length: 20
Ejemplo:

"202602010001"

midazTransactionId
string<uuid> | null

El ID de transacción correspondiente en el libro mayor de Midaz.

Ejemplo:

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

description
string | null

El propósito o descripción de la transferencia.

Maximum string length: 140
Ejemplo:

"Payment for services"

metadata
object | null

Metadatos personalizados como pares clave-valor.

completedAt
string<date-time> | null

La marca de tiempo de cuando se completó la transferencia. Nulo si aún no se ha completado.

Ejemplo:

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