Saltar al contenido principal
POST
/
v1
/
transfers
/
{transferId}
/
cancel
Cancelar una Transferencia
curl --request POST \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/{transferId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --header 'X-Tenant-Id: <x-tenant-id>' \
  --data '
{
  "reason": "User requested cancellation"
}
'
{
  "transferId": "019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d",
  "status": "CANCELLED",
  "cancelledAt": "2026-02-01T15:35:00-03:00"
}

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.

​
X-Idempotency
string
requerido

Clave de idempotencia requerida para reintentos seguros. Utilice un UUID v4 o un identificador de negocio único. Si se envía la misma clave nuevamente y la solicitud original ya fue procesada, se devuelve la respuesta almacenada en caché.

Consulte Reintentos e idempotencia para más detalles.

Maximum string length: 255

Parámetros de ruta

​
transferId
string<uuid>
requerido

El identificador único de la transferencia a cancelar.

Cuerpo

application/json
​
reason
string

El motivo de la cancelación.

Maximum string length: 500

Respuesta

Indica que la transferencia fue cancelada exitosamente y los fondos fueron liberados.

La respuesta incluye el encabezado X-Idempotency-Replayed.

Si el valor es false, la transacción acaba de ser procesada. Si el valor es true, la respuesta es una repetición de una solicitud previamente procesada.

Consulte Reintentos e idempotencia para más detalles.

​
transferId
string<uuid>
requerido
Ejemplo:

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

​
status
enum<string>
requerido
Opciones disponibles:
CANCELLED
Ejemplo:

"CANCELLED"

​
cancelledAt
string<date-time>
requerido
Ejemplo:

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