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. The BACEN-effective date is D+1 (D+2 after 22:00 BRT) for PAYER and immediate for FRAUD. X-Idempotency is required; a repeat call replays the same response with X-Idempotency-Replayed: true.

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

Cancel a Pix Automático Authorization

cURL

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/recurrences/payer/authorizations/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --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"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Account-Id · string · required

Unique identifier of the Midaz Ledger Account (UUID format).

X-Idempotency · string · required

Idempotency key

Path Parameters

id · string · required

Authorization ID (UUID format)

Body

application/json

reasonKind · enum<string> · required

Available options: PAYER, FRAUD

Example:

"PAYER"

cancelledBy · string

Maximum string length: 255

Example:

"agent-4417"

evidenceReference · string

Maximum string length: 200

Example:

"FRAUD-CASE-2026-0042"

reasonText · string

Maximum string length: 500

Example:

"Customer reported unauthorized charge"

Response

200

application/json

OK

authorization · object

Show child attributes