Validate an inbound Pix Automático authorization
curl --request POST \
--url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dtHrCriacaoRecorrencia": "<string>",
"dtInicialRecorrencia": "<string>",
"idRecorrencia": "<string>",
"jornada": 123,
"nrContrato": "<string>",
"pagador": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"nrConta": "<string>",
"tpPessoa": 123,
"codMunIbge": 123,
"nrAgencia": "<string>"
},
"recebedor": {
"cnpj": "<string>",
"ispb": "<string>",
"nome": "<string>"
},
"retentativa": 123,
"tpFrequencia": 123,
"descContrato": "<string>",
"dtFinalRecorrencia": "<string>",
"dtHrAutorizacaoRecorrencia": "<string>",
"idSolicitacaoRecorrencia": "<string>",
"motivoRejeicao": "<string>",
"resultadoAutorizacao": true,
"valor": 123
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/validate"
payload = {
"dtHrCriacaoRecorrencia": "<string>",
"dtInicialRecorrencia": "<string>",
"idRecorrencia": "<string>",
"jornada": 123,
"nrContrato": "<string>",
"pagador": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"nrConta": "<string>",
"tpPessoa": 123,
"codMunIbge": 123,
"nrAgencia": "<string>"
},
"recebedor": {
"cnpj": "<string>",
"ispb": "<string>",
"nome": "<string>"
},
"retentativa": 123,
"tpFrequencia": 123,
"descContrato": "<string>",
"dtFinalRecorrencia": "<string>",
"dtHrAutorizacaoRecorrencia": "<string>",
"idSolicitacaoRecorrencia": "<string>",
"motivoRejeicao": "<string>",
"resultadoAutorizacao": True,
"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({
dtHrCriacaoRecorrencia: '<string>',
dtInicialRecorrencia: '<string>',
idRecorrencia: '<string>',
jornada: 123,
nrContrato: '<string>',
pagador: {
cpfCnpj: '<string>',
ispb: '<string>',
nrConta: '<string>',
tpPessoa: 123,
codMunIbge: 123,
nrAgencia: '<string>'
},
recebedor: {cnpj: '<string>', ispb: '<string>', nome: '<string>'},
retentativa: 123,
tpFrequencia: 123,
descContrato: '<string>',
dtFinalRecorrencia: '<string>',
dtHrAutorizacaoRecorrencia: '<string>',
idSolicitacaoRecorrencia: '<string>',
motivoRejeicao: '<string>',
resultadoAutorizacao: true,
valor: 123
})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/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/authorizations/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([
'dtHrCriacaoRecorrencia' => '<string>',
'dtInicialRecorrencia' => '<string>',
'idRecorrencia' => '<string>',
'jornada' => 123,
'nrContrato' => '<string>',
'pagador' => [
'cpfCnpj' => '<string>',
'ispb' => '<string>',
'nrConta' => '<string>',
'tpPessoa' => 123,
'codMunIbge' => 123,
'nrAgencia' => '<string>'
],
'recebedor' => [
'cnpj' => '<string>',
'ispb' => '<string>',
'nome' => '<string>'
],
'retentativa' => 123,
'tpFrequencia' => 123,
'descContrato' => '<string>',
'dtFinalRecorrencia' => '<string>',
'dtHrAutorizacaoRecorrencia' => '<string>',
'idSolicitacaoRecorrencia' => '<string>',
'motivoRejeicao' => '<string>',
'resultadoAutorizacao' => true,
'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/validate"
payload := strings.NewReader("{\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"jornada\": 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 \"retentativa\": 123,\n \"tpFrequencia\": 123,\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrAutorizacaoRecorrencia\": \"<string>\",\n \"idSolicitacaoRecorrencia\": \"<string>\",\n \"motivoRejeicao\": \"<string>\",\n \"resultadoAutorizacao\": true,\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/validate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"jornada\": 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 \"retentativa\": 123,\n \"tpFrequencia\": 123,\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrAutorizacaoRecorrencia\": \"<string>\",\n \"idSolicitacaoRecorrencia\": \"<string>\",\n \"motivoRejeicao\": \"<string>\",\n \"resultadoAutorizacao\": true,\n \"valor\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/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 \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"jornada\": 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 \"retentativa\": 123,\n \"tpFrequencia\": 123,\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrAutorizacaoRecorrencia\": \"<string>\",\n \"idSolicitacaoRecorrencia\": \"<string>\",\n \"motivoRejeicao\": \"<string>\",\n \"resultadoAutorizacao\": true,\n \"valor\": 123\n}"
response = http.request(request)
puts response.read_body{
"dtHrValidacao": "<string>",
"motivoRejeicao": "<string>",
"resultado": 123
}Validate an inbound Pix Automático authorization
Validates an inbound recurring-payment authorization request pushed by the upstream system. A synchronous validation returns the result inline (200); a Jornada-3 authorization returns 202-async with the eventual result delivered via the outbound 4.3.10 validation reply.
POST
/
v1
/
pix-automatico
/
authorizations
/
inbound
/
validate
Validate an inbound Pix Automático authorization
curl --request POST \
--url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dtHrCriacaoRecorrencia": "<string>",
"dtInicialRecorrencia": "<string>",
"idRecorrencia": "<string>",
"jornada": 123,
"nrContrato": "<string>",
"pagador": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"nrConta": "<string>",
"tpPessoa": 123,
"codMunIbge": 123,
"nrAgencia": "<string>"
},
"recebedor": {
"cnpj": "<string>",
"ispb": "<string>",
"nome": "<string>"
},
"retentativa": 123,
"tpFrequencia": 123,
"descContrato": "<string>",
"dtFinalRecorrencia": "<string>",
"dtHrAutorizacaoRecorrencia": "<string>",
"idSolicitacaoRecorrencia": "<string>",
"motivoRejeicao": "<string>",
"resultadoAutorizacao": true,
"valor": 123
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/validate"
payload = {
"dtHrCriacaoRecorrencia": "<string>",
"dtInicialRecorrencia": "<string>",
"idRecorrencia": "<string>",
"jornada": 123,
"nrContrato": "<string>",
"pagador": {
"cpfCnpj": "<string>",
"ispb": "<string>",
"nrConta": "<string>",
"tpPessoa": 123,
"codMunIbge": 123,
"nrAgencia": "<string>"
},
"recebedor": {
"cnpj": "<string>",
"ispb": "<string>",
"nome": "<string>"
},
"retentativa": 123,
"tpFrequencia": 123,
"descContrato": "<string>",
"dtFinalRecorrencia": "<string>",
"dtHrAutorizacaoRecorrencia": "<string>",
"idSolicitacaoRecorrencia": "<string>",
"motivoRejeicao": "<string>",
"resultadoAutorizacao": True,
"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({
dtHrCriacaoRecorrencia: '<string>',
dtInicialRecorrencia: '<string>',
idRecorrencia: '<string>',
jornada: 123,
nrContrato: '<string>',
pagador: {
cpfCnpj: '<string>',
ispb: '<string>',
nrConta: '<string>',
tpPessoa: 123,
codMunIbge: 123,
nrAgencia: '<string>'
},
recebedor: {cnpj: '<string>', ispb: '<string>', nome: '<string>'},
retentativa: 123,
tpFrequencia: 123,
descContrato: '<string>',
dtFinalRecorrencia: '<string>',
dtHrAutorizacaoRecorrencia: '<string>',
idSolicitacaoRecorrencia: '<string>',
motivoRejeicao: '<string>',
resultadoAutorizacao: true,
valor: 123
})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/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/authorizations/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([
'dtHrCriacaoRecorrencia' => '<string>',
'dtInicialRecorrencia' => '<string>',
'idRecorrencia' => '<string>',
'jornada' => 123,
'nrContrato' => '<string>',
'pagador' => [
'cpfCnpj' => '<string>',
'ispb' => '<string>',
'nrConta' => '<string>',
'tpPessoa' => 123,
'codMunIbge' => 123,
'nrAgencia' => '<string>'
],
'recebedor' => [
'cnpj' => '<string>',
'ispb' => '<string>',
'nome' => '<string>'
],
'retentativa' => 123,
'tpFrequencia' => 123,
'descContrato' => '<string>',
'dtFinalRecorrencia' => '<string>',
'dtHrAutorizacaoRecorrencia' => '<string>',
'idSolicitacaoRecorrencia' => '<string>',
'motivoRejeicao' => '<string>',
'resultadoAutorizacao' => true,
'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/validate"
payload := strings.NewReader("{\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"jornada\": 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 \"retentativa\": 123,\n \"tpFrequencia\": 123,\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrAutorizacaoRecorrencia\": \"<string>\",\n \"idSolicitacaoRecorrencia\": \"<string>\",\n \"motivoRejeicao\": \"<string>\",\n \"resultadoAutorizacao\": true,\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/validate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"jornada\": 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 \"retentativa\": 123,\n \"tpFrequencia\": 123,\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrAutorizacaoRecorrencia\": \"<string>\",\n \"idSolicitacaoRecorrencia\": \"<string>\",\n \"motivoRejeicao\": \"<string>\",\n \"resultadoAutorizacao\": true,\n \"valor\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/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 \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"jornada\": 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 \"retentativa\": 123,\n \"tpFrequencia\": 123,\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"dtHrAutorizacaoRecorrencia\": \"<string>\",\n \"idSolicitacaoRecorrencia\": \"<string>\",\n \"motivoRejeicao\": \"<string>\",\n \"resultadoAutorizacao\": true,\n \"valor\": 123\n}"
response = http.request(request)
puts response.read_body{
"dtHrValidacao": "<string>",
"motivoRejeicao": "<string>",
"resultado": 123
}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
Recurrence creation timestamp (UTC).
First payment date (aaaa-mm-dd).
Unique recurrence id (29-char, RR...).
Authorization journey (1..4).
Contract/order identifier (35-char).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Retry policy (0=none, 1=up to 3 in 7 days).
Recurrence periodicity (0..4).
Free-text contract description (35-char).
Show child attributes
Show child attributes
Last payment date (aaaa-mm-dd).
Authorization timestamp (UTC).
Confirmation-solicitation id (29-char, IS...).
Rejection reason code (4-char; required when resultadoAutorizacao=false).
Payer analysis result (true=Aceita, false=Rejeitada).
Fixed payment amount in reais (a JSON number).
Was this page helpful?
⌘I