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"
  }
}

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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

Authorization

string

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

Example:

"Bearer eyJ..."

X-DataHoraEvento

string

required

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

Example:

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

X-NomeEvento

string

required

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

Example:

"situacao-autorizacao-callback"

Body

application/json

cpfCnpjSolCancelamento

string

required

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

Example:

"77379362038"

dtHrCancelamento

string

required

Cancellation timestamp (UTC).

Example:

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

endToEndId

string

required

Unique payment-instruction id (32-char).

Example:

"E11111111202409201500y6j6mt9l1pi"

idCancelamento

string

required

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

Example:

"CA0435879820240920bcdb1fhn43a"

idConciliacaoRecebedor

string

required

Receiver conciliation id (35-char).

Example:

"JDPI2024091800000000000000000000002"

idRecorrencia

string

required

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

Example:

"RR0435879820240919njua7shf40o"

ispbDestinatario

string

required

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

Example:

"11111111"

ispbSolicitante

string

required

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

Example:

"04358798"

motivoCancelamento

integer<int64>

required

Cancellation reason (0..6).

Example:

5

solCancelamento

integer<int64>

required

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

Example:

0

stCancelamento

integer<int64>

required

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

Example:

0

tpPessoaSol

integer<int64>

required

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

Example:

0

codigoErro

string

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

Example:

""

descCodigoErro

string

JDPI error description (100-char).

Example:

""

Response

No Content

Key DICT API

Key Claims API

Banks API

Indirect participants API

Transactions API

Transaction Limits API

QR Codes API

Refunds API

Pix Automático · Authorization requests

Pix Automático · Authorization management

Pix Automático · Composite QR codes

Pix Automático · Authorization events

Pix Automático · Schedule events

Pix Automático · Schedules and payment instructions

Pix Automático · Settlement

MED · Refunds

MED · Fraud markers

MED · Infractions

MED · Value recovery

Webhooks API

Error handling

Events

Receive a PIX Automatico schedule cancellation registration event

Authorizations

Headers

Body

Response