Receive a Pix Automático authorization cancellation registration event

Receives the upstream push event: an async re-delivery of the cancellation registration. It reuses the inbound 5.2.5 register use case (Aceito cancels + soft-deletes; Rejeitado is ack-only). Idempotent: a re-delivery on an already-cancelled row is a no-op. No response body.

POST /v1/pix-automatico/events/authorization-cancellation-registered

Receive a Pix Automático authorization cancellation registration event

cURL

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/authorization-cancellation-registered \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --data '
{
  "cpfCnpjSolCancelamento": "<string>",
  "dtInicialRecorrencia": "<string>",
  "idCancelamento": "<string>",
  "idRecorrencia": "<string>",
  "motivoCancelamento": 123,
  "nrContrato": "<string>",
  "pagador": {
    "cpfCnpj": "<string>",
    "ispb": "<string>",
    "nrConta": "<string>",
    "tpPessoa": 123,
    "codMunIbge": 123,
    "nrAgencia": "<string>"
  },
  "recebedor": {
    "cnpj": "<string>",
    "ispb": "<string>",
    "nome": "<string>"
  },
  "stCancelamento": 123,
  "tpFrequencia": 123,
  "tpPessoaSol": 123,
  "codigoErro": "<string>",
  "descCodigoErro": "<string>",
  "descContrato": "<string>",
  "dtFinalRecorrencia": "<string>",
  "dtHrCancelamento": "<string>",
  "dtHrCriacaoRecorrencia": "<string>",
  "valor": 123
}
'

default

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization · string · header · required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Headers

Authorization · string

Bearer access token (the financial-ingress gate; the handler fails closed with Pix-0082 when absent).

X-DataHoraEvento · string · required

Event registration instant (UTC: aaaa-mm-ddTHH:mm:ss.sssZ). Mandatory per

X-NomeEvento · string · required

Event name. Mandatory per; informational passthrough.

Body

application/json

cpfCnpjSolCancelamento · string · required

Requester CPF/CNPJ (a v5.5.0 string).

dtInicialRecorrencia · string · required

First payment date (aaaa-mm-dd).

idCancelamento · string · required

Unique cancellation id (29-char, IC...).

idRecorrencia · string · required

Unique recurrence id (29-char, RR...).

motivoCancelamento · integer<int64> · required

Cancellation reason (0..10).

nrContrato · string · required

Contract/order identifier (35-char).

pagador · object · required

Show child attributes

recebedor · object · required

Show child attributes

stCancelamento · integer<int64> · required

Cancellation status (0=Aceito, 1=Rejeitado).

tpFrequencia · integer<int64> · required

Recurrence periodicity (0..4).

tpPessoaSol · integer<int64> · required

Requester person type (0=PF, 1=PJ).

codigoErro · string

Upstream error code (100-char; on a rejected cancellation).

descCodigoErro · string

Upstream error description (1000-char).

descContrato · string

Free-text contract description (35-char).

devedor · object

Show child attributes

dtFinalRecorrencia · string

Last payment date (aaaa-mm-dd).

dtHrCancelamento · string

Cancellation timestamp (UTC).

dtHrCriacaoRecorrencia · string

Recurrence creation timestamp (UTC).

valor · number<double>

Fixed payment amount in reais (a JSON number).

Response

204

No Content