Receive a Pix Automático schedule cancellation status event

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --data '
{
  "cpfCnpjSolCancelamento": "<string>",
  "dtHrCancelamento": "<string>",
  "dtHrSituacao": "<string>",
  "endToEndId": "<string>",
  "idCancelamento": "<string>",
  "ispbDestinatario": "<string>",
  "ispbSolicitante": "<string>",
  "motivoCancelamento": 123,
  "solCancelamento": 123,
  "stJdPi": 123,
  "stJdPiProc": 123,
  "tpPessoaSol": 123,
  "codigoErro": "<string>",
  "descCodigoErro": "<string>",
  "dtHrReqJdPi": "<string>",
  "idConciliacaoRecebedor": "<string>",
  "stCancelamento": 123
}
'

import requests

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

payload = {
    "cpfCnpjSolCancelamento": "<string>",
    "dtHrCancelamento": "<string>",
    "dtHrSituacao": "<string>",
    "endToEndId": "<string>",
    "idCancelamento": "<string>",
    "ispbDestinatario": "<string>",
    "ispbSolicitante": "<string>",
    "motivoCancelamento": 123,
    "solCancelamento": 123,
    "stJdPi": 123,
    "stJdPiProc": 123,
    "tpPessoaSol": 123,
    "codigoErro": "<string>",
    "descCodigoErro": "<string>",
    "dtHrReqJdPi": "<string>",
    "idConciliacaoRecebedor": "<string>",
    "stCancelamento": 123
}
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>',
    dtHrSituacao: '<string>',
    endToEndId: '<string>',
    idCancelamento: '<string>',
    ispbDestinatario: '<string>',
    ispbSolicitante: '<string>',
    motivoCancelamento: 123,
    solCancelamento: 123,
    stJdPi: 123,
    stJdPiProc: 123,
    tpPessoaSol: 123,
    codigoErro: '<string>',
    descCodigoErro: '<string>',
    dtHrReqJdPi: '<string>',
    idConciliacaoRecebedor: '<string>',
    stCancelamento: 123
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-status', 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-status",
  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>',
    'dtHrSituacao' => '<string>',
    'endToEndId' => '<string>',
    'idCancelamento' => '<string>',
    'ispbDestinatario' => '<string>',
    'ispbSolicitante' => '<string>',
    'motivoCancelamento' => 123,
    'solCancelamento' => 123,
    'stJdPi' => 123,
    'stJdPiProc' => 123,
    'tpPessoaSol' => 123,
    'codigoErro' => '<string>',
    'descCodigoErro' => '<string>',
    'dtHrReqJdPi' => '<string>',
    'idConciliacaoRecebedor' => '<string>',
    'stCancelamento' => 123
  ]),
  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-status"

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

require 'uri'
require 'net/http'

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

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  \"dtHrSituacao\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"idCancelamento\": \"<string>\",\n  \"ispbDestinatario\": \"<string>\",\n  \"ispbSolicitante\": \"<string>\",\n  \"motivoCancelamento\": 123,\n  \"solCancelamento\": 123,\n  \"stJdPi\": 123,\n  \"stJdPiProc\": 123,\n  \"tpPessoaSol\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrReqJdPi\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"stCancelamento\": 123\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"
}

POST

pix-automatico

events

schedule-cancellation-status

Receive a Pix Automático schedule cancellation status event

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DataHoraEvento: <x-datahoraevento>' \
  --header 'X-NomeEvento: <x-nomeevento>' \
  --data '
{
  "cpfCnpjSolCancelamento": "<string>",
  "dtHrCancelamento": "<string>",
  "dtHrSituacao": "<string>",
  "endToEndId": "<string>",
  "idCancelamento": "<string>",
  "ispbDestinatario": "<string>",
  "ispbSolicitante": "<string>",
  "motivoCancelamento": 123,
  "solCancelamento": 123,
  "stJdPi": 123,
  "stJdPiProc": 123,
  "tpPessoaSol": 123,
  "codigoErro": "<string>",
  "descCodigoErro": "<string>",
  "dtHrReqJdPi": "<string>",
  "idConciliacaoRecebedor": "<string>",
  "stCancelamento": 123
}
'

