Receive a PIX Automatico schedule cancellation registration event

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/events/schedule-cancellation-registered \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --data '
{
  "cpfCnpjSolCancelamento": "77379362038",
  "dtHrCancelamento": "2024-09-20T10:10:05.025Z",
  "endToEndId": "E11111111202409201500y6j6mt9l1pi",
  "idCancelamento": "CA0435879820240920bcdb1fhn43a",
  "idConciliacaoRecebedor": "JDPI2024091800000000000000000000002",
  "idRecorrencia": "RR0435879820240919njua7shf40o",
  "ispbDestinatario": "11111111",
  "ispbSolicitante": "04358798",
  "motivoCancelamento": 5,
  "solCancelamento": 0,
  "stCancelamento": 0,
  "tpPessoaSol": 0,
  "codigoErro": "",
  "descCodigoErro": ""
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"cpfCnpjSolCancelamento\": \"77379362038\",\n  \"dtHrCancelamento\": \"2024-09-20T10:10:05.025Z\",\n  \"endToEndId\": \"E11111111202409201500y6j6mt9l1pi\",\n  \"idCancelamento\": \"CA0435879820240920bcdb1fhn43a\",\n  \"idConciliacaoRecebedor\": \"JDPI2024091800000000000000000000002\",\n  \"idRecorrencia\": \"RR0435879820240919njua7shf40o\",\n  \"ispbDestinatario\": \"11111111\",\n  \"ispbSolicitante\": \"04358798\",\n  \"motivoCancelamento\": 5,\n  \"solCancelamento\": 0,\n  \"stCancelamento\": 0,\n  \"tpPessoaSol\": 0,\n  \"codigoErro\": \"\",\n  \"descCodigoErro\": \"\"\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',
    dtHrCancelamento: '2024-09-20T10:10:05.025Z',
    endToEndId: 'E11111111202409201500y6j6mt9l1pi',
    idCancelamento: 'CA0435879820240920bcdb1fhn43a',
    idConciliacaoRecebedor: 'JDPI2024091800000000000000000000002',
    idRecorrencia: 'RR0435879820240919njua7shf40o',
    ispbDestinatario: '11111111',
    ispbSolicitante: '04358798',
    motivoCancelamento: 5,
    solCancelamento: 0,
    stCancelamento: 0,
    tpPessoaSol: 0,
    codigoErro: '',
    descCodigoErro: ''
  })
};

fetch('https://api.example.com/v1/pix-automatico/events/schedule-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/schedule-cancellation-registered"

payload = {
    "cpfCnpjSolCancelamento": "77379362038",
    "dtHrCancelamento": "2024-09-20T10:10:05.025Z",
    "endToEndId": "E11111111202409201500y6j6mt9l1pi",
    "idCancelamento": "CA0435879820240920bcdb1fhn43a",
    "idConciliacaoRecebedor": "JDPI2024091800000000000000000000002",
    "idRecorrencia": "RR0435879820240919njua7shf40o",
    "ispbDestinatario": "11111111",
    "ispbSolicitante": "04358798",
    "motivoCancelamento": 5,
    "solCancelamento": 0,
    "stCancelamento": 0,
    "tpPessoaSol": 0,
    "codigoErro": "",
    "descCodigoErro": ""
}
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 schedule cancellation registration event

Receives the JDPI notifica-cancelamento-agendamento-callback push event (section 6, body section 5.3.4): an async re-delivery of the schedule cancellation registration. It reuses the inbound 5.3.4 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

schedule-cancellation-registered

Receive a PIX Automatico schedule cancellation registration event

curl --request POST \
  --url https://api.example.com/v1/pix-automatico/events/schedule-cancellation-registered \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --data '
{
  "cpfCnpjSolCancelamento": "77379362038",
  "dtHrCancelamento": "2024-09-20T10:10:05.025Z",
  "endToEndId": "E11111111202409201500y6j6mt9l1pi",
  "idCancelamento": "CA0435879820240920bcdb1fhn43a",
  "idConciliacaoRecebedor": "JDPI2024091800000000000000000000002",
  "idRecorrencia": "RR0435879820240919njua7shf40o",
  "ispbDestinatario": "11111111",
  "ispbSolicitante": "04358798",
  "motivoCancelamento": 5,
  "solCancelamento": 0,
  "stCancelamento": 0,
  "tpPessoaSol": 0,
  "codigoErro": "",
  "descCodigoErro": ""
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"cpfCnpjSolCancelamento\": \"77379362038\",\n  \"dtHrCancelamento\": \"2024-09-20T10:10:05.025Z\",\n  \"endToEndId\": \"E11111111202409201500y6j6mt9l1pi\",\n  \"idCancelamento\": \"CA0435879820240920bcdb1fhn43a\",\n  \"idConciliacaoRecebedor\": \"JDPI2024091800000000000000000000002\",\n  \"idRecorrencia\": \"RR0435879820240919njua7shf40o\",\n  \"ispbDestinatario\": \"11111111\",\n  \"ispbSolicitante\": \"04358798\",\n  \"motivoCancelamento\": 5,\n  \"solCancelamento\": 0,\n  \"stCancelamento\": 0,\n  \"tpPessoaSol\": 0,\n  \"codigoErro\": \"\",\n  \"descCodigoErro\": \"\"\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',
    dtHrCancelamento: '2024-09-20T10:10:05.025Z',
    endToEndId: 'E11111111202409201500y6j6mt9l1pi',
    idCancelamento: 'CA0435879820240920bcdb1fhn43a',
    idConciliacaoRecebedor: 'JDPI2024091800000000000000000000002',
    idRecorrencia: 'RR0435879820240919njua7shf40o',
    ispbDestinatario: '11111111',
    ispbSolicitante: '04358798',
    motivoCancelamento: 5,
    solCancelamento: 0,
    stCancelamento: 0,
    tpPessoaSol: 0,
    codigoErro: '',
    descCodigoErro: ''
  })
};

