Receive a PIX Automatico authorization cancellation registration event

curl --request POST \
  --url https://api.example.com/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": "77379362038",
  "dtInicialRecorrencia": "2024-01-10",
  "idCancelamento": "IC0435879820240605bcdb1fhn43a",
  "idRecorrencia": "RR0435879820240920njua7shf40o",
  "motivoCancelamento": 6,
  "nrContrato": "1234567890ABC",
  "pagador": {
    "cpfCnpj": "11111111111",
    "ispb": "99999004",
    "nrConta": "12345678",
    "tpPessoa": 0,
    "codMunIbge": 3550308,
    "nrAgencia": "1234"
  },
  "recebedor": {
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "nome": "Enel"
  },
  "stCancelamento": 0,
  "tpFrequencia": 4,
  "tpPessoaSol": 0,
  "codigoErro": "",
  "descCodigoErro": "",
  "descContrato": "Conta de energia",
  "dtFinalRecorrencia": "2026-01-10",
  "dtHrCancelamento": "2024-09-23T10:10:06.101Z",
  "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
  "valor": 550
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pix-automatico/events/authorization-cancellation-registered"

	payload := strings.NewReader("{\n  \"cpfCnpjSolCancelamento\": \"77379362038\",\n  \"dtInicialRecorrencia\": \"2024-01-10\",\n  \"idCancelamento\": \"IC0435879820240605bcdb1fhn43a\",\n  \"idRecorrencia\": \"RR0435879820240920njua7shf40o\",\n  \"motivoCancelamento\": 6,\n  \"nrContrato\": \"1234567890ABC\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11111111111\",\n    \"ispb\": \"99999004\",\n    \"nrConta\": \"12345678\",\n    \"tpPessoa\": 0,\n    \"codMunIbge\": 3550308,\n    \"nrAgencia\": \"1234\"\n  },\n  \"recebedor\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"nome\": \"Enel\"\n  },\n  \"stCancelamento\": 0,\n  \"tpFrequencia\": 4,\n  \"tpPessoaSol\": 0,\n  \"codigoErro\": \"\",\n  \"descCodigoErro\": \"\",\n  \"descContrato\": \"Conta de energia\",\n  \"dtFinalRecorrencia\": \"2026-01-10\",\n  \"dtHrCancelamento\": \"2024-09-23T10:10:06.101Z\",\n  \"dtHrCriacaoRecorrencia\": \"2024-09-20T09:25:49.025Z\",\n  \"valor\": 550\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DataHoraEvento", "<x-datahoraevento>")
	req.Header.Add("X-NomeEvento", "<x-nomeevento>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-DataHoraEvento': '<x-datahoraevento>',
    'X-NomeEvento': '<x-nomeevento>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    cpfCnpjSolCancelamento: '77379362038',
    dtInicialRecorrencia: '2024-01-10',
    idCancelamento: 'IC0435879820240605bcdb1fhn43a',
    idRecorrencia: 'RR0435879820240920njua7shf40o',
    motivoCancelamento: 6,
    nrContrato: '1234567890ABC',
    pagador: {
      cpfCnpj: '11111111111',
      ispb: '99999004',
      nrConta: '12345678',
      tpPessoa: 0,
      codMunIbge: 3550308,
      nrAgencia: '1234'
    },
    recebedor: {cnpj: '61695227000193', ispb: '04358798', nome: 'Enel'},
    stCancelamento: 0,
    tpFrequencia: 4,
    tpPessoaSol: 0,
    codigoErro: '',
    descCodigoErro: '',
    descContrato: 'Conta de energia',
    dtFinalRecorrencia: '2026-01-10',
    dtHrCancelamento: '2024-09-23T10:10:06.101Z',
    dtHrCriacaoRecorrencia: '2024-09-20T09:25:49.025Z',
    valor: 550
  })
};