import requests

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

payload = {
    "cpfCnpjSolCancelamento": "<string>",
    "dtHrCancelamento": "<string>",
    "dtHrSituacao": "<string>",
    "endToEndId": "<string>",
    "idCancelamento": "<string>",
    "ispbDestinatario": "<string>",
    "ispbSolicitante": "<string>",
    "motivoCancelamento": 123,
    "solCancelamento": 123,
    "stJdPi": 123,
    "stJdPiProc": 123,
    "tpPessoaSol": 123,
    "codigoErro": "<string>",
    "descCodigoErro": "<string>",
    "dtHrReqJdPi": "<string>",
    "idConciliacaoRecebedor": "<string>",
    "stCancelamento": 123
}
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>',
    dtHrSituacao: '<string>',
    endToEndId: '<string>',
    idCancelamento: '<string>',
    ispbDestinatario: '<string>',
    ispbSolicitante: '<string>',
    motivoCancelamento: 123,
    solCancelamento: 123,
    stJdPi: 123,
    stJdPiProc: 123,
    tpPessoaSol: 123,
    codigoErro: '<string>',
    descCodigoErro: '<string>',
    dtHrReqJdPi: '<string>',
    idConciliacaoRecebedor: '<string>',
    stCancelamento: 123
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/events/schedule-cancellation-status', 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-status",
  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>',
    'dtHrSituacao' => '<string>',
    'endToEndId' => '<string>',
    'idCancelamento' => '<string>',
    'ispbDestinatario' => '<string>',
    'ispbSolicitante' => '<string>',
    'motivoCancelamento' => 123,
    'solCancelamento' => 123,
    'stJdPi' => 123,
    'stJdPiProc' => 123,
    'tpPessoaSol' => 123,
    'codigoErro' => '<string>',
    'descCodigoErro' => '<string>',
    'dtHrReqJdPi' => '<string>',
    'idConciliacaoRecebedor' => '<string>',
    'stCancelamento' => 123
  ]),
  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-status"

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

require 'uri'
require 'net/http'

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

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  \"dtHrSituacao\": \"<string>\",\n  \"endToEndId\": \"<string>\",\n  \"idCancelamento\": \"<string>\",\n  \"ispbDestinatario\": \"<string>\",\n  \"ispbSolicitante\": \"<string>\",\n  \"motivoCancelamento\": 123,\n  \"solCancelamento\": 123,\n  \"stJdPi\": 123,\n  \"stJdPiProc\": 123,\n  \"tpPessoaSol\": 123,\n  \"codigoErro\": \"<string>\",\n  \"descCodigoErro\": \"<string>\",\n  \"dtHrReqJdPi\": \"<string>\",\n  \"idConciliacaoRecebedor\": \"<string>\",\n  \"stCancelamento\": 123\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).

dtHrSituacao

string

required

Situation-query timestamp (UTC).

endToEndId

string

required

Unique payment-instruction id (32-char).

idCancelamento

string

required

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

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).

stJdPi

integer<int64>

required

Overall cancellation situation (-1/0/9).

stJdPiProc

integer<int64>

required

Intermediate cancellation-processing situation (0/1/2/5/7/8/9).

tpPessoaSol

integer<int64>

required

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

codigoErro

string

Upstream error code (on a rejection or internal error).

descCodigoErro

string

Upstream error description.

dtHrReqJdPi

string

Upstream request registration timestamp (UTC).

idConciliacaoRecebedor

string

Receiver conciliation id (35-char).

stCancelamento

integer<int64>

Cancellation status (0=Aceito, 1=Rejeitado); OPTIONAL, absent => no-op.

Response

No Content

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Receive a Pix Automático schedule cancellation status event

Authorizations

Headers

Body

Response