Pular para o conteúdo principal
POST
/
v1
/
pix-automatico
/
schedules
/
inbound
/
cancellation
/
validate
Validar cancelamento de agendamento de Pix Automático de entrada
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/inbound/cancellation/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cpfCnpjSolCancelamento": "<string>",
  "dtHrCancelamento": "<string>",
  "endToEndId": "<string>",
  "idCancelamento": "<string>",
  "idConciliacaoRecebedor": "<string>",
  "idRecorrencia": "<string>",
  "ispbDestinatario": "<string>",
  "ispbSolicitante": "<string>",
  "motivoCancelamento": 123,
  "solCancelamento": 123,
  "tpPessoaSol": 123
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/inbound/cancellation/validate"

payload = {
"cpfCnpjSolCancelamento": "<string>",
"dtHrCancelamento": "<string>",
"endToEndId": "<string>",
"idCancelamento": "<string>",
"idConciliacaoRecebedor": "<string>",
"idRecorrencia": "<string>",
"ispbDestinatario": "<string>",
"ispbSolicitante": "<string>",
"motivoCancelamento": 123,
"solCancelamento": 123,
"tpPessoaSol": 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>',
dtHrCancelamento: '<string>',
endToEndId: '<string>',
idCancelamento: '<string>',
idConciliacaoRecebedor: '<string>',
idRecorrencia: '<string>',
ispbDestinatario: '<string>',
ispbSolicitante: '<string>',
motivoCancelamento: 123,
solCancelamento: 123,
tpPessoaSol: 123
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/inbound/cancellation/validate', 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/schedules/inbound/cancellation/validate",
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,
'tpPessoaSol' => 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/schedules/inbound/cancellation/validate"

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 \"tpPessoaSol\": 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/schedules/inbound/cancellation/validate")
.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 \"tpPessoaSol\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/inbound/cancellation/validate")

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 \"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 \"tpPessoaSol\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "dtHrValidacao": "<string>",
  "resultado": 123,
  "motivoRejeicao": "<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).

dtHrCancelamento
string
obrigatório

Data/hora do cancelamento (UTC).

endToEndId
string
obrigatório

Id único de instrução de pagamento (32 caracteres).

idCancelamento
string
obrigatório

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

idConciliacaoRecebedor
string
obrigatório

Id de conciliação do recebedor (35 caracteres).

idRecorrencia
string
obrigatório

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

ispbDestinatario
string
obrigatório

ISPB do PSP de destino (8 dígitos, uma string v5.5.0).

ispbSolicitante
string
obrigatório

ISPB do PSP solicitante (8 dígitos, uma string v5.5.0).

motivoCancelamento
integer<int64>
obrigatório

Motivo do cancelamento (0..6).

solCancelamento
integer<int64>
obrigatório

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

tpPessoaSol
integer<int64>
obrigatório

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

Resposta

OK

dtHrValidacao
string
obrigatório

Data/hora da validação (UTC).

resultado
integer<int64>
obrigatório

Resultado da validação (0=Invalido, 1=Valido).

motivoRejeicao
string

Código de motivo de rejeição (obrigatório quando resultado=0).