fetch('https://api.example.com/v1/pix-automatico/events/authorization-cancellation-registered', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/pix-automatico/events/authorization-cancellation-registered"

payload = {
    "cpfCnpjSolCancelamento": "77379362038",
    "dtInicialRecorrencia": "2024-01-10",
    "idCancelamento": "IC0435879820240605bcdb1fhn43a",
    "idRecorrencia": "RR0435879820240920njua7shf40o",
    "motivoCancelamento": 6,
    "nrContrato": "1234567890ABC",
    "pagador": {
        "cpfCnpj": "11111111111",
        "ispb": "99999004",
        "nrConta": "12345678",
        "tpPessoa": 0,
        "codMunIbge": 3550308,
        "nrAgencia": "1234"
    },
    "recebedor": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "nome": "Enel"
    },
    "stCancelamento": 0,
    "tpFrequencia": 4,
    "tpPessoaSol": 0,
    "codigoErro": "",
    "descCodigoErro": "",
    "descContrato": "Conta de energia",
    "dtFinalRecorrencia": "2026-01-10",
    "dtHrCancelamento": "2024-09-23T10:10:06.101Z",
    "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
    "valor": 550
}
headers = {
    "X-DataHoraEvento": "<x-datahoraevento>",
    "X-NomeEvento": "<x-nomeevento>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Receive a PIX Automatico authorization cancellation registration event

Receives the JDPI notifica-cancelamento-autorizacao-callback push event (section 6, body section 5.2.5): 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

pix-automatico

events

authorization-cancellation-registered

Receive a PIX Automatico authorization cancellation registration event

curl --request POST \
  --url https://api.example.com/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": "77379362038",
  "dtInicialRecorrencia": "2024-01-10",
  "idCancelamento": "IC0435879820240605bcdb1fhn43a",
  "idRecorrencia": "RR0435879820240920njua7shf40o",
  "motivoCancelamento": 6,
  "nrContrato": "1234567890ABC",
  "pagador": {
    "cpfCnpj": "11111111111",
    "ispb": "99999004",
    "nrConta": "12345678",
    "tpPessoa": 0,
    "codMunIbge": 3550308,
    "nrAgencia": "1234"
  },
  "recebedor": {
    "cnpj": "61695227000193",
    "ispb": "04358798",
    "nome": "Enel"
  },
  "stCancelamento": 0,
  "tpFrequencia": 4,
  "tpPessoaSol": 0,
  "codigoErro": "",
  "descCodigoErro": "",
  "descContrato": "Conta de energia",
  "dtFinalRecorrencia": "2026-01-10",
  "dtHrCancelamento": "2024-09-23T10:10:06.101Z",
  "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
  "valor": 550
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/pix-automatico/events/authorization-cancellation-registered"

	payload := strings.NewReader("{\n  \"cpfCnpjSolCancelamento\": \"77379362038\",\n  \"dtInicialRecorrencia\": \"2024-01-10\",\n  \"idCancelamento\": \"IC0435879820240605bcdb1fhn43a\",\n  \"idRecorrencia\": \"RR0435879820240920njua7shf40o\",\n  \"motivoCancelamento\": 6,\n  \"nrContrato\": \"1234567890ABC\",\n  \"pagador\": {\n    \"cpfCnpj\": \"11111111111\",\n    \"ispb\": \"99999004\",\n    \"nrConta\": \"12345678\",\n    \"tpPessoa\": 0,\n    \"codMunIbge\": 3550308,\n    \"nrAgencia\": \"1234\"\n  },\n  \"recebedor\": {\n    \"cnpj\": \"61695227000193\",\n    \"ispb\": \"04358798\",\n    \"nome\": \"Enel\"\n  },\n  \"stCancelamento\": 0,\n  \"tpFrequencia\": 4,\n  \"tpPessoaSol\": 0,\n  \"codigoErro\": \"\",\n  \"descCodigoErro\": \"\",\n  \"descContrato\": \"Conta de energia\",\n  \"dtFinalRecorrencia\": \"2026-01-10\",\n  \"dtHrCancelamento\": \"2024-09-23T10:10:06.101Z\",\n  \"dtHrCriacaoRecorrencia\": \"2024-09-20T09:25:49.025Z\",\n  \"valor\": 550\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DataHoraEvento", "<x-datahoraevento>")
	req.Header.Add("X-NomeEvento", "<x-nomeevento>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-DataHoraEvento': '<x-datahoraevento>',
    'X-NomeEvento': '<x-nomeevento>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    cpfCnpjSolCancelamento: '77379362038',
    dtInicialRecorrencia: '2024-01-10',
    idCancelamento: 'IC0435879820240605bcdb1fhn43a',
    idRecorrencia: 'RR0435879820240920njua7shf40o',
    motivoCancelamento: 6,
    nrContrato: '1234567890ABC',
    pagador: {
      cpfCnpj: '11111111111',
      ispb: '99999004',
      nrConta: '12345678',
      tpPessoa: 0,
      codMunIbge: 3550308,
      nrAgencia: '1234'
    },
    recebedor: {cnpj: '61695227000193', ispb: '04358798', nome: 'Enel'},
    stCancelamento: 0,
    tpFrequencia: 4,
    tpPessoaSol: 0,
    codigoErro: '',
    descCodigoErro: '',
    descContrato: 'Conta de energia',
    dtFinalRecorrencia: '2026-01-10',
    dtHrCancelamento: '2024-09-23T10:10:06.101Z',
    dtHrCriacaoRecorrencia: '2024-09-20T09:25:49.025Z',
    valor: 550
  })
};

