Saltar al contenido principal
POST
/
v1
/
pix-automatico
/
schedules
/
inbound
/
cancellation
/
validate
Validar una cancelación de programación entrante de Pix Automático
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"
}

Autorizaciones

Authorization
string
header
requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Cuerpo

application/json
cpfCnpjSolCancelamento
string
requerido

CPF/CNPJ del solicitante (una cadena v5.5.0).

dtHrCancelamento
string
requerido

Marca de tiempo de la cancelación (UTC).

endToEndId
string
requerido

Id único de la instrucción de pago (32 caracteres).

idCancelamento
string
requerido

Id de cancelación único (29 caracteres, CA...).

idConciliacaoRecebedor
string
requerido

Id de conciliación del receptor (35 caracteres).

idRecorrencia
string
requerido

Id de recurrencia único (29 caracteres, RR...).

ispbDestinatario
string
requerido

ISPB del PSP de destino (8 dígitos, una cadena v5.5.0).

ispbSolicitante
string
requerido

ISPB del PSP solicitante (8 dígitos, una cadena v5.5.0).

motivoCancelamento
integer<int64>
requerido

Motivo de cancelación (0..6).

solCancelamento
integer<int64>
requerido

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

tpPessoaSol
integer<int64>
requerido

Tipo de persona del solicitante (0=PF, 1=PJ).

Respuesta

OK

dtHrValidacao
string
requerido

Marca de tiempo de la validación (UTC).

resultado
integer<int64>
requerido

Resultado de la validación (0=Invalido, 1=Valido).

motivoRejeicao
string

Código de motivo de rechazo (obligatorio cuando resultado=0).