Saltar al contenido principal
GET
/
v1
/
transfers
/
{transferId}
Obtener una Transferencia
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/{transferId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Organization-Id: <x-organization-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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
X-Organization-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 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> | null
requerido

UUID de la cuenta del remitente. Puede ser nulo para transferencias TED_IN donde el remitente es externo.

​
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

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"