fetch('https://api.example.com/v1/pix-automatico/events/authorization-cancellation-registered', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/pix-automatico/events/authorization-cancellation-registered"

payload = {
    "cpfCnpjSolCancelamento": "77379362038",
    "dtInicialRecorrencia": "2024-01-10",
    "idCancelamento": "IC0435879820240605bcdb1fhn43a",
    "idRecorrencia": "RR0435879820240920njua7shf40o",
    "motivoCancelamento": 6,
    "nrContrato": "1234567890ABC",
    "pagador": {
        "cpfCnpj": "11111111111",
        "ispb": "99999004",
        "nrConta": "12345678",
        "tpPessoa": 0,
        "codMunIbge": 3550308,
        "nrAgencia": "1234"
    },
    "recebedor": {
        "cnpj": "61695227000193",
        "ispb": "04358798",
        "nome": "Enel"
    },
    "stCancelamento": 0,
    "tpFrequencia": 4,
    "tpPessoaSol": 0,
    "codigoErro": "",
    "descCodigoErro": "",
    "descContrato": "Conta de energia",
    "dtFinalRecorrencia": "2026-01-10",
    "dtHrCancelamento": "2024-09-23T10:10:06.101Z",
    "dtHrCriacaoRecorrencia": "2024-09-20T09:25:49.025Z",
    "valor": 550
}
headers = {
    "X-DataHoraEvento": "<x-datahoraevento>",
    "X-NomeEvento": "<x-nomeevento>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Authorization

string

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

Exemplo:

"Bearer eyJ..."

X-DataHoraEvento

string

obrigatório

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

Exemplo:

"2024-06-05T10:10:05.025Z"

X-NomeEvento

string

obrigatório

Event name (see §6.3.1 catalog). Mandatory per §6.1; informational passthrough.

Exemplo:

"situacao-autorizacao-callback"

Corpo

application/json

cpfCnpjSolCancelamento

string

obrigatório

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

Exemplo:

"77379362038"

dtInicialRecorrencia

string

obrigatório

First payment date (aaaa-mm-dd).

Exemplo:

"2024-01-10"

idCancelamento

string

obrigatório

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

Exemplo:

"IC0435879820240605bcdb1fhn43a"

idRecorrencia

string

obrigatório

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

Exemplo:

"RR0435879820240920njua7shf40o"

motivoCancelamento

integer<int64>

obrigatório

Cancellation reason (0..10).

Exemplo:

6

nrContrato

string

obrigatório

Contract/order identifier (35-char).

Exemplo:

"1234567890ABC"

pagador

object

obrigatório

The recurrence pagador.

Show child attributes

recebedor

object

obrigatório

The recurrence recebedor.

Show child attributes

stCancelamento

integer<int64>

obrigatório

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

Exemplo:

0

tpFrequencia

integer<int64>

obrigatório

Recurrence periodicity (0..4).

Exemplo:

4

tpPessoaSol

integer<int64>

obrigatório

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

Exemplo:

0

codigoErro

string

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

Exemplo:

""

descCodigoErro

string

JDPI error description (1000-char).

Exemplo:

""

descContrato

string

Free-text contract description (35-char).

Exemplo:

"Conta de energia"

devedor

object

The devedor, sent only when it differs from the payer.

Show child attributes

dtFinalRecorrencia

string

Last payment date (aaaa-mm-dd).

Exemplo:

"2026-01-10"

dtHrCancelamento

string

Cancellation timestamp (UTC).

Exemplo:

"2024-09-23T10:10:06.101Z"

dtHrCriacaoRecorrencia

string

Recurrence creation timestamp (UTC).

Exemplo:

"2024-09-20T09:25:49.025Z"

valor

number<double>

Fixed payment amount in reais (a JSON number).

Exemplo:

550

Resposta

No Content

Lançamentos

Reivindicações

Bancos

Indiretos

Transações

Limites

QR Codes

Devoluções

PIX Automatico

MED Infrações

MED Devoluções

MED Marcadores de Fraude

MED Recuperações

MED Crédito Recebido

Webhooks

Tratamento de erros

Eventos

Receive a PIX Automatico authorization cancellation registration event

Autorizações

Cabeçalhos

Corpo

Resposta