Pular para o conteúdo principal
POST
/
v1
/
pix-automatico
/
authorizations
/
inbound
/
cancellation
/
register
Registrar cancelamento de Pix Automático de entrada
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"
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Corpo

application/json
​
cpfCnpjSolCancelamento
string
obrigatório

CPF/CNPJ do solicitante (uma string v5.5.0).

​
dtInicialRecorrencia
string
obrigatório

Data do primeiro pagamento (aaaa-mm-dd).

​
idCancelamento
string
obrigatório

Id único de cancelamento (29 caracteres, IC...).

​
idRecorrencia
string
obrigatório

Id único de recorrência (29 caracteres, RR...).

​
motivoCancelamento
integer<int64>
obrigatório

Motivo do cancelamento (0..10).

​
nrContrato
string
obrigatório

Identificador de contrato/pedido (35 caracteres).

​
pagador
object
obrigatório
​
recebedor
object
obrigatório
​
stCancelamento
integer<int64>
obrigatório

Status do cancelamento (0=Aceito, 1=Rejeitado).

​
tpFrequencia
integer<int64>
obrigatório

Periodicidade da recorrência (0..4).

​
tpPessoaSol
integer<int64>
obrigatório

Tipo de pessoa do solicitante (0=PF, 1=PJ).

​
codigoErro
string

Código de erro do upstream (100 caracteres; em um cancelamento rejeitado).

​
descCodigoErro
string

Descrição de erro do upstream (1000 caracteres).

​
descContrato
string

Descrição de contrato em texto livre (35 caracteres).

​
devedor
object
​
dtFinalRecorrencia
string

Data do último pagamento (aaaa-mm-dd).

​
dtHrCancelamento
string

Data/hora do cancelamento (UTC).

​
dtHrCriacaoRecorrencia
string

Data/hora de criação da recorrência (UTC).

​
valor
number<double>

Valor fixo de pagamento em reais (um número JSON).

Resposta

OK

​
dtHrSgct
string
obrigatório

carimbo de data/hora de registro do gateway de liquidação (UTC).

​
idSgct
string
obrigatório

Id local de cancelamento do gateway de liquidação (GUID de 36 caracteres).