Pular para o conteúdo principal
POST
Request the regulatory cancellation of an operation

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string

Idempotency key for safe retries; a replay returns the stored response.

X-Request-Id
string

Optional client request id echoed back in meta.requestId.

Parâmetros de caminho

operationId
string
obrigatório

Id (UUID) of the operation to cancel.

Exemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

Corpo

application/json
reasonCategory
enum<string>
obrigatório

Numeric MotvCanc cancellation reason (OP107 §11.3.16): '1'..'4'.

Opções disponíveis:
1,
2,
3,
4
Exemplo:

"4"

externalId
string

Optional client-side reference for the new CANCELLATION operation. When present it must not be used by any other operation (409 DUPLICATE_EXTERNAL_ID).

Maximum string length: 255
Exemplo:

"canc-2026-06-0001"

Resposta

Accepted

externalId
string
obrigatório

Echoed client-side external identifier.

Exemplo:

"acq-ext-2026-06-0001"

id
string
obrigatório

Created operation id (UUID).

Exemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

meta
object
obrigatório

Response envelope metadata (requestId + timestamp).

state
string
obrigatório

Initial lifecycle state of the created operation.

Exemplo:

"CREATED"