Cancel a Pix Automático Authorization

Cancel an active authorization. reasonKind=PAYER cancels the caller’s own mandate; reasonKind=FRAUD records the caller as the operator and requires reasonText. X-Idempotency is optional but recommended; replays within the window are de-duplicated.

POST /v1/recurrences/payer/authorizations/{id}/cancel

Cancel a Pix Automático Authorization

cURL

curl --request POST \
  --url https://api.example.com/v1/recurrences/payer/authorizations/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "reasonKind": "PAYER",
  "cancelledBy": "agent-4417",
  "evidenceReference": "FRAUD-CASE-2026-0042",
  "reasonText": "Customer reported unauthorized charge"
}
'

200

{
  "authorization": {
    "cancellationReasonKind": "PAYER",
    "cancelledAt": "2026-05-05T22:30:00Z",
    "effectiveFrom": "2026-05-06",
    "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
    "status": "CANCELLED"
  }
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id · string<uuid> · requerido

Account ID (UUID format)

X-Idempotency · string

Idempotency key (optional; replays within the window are de-duplicated).

Parámetros de ruta

id · string<uuid> · requerido

Authorization ID (UUID format)

Cuerpo

application/json

reasonKind · enum<string> · requerido

Opciones disponibles: PAYER, FRAUD

Minimum string length: 1

Ejemplo:

"PAYER"

cancelledBy · string

Maximum string length: 255

Ejemplo:

"agent-4417"

evidenceReference · string

Maximum string length: 200

Ejemplo:

"FRAUD-CASE-2026-0042"

reasonText · string

Maximum string length: 500

Ejemplo:

"Customer reported unauthorized charge"

Respuesta

200

application/json

OK

authorization · object · requerido

Show child attributes