Pular para o conteúdo principal
POST
/
v1
/
pix-automatico
/
schedules
/
inbound
/
validate
Validar instrução de pagamento de Pix Automático de entrada
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/inbound/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtVencimento": "<string>",
  "endToEndId": "<string>",
  "finalidadeAgendamento": 123,
  "idConciliacaoRecebedor": "<string>",
  "idRecorrencia": "<string>",
  "pagador": {
    "cpfCnpj": "<string>",
    "ispb": "<string>",
    "tpPessoa": 123
  },
  "recebedor": {
    "cnpj": "<string>",
    "ispb": "<string>",
    "nome": "<string>",
    "nrConta": "<string>",
    "tpConta": 123,
    "nrAgencia": "<string>"
  },
  "dtHrRecepcaoPspRecebedor": "<string>",
  "infEntreClientes": "<string>",
  "valor": 123
}
'
import requests

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

payload = {
"dtVencimento": "<string>",
"endToEndId": "<string>",
"finalidadeAgendamento": 123,
"idConciliacaoRecebedor": "<string>",
"idRecorrencia": "<string>",
"pagador": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"tpPessoa": 123
},
"recebedor": {
"cnpj": "<string>",
"ispb": "<string>",
"nome": "<string>",
"nrConta": "<string>",
"tpConta": 123,
"nrAgencia": "<string>"
},
"dtHrRecepcaoPspRecebedor": "<string>",
"infEntreClientes": "<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({
dtVencimento: '<string>',
endToEndId: '<string>',
finalidadeAgendamento: 123,
idConciliacaoRecebedor: '<string>',
idRecorrencia: '<string>',
pagador: {cpfCnpj: '<string>', ispb: '<string>', tpPessoa: 123},
recebedor: {
cnpj: '<string>',
ispb: '<string>',
nome: '<string>',
nrConta: '<string>',
tpConta: 123,
nrAgencia: '<string>'
},
dtHrRecepcaoPspRecebedor: '<string>',
infEntreClientes: '<string>',
valor: 123
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/inbound/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/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([
'dtVencimento' => '<string>',
'endToEndId' => '<string>',
'finalidadeAgendamento' => 123,
'idConciliacaoRecebedor' => '<string>',
'idRecorrencia' => '<string>',
'pagador' => [
'cpfCnpj' => '<string>',
'ispb' => '<string>',
'tpPessoa' => 123
],
'recebedor' => [
'cnpj' => '<string>',
'ispb' => '<string>',
'nome' => '<string>',
'nrConta' => '<string>',
'tpConta' => 123,
'nrAgencia' => '<string>'
],
'dtHrRecepcaoPspRecebedor' => '<string>',
'infEntreClientes' => '<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/schedules/inbound/validate"

payload := strings.NewReader("{\n \"dtVencimento\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"finalidadeAgendamento\": 123,\n \"idConciliacaoRecebedor\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"pagador\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"tpPessoa\": 123\n },\n \"recebedor\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nome\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpConta\": 123,\n \"nrAgencia\": \"<string>\"\n },\n \"dtHrRecepcaoPspRecebedor\": \"<string>\",\n \"infEntreClientes\": \"<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/schedules/inbound/validate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dtVencimento\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"finalidadeAgendamento\": 123,\n \"idConciliacaoRecebedor\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"pagador\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"tpPessoa\": 123\n },\n \"recebedor\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nome\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpConta\": 123,\n \"nrAgencia\": \"<string>\"\n },\n \"dtHrRecepcaoPspRecebedor\": \"<string>\",\n \"infEntreClientes\": \"<string>\",\n \"valor\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/schedules/inbound/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 \"dtVencimento\": \"<string>\",\n \"endToEndId\": \"<string>\",\n \"finalidadeAgendamento\": 123,\n \"idConciliacaoRecebedor\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"pagador\": {\n \"cpfCnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"tpPessoa\": 123\n },\n \"recebedor\": {\n \"cnpj\": \"<string>\",\n \"ispb\": \"<string>\",\n \"nome\": \"<string>\",\n \"nrConta\": \"<string>\",\n \"tpConta\": 123,\n \"nrAgencia\": \"<string>\"\n },\n \"dtHrRecepcaoPspRecebedor\": \"<string>\",\n \"infEntreClientes\": \"<string>\",\n \"valor\": 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
dtVencimento
string
obrigatório

Data de vencimento da cobrança recorrente (aaaa-mm-dd).

endToEndId
string
obrigatório

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

finalidadeAgendamento
integer<int64>
obrigatório

Finalidade do agendamento (0=primeiro, 1=retentativa pós-vencimento, 2=reenvio de liquidação).

idConciliacaoRecebedor
string
obrigatório

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

idRecorrencia
string
obrigatório

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

pagador
object
obrigatório
recebedor
object
obrigatório
devedor
object
dtHrRecepcaoPspRecebedor
string

Data/hora de recepção do PSP recebedor (UTC; obrigatório quando finalidadeAgendamento=0).

infEntreClientes
string

Informação em texto livre do recebedor para o pagador (140 caracteres).

valor
number<double>

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

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