Register an inbound Pix Automático cancellation
curl --request POST \
--url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/cancellation/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cpfCnpjSolCancelamento": "<string>",
"dtInicialRecorrencia": "<string>",
"idCancelamento": "<string>",
"idRecorrencia": "<string>",
"motivoCancelamento": 123,
"nrContrato": "<string>",
"pagador": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"nrConta": "<string>",
"tpPessoa": 123,
"codMunIbge": 123,
"nrAgencia": "<string>"
},
"recebedor": {
"cnpj": "<string>",
"ispb": "<string>",
"nome": "<string>"
},
"stCancelamento": 123,
"tpFrequencia": 123,
"tpPessoaSol": 123,
"codigoErro": "<string>",
"descCodigoErro": "<string>",
"descContrato": "<string>",
"dtFinalRecorrencia": "<string>",
"dtHrCancelamento": "<string>",
"dtHrCriacaoRecorrencia": "<string>",
"valor": 123
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/cancellation/register"
payload = {
"cpfCnpjSolCancelamento": "<string>",
"dtInicialRecorrencia": "<string>",
"idCancelamento": "<string>",
"idRecorrencia": "<string>",
"motivoCancelamento": 123,
"nrContrato": "<string>",
"pagador": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"nrConta": "<string>",
"tpPessoa": 123,
"codMunIbge": 123,
"nrAgencia": "<string>"
},
"recebedor": {
"cnpj": "<string>",
"ispb": "<string>",
"nome": "<string>"
},
"stCancelamento": 123,
"tpFrequencia": 123,
"tpPessoaSol": 123,
"codigoErro": "<string>",
"descCodigoErro": "<string>",
"descContrato": "<string>",
"dtFinalRecorrencia": "<string>",
"dtHrCancelamento": "<string>",
"dtHrCriacaoRecorrencia": "<string>",
"valor": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cpfCnpjSolCancelamento: '<string>',
dtInicialRecorrencia: '<string>',
idCancelamento: '<string>',
idRecorrencia: '<string>',
motivoCancelamento: 123,
nrContrato: '<string>',
pagador: {
cpfCnpj: '<string>',
ispb: '<string>',
nrConta: '<string>',
tpPessoa: 123,
codMunIbge: 123,
nrAgencia: '<string>'
},
recebedor: {cnpj: '<string>', ispb: '<string>', nome: '<string>'},
stCancelamento: 123,
tpFrequencia: 123,
tpPessoaSol: 123,
codigoErro: '<string>',
descCodigoErro: '<string>',
descContrato: '<string>',
dtFinalRecorrencia: '<string>',
dtHrCancelamento: '<string>',
dtHrCriacaoRecorrencia: '<string>',
valor: 123
})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/cancellation/register', 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/authorizations/inbound/cancellation/register",
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>',
'dtInicialRecorrencia' => '<string>',
'idCancelamento' => '<string>',
'idRecorrencia' => '<string>',
'motivoCancelamento' => 123,
'nrContrato' => '<string>',
'pagador' => [
'cpfCnpj' => '<string>',
'ispb' => '<string>',
'nrConta' => '<string>',
'tpPessoa' => 123,
'codMunIbge' => 123,
'nrAgencia' => '<string>'
],
'recebedor' => [
'cnpj' => '<string>',
'ispb' => '<string>',
'nome' => '<string>'
],
'stCancelamento' => 123,
'tpFrequencia' => 123,
'tpPessoaSol' => 123,
'codigoErro' => '<string>',
'descCodigoErro' => '<string>',
'descContrato' => '<string>',
'dtFinalRecorrencia' => '<string>',
'dtHrCancelamento' => '<string>',
'dtHrCriacaoRecorrencia' => '<string>',
'valor' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/authorizations/inbound/cancellation/register"
payload := strings.NewReader("{\n \"cpfCnpjSolCancelamento\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idCancelamento\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"motivoCancelamento\": 123,\n \"nrContrato\": \"<string>\",\n \"pagador\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpPessoa\": 123,\n \"codMunIbge\": 123,\n \"nrAgencia\": \"<string>\"\n },\n \"recebedor\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nome\": \"<string>\"\n },\n \"stCancelamento\": 123,\n \"tpFrequencia\": 123,\n \"tpPessoaSol\": 123,\n \"codigoErro\": \"<string>\",\n \"descCodigoErro\": \"<string>\",\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrCancelamento\": \"<string>\",\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"valor\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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/authorizations/inbound/cancellation/register")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cpfCnpjSolCancelamento\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idCancelamento\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"motivoCancelamento\": 123,\n \"nrContrato\": \"<string>\",\n \"pagador\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpPessoa\": 123,\n \"codMunIbge\": 123,\n \"nrAgencia\": \"<string>\"\n },\n \"recebedor\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nome\": \"<string>\"\n },\n \"stCancelamento\": 123,\n \"tpFrequencia\": 123,\n \"tpPessoaSol\": 123,\n \"codigoErro\": \"<string>\",\n \"descCodigoErro\": \"<string>\",\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrCancelamento\": \"<string>\",\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"valor\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/cancellation/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cpfCnpjSolCancelamento\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idCancelamento\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"motivoCancelamento\": 123,\n \"nrContrato\": \"<string>\",\n \"pagador\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpPessoa\": 123,\n \"codMunIbge\": 123,\n \"nrAgencia\": \"<string>\"\n },\n \"recebedor\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nome\": \"<string>\"\n },\n \"stCancelamento\": 123,\n \"tpFrequencia\": 123,\n \"tpPessoaSol\": 123,\n \"codigoErro\": \"<string>\",\n \"descCodigoErro\": \"<string>\",\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrCancelamento\": \"<string>\",\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"valor\": 123\n}"
response = http.request(request)
puts response.read_body{
"dtHrSgct": "<string>",
"idSgct": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Register an inbound Pix Automático cancellation
Registers a recurring-payment cancellation outcome delivered by the upstream system. An accepted cancellation (stCancelamento=0) transitions the authorization to Cancelled and soft-deletes the row; a rejected cancellation (stCancelamento=1) is acknowledged with no state change. Returns the local settlement-gateway id.
POST
/
v1
/
pix-automatico
/
authorizations
/
inbound
/
cancellation
/
register
Register an inbound Pix Automático cancellation
curl --request POST \
--url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/cancellation/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cpfCnpjSolCancelamento": "<string>",
"dtInicialRecorrencia": "<string>",
"idCancelamento": "<string>",
"idRecorrencia": "<string>",
"motivoCancelamento": 123,
"nrContrato": "<string>",
"pagador": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"nrConta": "<string>",
"tpPessoa": 123,
"codMunIbge": 123,
"nrAgencia": "<string>"
},
"recebedor": {
"cnpj": "<string>",
"ispb": "<string>",
"nome": "<string>"
},
"stCancelamento": 123,
"tpFrequencia": 123,
"tpPessoaSol": 123,
"codigoErro": "<string>",
"descCodigoErro": "<string>",
"descContrato": "<string>",
"dtFinalRecorrencia": "<string>",
"dtHrCancelamento": "<string>",
"dtHrCriacaoRecorrencia": "<string>",
"valor": 123
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/cancellation/register"
payload = {
"cpfCnpjSolCancelamento": "<string>",
"dtInicialRecorrencia": "<string>",
"idCancelamento": "<string>",
"idRecorrencia": "<string>",
"motivoCancelamento": 123,
"nrContrato": "<string>",
"pagador": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"nrConta": "<string>",
"tpPessoa": 123,
"codMunIbge": 123,
"nrAgencia": "<string>"
},
"recebedor": {
"cnpj": "<string>",
"ispb": "<string>",
"nome": "<string>"
},
"stCancelamento": 123,
"tpFrequencia": 123,
"tpPessoaSol": 123,
"codigoErro": "<string>",
"descCodigoErro": "<string>",
"descContrato": "<string>",
"dtFinalRecorrencia": "<string>",
"dtHrCancelamento": "<string>",
"dtHrCriacaoRecorrencia": "<string>",
"valor": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cpfCnpjSolCancelamento: '<string>',
dtInicialRecorrencia: '<string>',
idCancelamento: '<string>',
idRecorrencia: '<string>',
motivoCancelamento: 123,
nrContrato: '<string>',
pagador: {
cpfCnpj: '<string>',
ispb: '<string>',
nrConta: '<string>',
tpPessoa: 123,
codMunIbge: 123,
nrAgencia: '<string>'
},
recebedor: {cnpj: '<string>', ispb: '<string>', nome: '<string>'},
stCancelamento: 123,
tpFrequencia: 123,
tpPessoaSol: 123,
codigoErro: '<string>',
descCodigoErro: '<string>',
descContrato: '<string>',
dtFinalRecorrencia: '<string>',
dtHrCancelamento: '<string>',
dtHrCriacaoRecorrencia: '<string>',
valor: 123
})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/cancellation/register', 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/authorizations/inbound/cancellation/register",
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>',
'dtInicialRecorrencia' => '<string>',
'idCancelamento' => '<string>',
'idRecorrencia' => '<string>',
'motivoCancelamento' => 123,
'nrContrato' => '<string>',
'pagador' => [
'cpfCnpj' => '<string>',
'ispb' => '<string>',
'nrConta' => '<string>',
'tpPessoa' => 123,
'codMunIbge' => 123,
'nrAgencia' => '<string>'
],
'recebedor' => [
'cnpj' => '<string>',
'ispb' => '<string>',
'nome' => '<string>'
],
'stCancelamento' => 123,
'tpFrequencia' => 123,
'tpPessoaSol' => 123,
'codigoErro' => '<string>',
'descCodigoErro' => '<string>',
'descContrato' => '<string>',
'dtFinalRecorrencia' => '<string>',
'dtHrCancelamento' => '<string>',
'dtHrCriacaoRecorrencia' => '<string>',
'valor' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/authorizations/inbound/cancellation/register"
payload := strings.NewReader("{\n \"cpfCnpjSolCancelamento\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idCancelamento\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"motivoCancelamento\": 123,\n \"nrContrato\": \"<string>\",\n \"pagador\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpPessoa\": 123,\n \"codMunIbge\": 123,\n \"nrAgencia\": \"<string>\"\n },\n \"recebedor\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nome\": \"<string>\"\n },\n \"stCancelamento\": 123,\n \"tpFrequencia\": 123,\n \"tpPessoaSol\": 123,\n \"codigoErro\": \"<string>\",\n \"descCodigoErro\": \"<string>\",\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrCancelamento\": \"<string>\",\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"valor\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
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/authorizations/inbound/cancellation/register")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cpfCnpjSolCancelamento\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idCancelamento\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"motivoCancelamento\": 123,\n \"nrContrato\": \"<string>\",\n \"pagador\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpPessoa\": 123,\n \"codMunIbge\": 123,\n \"nrAgencia\": \"<string>\"\n },\n \"recebedor\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nome\": \"<string>\"\n },\n \"stCancelamento\": 123,\n \"tpFrequencia\": 123,\n \"tpPessoaSol\": 123,\n \"codigoErro\": \"<string>\",\n \"descCodigoErro\": \"<string>\",\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrCancelamento\": \"<string>\",\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"valor\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/cancellation/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cpfCnpjSolCancelamento\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idCancelamento\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"motivoCancelamento\": 123,\n \"nrContrato\": \"<string>\",\n \"pagador\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpPessoa\": 123,\n \"codMunIbge\": 123,\n \"nrAgencia\": \"<string>\"\n },\n \"recebedor\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nome\": \"<string>\"\n },\n \"stCancelamento\": 123,\n \"tpFrequencia\": 123,\n \"tpPessoaSol\": 123,\n \"codigoErro\": \"<string>\",\n \"descCodigoErro\": \"<string>\",\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrCancelamento\": \"<string>\",\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"valor\": 123\n}"
response = http.request(request)
puts response.read_body{
"dtHrSgct": "<string>",
"idSgct": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Authorizations
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).
Body
application/json
Requester CPF/CNPJ (a v5.5.0 string).
First payment date (aaaa-mm-dd).
Unique cancellation id (29-char, IC...).
Unique recurrence id (29-char, RR...).
Cancellation reason (0..10).
Contract/order identifier (35-char).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Cancellation status (0=Aceito, 1=Rejeitado).
Recurrence periodicity (0..4).
Requester person type (0=PF, 1=PJ).
Upstream error code (100-char; on a rejected cancellation).
Upstream error description (1000-char).
Free-text contract description (35-char).
Show child attributes
Show child attributes
Last payment date (aaaa-mm-dd).
Cancellation timestamp (UTC).
Recurrence creation timestamp (UTC).
Fixed payment amount in reais (a JSON number).
Was this page helpful?
⌘I