Skip to main content
POST
/
v1
/
pix-automatico
/
authorizations
/
inbound
/
recipient
/
register
Register an inbound Pix Automático authorization on the PSP Recebedor
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/recipient/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtHrAutorizacaoRecorrencia": "<string>",
  "dtHrCriacaoRecorrencia": "<string>",
  "dtInicialRecorrencia": "<string>",
  "idRecorrencia": "<string>",
  "idReqJdPi": "<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>"
  },
  "resultadoAutorizacao": true,
  "retentativa": 123,
  "tpFrequencia": 123,
  "descContrato": "<string>",
  "dtFinalRecorrencia": "<string>",
  "motivoRejeicao": "<string>",
  "valor": 123
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/recipient/register"

payload = {
"dtHrAutorizacaoRecorrencia": "<string>",
"dtHrCriacaoRecorrencia": "<string>",
"dtInicialRecorrencia": "<string>",
"idRecorrencia": "<string>",
"idReqJdPi": "<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>"
},
"resultadoAutorizacao": True,
"retentativa": 123,
"tpFrequencia": 123,
"descContrato": "<string>",
"dtFinalRecorrencia": "<string>",
"motivoRejeicao": "<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({
dtHrAutorizacaoRecorrencia: '<string>',
dtHrCriacaoRecorrencia: '<string>',
dtInicialRecorrencia: '<string>',
idRecorrencia: '<string>',
idReqJdPi: '<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>'},
resultadoAutorizacao: true,
retentativa: 123,
tpFrequencia: 123,
descContrato: '<string>',
dtFinalRecorrencia: '<string>',
motivoRejeicao: '<string>',
valor: 123
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/inbound/recipient/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/recipient/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([
'dtHrAutorizacaoRecorrencia' => '<string>',
'dtHrCriacaoRecorrencia' => '<string>',
'dtInicialRecorrencia' => '<string>',
'idRecorrencia' => '<string>',
'idReqJdPi' => '<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>'
],
'resultadoAutorizacao' => true,
'retentativa' => 123,
'tpFrequencia' => 123,
'descContrato' => '<string>',
'dtFinalRecorrencia' => '<string>',
'motivoRejeicao' => '<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/recipient/register"

payload := strings.NewReader("{\n \"dtHrAutorizacaoRecorrencia\": \"<string>\",\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"idReqJdPi\": \"<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 \"resultadoAutorizacao\": true,\n \"retentativa\": 123,\n \"tpFrequencia\": 123,\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"motivoRejeicao\": \"<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/recipient/register")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dtHrAutorizacaoRecorrencia\": \"<string>\",\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"idReqJdPi\": \"<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 \"resultadoAutorizacao\": true,\n \"retentativa\": 123,\n \"tpFrequencia\": 123,\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"motivoRejeicao\": \"<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/recipient/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 \"dtHrAutorizacaoRecorrencia\": \"<string>\",\n \"dtHrCriacaoRecorrencia\": \"<string>\",\n \"dtInicialRecorrencia\": \"<string>\",\n \"idRecorrencia\": \"<string>\",\n \"idReqJdPi\": \"<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 \"resultadoAutorizacao\": true,\n \"retentativa\": 123,\n \"tpFrequencia\": 123,\n \"descContrato\": \"<string>\",\n \"dtFinalRecorrencia\": \"<string>\",\n \"motivoRejeicao\": \"<string>\",\n \"valor\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "dtHrSgct": "<string>",
  "idReqJdPi": "<string>",
  "idSgct": "<string>"
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Authorizations

Authorization
string
header
required

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
dtHrAutorizacaoRecorrencia
string
required

Authorization timestamp (UTC).

dtHrCriacaoRecorrencia
string
required

Recurrence creation timestamp (UTC).

dtInicialRecorrencia
string
required

First payment date (aaaa-mm-dd).

idRecorrencia
string
required

Unique recurrence id (29-char, RR...).

idReqJdPi
string
required

Upstream request id (36-char GUID).

jornada
integer<int64>
required

Authorization journey (2..4).

nrContrato
string
required

Contract/order identifier (35-char).

pagador
object
required
recebedor
object
required
resultadoAutorizacao
boolean
required

Payer analysis result (true=Aceita, false=Rejeitada).

retentativa
integer<int64>
required

Retry policy (0=none, 1=up to 3 in 7 days).

tpFrequencia
integer<int64>
required

Recurrence periodicity (0..4).

descContrato
string

Free-text contract description (35-char).

devedor
object
dtFinalRecorrencia
string

Last payment date (aaaa-mm-dd).

motivoRejeicao
string

Rejection reason code (4-char; required when resultadoAutorizacao=false).

valor
number<double>

Fixed payment amount in reais (a JSON number).

Response

OK

dtHrSgct
string
required

settlement-gateway registration timestamp (UTC).

idReqJdPi
string
required

Echoed upstream request id (36-char GUID).

idSgct
string
required

Local settlement-gateway authorization id (36-char GUID).