Create bank transfer cancellation operation

Prerequisite: the parent operation must exist and admit cancellation — read its state via getOperation (GET /v1/str/operations/); the path segment structurally ties the cancellation to its parent. A transfer is cancellable until it settles; once settled it takes a return instead (SPB-3006). Two endings: a transfer the STR already holds is cancelled by an STR0011 the STR adjudicates, and the cancellation operation comes back CANCEL_REQUESTED; a transfer that never reached the wire is abandoned locally, nothing is sent to BACEN, and the cancellation operation comes back already CANCELLED. A transfer whose dispatch may have reached the STR but is still unresolved answers SPB-3006; retry the cancellation once its dispatch resolves. Idempotent — the X-Idempotency key lives with the operation: the same key and parsed request (member order and whitespace do not count; any other difference, such as number spelling, null for an absent field, or an unknown member, is another request) answer the stored operation with X-Idempotency-Replayed: true, also after X-TTL has dropped the cached response, and the same key with another request answers 422.

POST /v1/str/operations/bank-transfers/{operationId}/cancellations

Create bank transfer cancellation operation

cURL

curl --request POST \
  --url https://api.example.com/v1/str/operations/bank-transfers/{operationId}/cancellations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "senderIspb": "12345678",
  "metadata": {},
  "reason": "Client requested cancellation"
}
'

201

{
  "acceptedAt": "2026-05-06T18:30:00Z",
  "capabilityId": "STR0004",
  "correlationId": "req-7c8b3a2e-9f1d-4a55-9b8e-1e1234567890",
  "isReplay": false,
  "operationFamily": "bankTransfer",
  "operationId": "7c8b3a2e-9f1d-4a55-9b8e-1e1234567890",
  "status": "ACCEPTED",
  "protocolMetadata": {
    "controlNumber": "20260506000000000001",
    "emissionApprovalId": "<string>",
    "nuOp": "12345678202605060000001"
  }
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency · string · obrigatório

Idempotency key. Required on every mutation.

X-TTL · string

Seconds the cached response is kept; it may only shorten IDEMPOTENCY_DEFAULT_TTL_SEC. The key itself lives with the operation.

Parâmetros de caminho

operationId · string · obrigatório

Original bank-transfer operation UUID.

Corpo

application/json

senderIspb · string · obrigatório

ISPB of the participant requesting the cancellation, the 8-character BACEN institution identifier.

Pattern: ^[0-9A-Z]{8}$

Exemplo:

"12345678"

metadata · object

Opaque client-side metadata forwarded verbatim to the legacy submit DTO; not persisted on the cancellation intent.

Show child attributes

reason · string

Optional free-text reason for the cancellation.

Exemplo:

"Client requested cancellation"

Resposta

201

application/json

Created

acceptedAt · string<date-time> · obrigatório

UTC RFC 3339 timestamp at which the command was accepted.

Exemplo:

"2026-05-06T18:30:00Z"

capabilityId · string · obrigatório

STR capability identifier resolved for the accepted operation (e.g. STR0004).

Exemplo:

"STR0004"

correlationId · string · obrigatório

Request correlation identifier for tracing the accept across logs and traces.

Exemplo:

"req-7c8b3a2e-9f1d-4a55-9b8e-1e1234567890"

isReplay · boolean · obrigatório

True when this response replays a prior idempotent accept rather than creating a new operation.

Exemplo:

false

operationFamily · enum<string> · obrigatório

Operation family the accepted command belongs to (e.g. bankTransfer).

Opções disponíveis: bankTransfer

Exemplo:

"bankTransfer"

operationId · string<uuid> · obrigatório

Server-assigned operation aggregate UUID used for subsequent status, return, and cancellation calls.

Exemplo:

"7c8b3a2e-9f1d-4a55-9b8e-1e1234567890"

status · enum<string> · obrigatório

Current control-plane lifecycle status of the operation; ACCEPTED on initial accept.

Opções disponíveis: ACCEPTED, SUBMITTED, SENT, CONFIRMED, REJECTED, FAILED, PENDING_CONFIGURATION, PENDING_RECONCILIATION, RETURN_REQUESTED, RETURNED, CANCEL_REQUESTED, CANCELLED, RECEIVED, DELIVERED

Exemplo:

"ACCEPTED"

protocolMetadata · object

Optional SAFE protocol correlation fields; present once the operation is mapped to STR wire identifiers.

Show child attributes