Pular para o conteúdo principal
POST
/
v1
/
transfers
/
{transferId}
/
cancel
Cancelar uma Transferência
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"
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticação por token JWT Bearer. O token deve incluir uma claim tenantId que corresponda ao cabeçalho X-Tenant-Id.

Cabeçalhos

​
X-Tenant-Id
string<uuid>
obrigatório

ID da organização usado como identificador do tenant. Todos os dados são limitados a esta organização. Deve corresponder à claim tenantId do JWT quando a autenticação está habilitada.

​
X-Idempotency
string
obrigatório

Chave de idempotência obrigatória para tentativas seguras. Use um UUID v4 ou identificador de negócio único. Se a mesma chave for enviada novamente e a solicitação original já tiver sido processada, a resposta em cache será retornada.

Consulte Tentativas e idempotência para detalhes.

Maximum string length: 255

Parâmetros de caminho

​
transferId
string<uuid>
obrigatório

O identificador único da transferência a ser cancelada.

Corpo

application/json
​
reason
string

O motivo do cancelamento.

Maximum string length: 500

Resposta

Indica que a transferência foi cancelada com sucesso e os fundos foram liberados.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a transação acabou de ser processada. Se o valor for true, a resposta é uma repetição de uma solicitação processada anteriormente.

Consulte Tentativas e idempotência para mais detalhes.

​
transferId
string<uuid>
obrigatório
Exemplo:

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

​
status
enum<string>
obrigatório
Opções disponíveis:
CANCELLED
Exemplo:

"CANCELLED"

​
cancelledAt
string<date-time>
obrigatório
Exemplo:

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