fetch('https://api.example.com/v1/pix-automatico/events/schedule-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/schedule-cancellation-registered"

payload = {
    "cpfCnpjSolCancelamento": "77379362038",
    "dtHrCancelamento": "2024-09-20T10:10:05.025Z",
    "endToEndId": "E11111111202409201500y6j6mt9l1pi",
    "idCancelamento": "CA0435879820240920bcdb1fhn43a",
    "idConciliacaoRecebedor": "JDPI2024091800000000000000000000002",
    "idRecorrencia": "RR0435879820240919njua7shf40o",
    "ispbDestinatario": "11111111",
    "ispbSolicitante": "04358798",
    "motivoCancelamento": 5,
    "solCancelamento": 0,
    "stCancelamento": 0,
    "tpPessoaSol": 0,
    "codigoErro": "",
    "descCodigoErro": ""
}
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"

dtHrCancelamento

string

obrigatório

Cancellation timestamp (UTC).

Exemplo:

"2024-09-20T10:10:05.025Z"

endToEndId

string

obrigatório

Unique payment-instruction id (32-char).

Exemplo:

"E11111111202409201500y6j6mt9l1pi"

idCancelamento

string

obrigatório

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

Exemplo:

"CA0435879820240920bcdb1fhn43a"

idConciliacaoRecebedor

string

obrigatório

Receiver conciliation id (35-char).

Exemplo:

"JDPI2024091800000000000000000000002"

idRecorrencia

string

obrigatório

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

Exemplo:

"RR0435879820240919njua7shf40o"

ispbDestinatario

string

obrigatório

Destination PSP ISPB (8 digits, a v5.5.0 string).

Exemplo:

"11111111"

ispbSolicitante

string

obrigatório

Requesting PSP ISPB (8 digits, a v5.5.0 string).

Exemplo:

"04358798"

motivoCancelamento

integer<int64>

obrigatório

Cancellation reason (0..6).

Exemplo:

5

solCancelamento

integer<int64>

obrigatório

Requesting PSP (0=pagador, 1=recebedor).

Exemplo:

0

stCancelamento

integer<int64>

obrigatório

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

Exemplo:

0

tpPessoaSol

integer<int64>

obrigatório

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

Exemplo:

0

codigoErro

string

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

Exemplo:

""

descCodigoErro

string

JDPI error description (100-char).

Exemplo:

""

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 schedule cancellation registration event

Autorizações

Cabeçalhos

Corpo

Resposta