Skip to main content
POST
/
v1
/
pix-automatico
/
events
/
schedule-cancellation-registered
Receive a Pix Automático schedule cancellation registration event
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/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": "<string>",
  "dtHrCancelamento": "<string>",
  "endToEndId": "<string>",
  "idCancelamento": "<string>",
  "idConciliacaoRecebedor": "<string>",
  "idRecorrencia": "<string>",
  "ispbDestinatario": "<string>",
  "ispbSolicitante": "<string>",
  "motivoCancelamento": 123,
  "solCancelamento": 123,
  "stCancelamento": 123,
  "tpPessoaSol": 123,
  "codigoErro": "<string>",
  "descCodigoErro": "<string>"
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-registered"

payload = {
    "cpfCnpjSolCancelamento": "<string>",
    "dtHrCancelamento": "<string>",
    "endToEndId": "<string>",
    "idCancelamento": "<string>",
    "idConciliacaoRecebedor": "<string>",
    "idRecorrencia": "<string>",
    "ispbDestinatario": "<string>",
    "ispbSolicitante": "<string>",
    "motivoCancelamento": 123,
    "solCancelamento": 123,
    "stCancelamento": 123,
    "tpPessoaSol": 123,
    "codigoErro": "<string>",
    "descCodigoErro": "<string>"
}
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)
const options = {
  method: 'POST',
  headers: {
    'X-DataHoraEvento': '<x-datahoraevento>',
    'X-NomeEvento': '<x-nomeevento>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    cpfCnpjSolCancelamento: '<string>',
    dtHrCancelamento: '<string>',
    endToEndId: '<string>',
    idCancelamento: '<string>',
    idConciliacaoRecebedor: '<string>',
    idRecorrencia: '<string>',
    ispbDestinatario: '<string>',
    ispbSolicitante: '<string>',
    motivoCancelamento: 123,
    solCancelamento: 123,
    stCancelamento: 123,
    tpPessoaSol: 123,
    codigoErro: '<string>',
    descCodigoErro: '<string>'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-registered', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-registered",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cpfCnpjSolCancelamento' => '<string>',
    'dtHrCancelamento' => '<string>',
    'endToEndId' => '<string>',
    'idCancelamento' => '<string>',
    'idConciliacaoRecebedor' => '<string>',
    'idRecorrencia' => '<string>',
    'ispbDestinatario' => '<string>',
    'ispbSolicitante' => '<string>',
    'motivoCancelamento' => 123,
    'solCancelamento' => 123,
    'stCancelamento' => 123,
    'tpPessoaSol' => 123,
    'codigoErro' => '<string>',
    'descCodigoErro' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-DataHoraEvento: <x-datahoraevento>",
    "X-NomeEvento: <x-nomeevento>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-registered"

	payload := strings.NewReader("{\n  \"cpfCnpjSolCancelamento\": \"<string>\",\n  \"dtHrCancelamento\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"idCancelamento\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"ispbDestinatario\": \"<string>\",\n  \"ispbSolicitante\": \"<string>\",\n  \"motivoCancelamento\": 123,\n  \"solCancelamento\": 123,\n  \"stCancelamento\": 123,\n  \"tpPessoaSol\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\"\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))

}
HttpResponse<String> response = Unirest.post("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-registered")
  .header("X-DataHoraEvento", "<x-datahoraevento>")
  .header("X-NomeEvento", "<x-nomeevento>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cpfCnpjSolCancelamento\": \"<string>\",\n  \"dtHrCancelamento\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"idCancelamento\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"ispbDestinatario\": \"<string>\",\n  \"ispbSolicitante\": \"<string>\",\n  \"motivoCancelamento\": 123,\n  \"solCancelamento\": 123,\n  \"stCancelamento\": 123,\n  \"tpPessoaSol\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-registered")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-DataHoraEvento"] = '<x-datahoraevento>'
request["X-NomeEvento"] = '<x-nomeevento>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cpfCnpjSolCancelamento\": \"<string>\",\n  \"dtHrCancelamento\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"idCancelamento\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"idRecorrencia\": \"<string>\",\n  \"ispbDestinatario\": \"<string>\",\n  \"ispbSolicitante\": \"<string>\",\n  \"motivoCancelamento\": 123,\n  \"solCancelamento\": 123,\n  \"stCancelamento\": 123,\n  \"tpPessoaSol\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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).

​
dtHrCancelamento
string
required

Cancellation timestamp (UTC).

​
endToEndId
string
required

Unique payment-instruction id (32-char).

​
idCancelamento
string
required

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

​
idConciliacaoRecebedor
string
required

Receiver conciliation id (35-char).

​
idRecorrencia
string
required

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

​
ispbDestinatario
string
required

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

​
ispbSolicitante
string
required

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

​
motivoCancelamento
integer<int64>
required

Cancellation reason (0..6).

​
solCancelamento
integer<int64>
required

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

​
stCancelamento
integer<int64>
required

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

​
tpPessoaSol
integer<int64>
required

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

​
codigoErro
string

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

​
descCodigoErro
string

Upstream error description (100-char).

Response

No Content