Skip to main content
POST
/
v1
/
pix-automatico
/
authorizations
Request a Pix Automático authorization
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contractNumber": "<string>",
  "frequency": 123,
  "idRecorrencia": "<string>",
  "payer": {
    "account": "<string>",
    "cpfCnpj": "<string>",
    "ispb": "<string>",
    "personType": 123,
    "agency": "<string>"
  },
  "recipient": {
    "cnpj": "<string>",
    "ispb": "<string>",
    "name": "<string>"
  },
  "startDate": "<string>",
  "amount": 123,
  "contractDesc": "<string>",
  "createdDateTime": "<string>",
  "endDate": "<string>",
  "expirationDateTime": "<string>",
  "floorMaxAmount": 123,
  "solicitationDateTime": "<string>"
}
'
import requests

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

payload = {
    "contractNumber": "<string>",
    "frequency": 123,
    "idRecorrencia": "<string>",
    "payer": {
        "account": "<string>",
        "cpfCnpj": "<string>",
        "ispb": "<string>",
        "personType": 123,
        "agency": "<string>"
    },
    "recipient": {
        "cnpj": "<string>",
        "ispb": "<string>",
        "name": "<string>"
    },
    "startDate": "<string>",
    "amount": 123,
    "contractDesc": "<string>",
    "createdDateTime": "<string>",
    "endDate": "<string>",
    "expirationDateTime": "<string>",
    "floorMaxAmount": 123,
    "solicitationDateTime": "<string>"
}
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({
    contractNumber: '<string>',
    frequency: 123,
    idRecorrencia: '<string>',
    payer: {
      account: '<string>',
      cpfCnpj: '<string>',
      ispb: '<string>',
      personType: 123,
      agency: '<string>'
    },
    recipient: {cnpj: '<string>', ispb: '<string>', name: '<string>'},
    startDate: '<string>',
    amount: 123,
    contractDesc: '<string>',
    createdDateTime: '<string>',
    endDate: '<string>',
    expirationDateTime: '<string>',
    floorMaxAmount: 123,
    solicitationDateTime: '<string>'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations', 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",
  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([
    'contractNumber' => '<string>',
    'frequency' => 123,
    'idRecorrencia' => '<string>',
    'payer' => [
        'account' => '<string>',
        'cpfCnpj' => '<string>',
        'ispb' => '<string>',
        'personType' => 123,
        'agency' => '<string>'
    ],
    'recipient' => [
        'cnpj' => '<string>',
        'ispb' => '<string>',
        'name' => '<string>'
    ],
    'startDate' => '<string>',
    'amount' => 123,
    'contractDesc' => '<string>',
    'createdDateTime' => '<string>',
    'endDate' => '<string>',
    'expirationDateTime' => '<string>',
    'floorMaxAmount' => 123,
    'solicitationDateTime' => '<string>'
  ]),
  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"

	payload := strings.NewReader("{\n  \"contractNumber\": \"<string>\",\n  \"frequency\": 123,\n  \"idRecorrencia\": \"<string>\",\n  \"payer\": {\n    \"account\": \"<string>\",\n    \"cpfCnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"personType\": 123,\n    \"agency\": \"<string>\"\n  },\n  \"recipient\": {\n    \"cnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"startDate\": \"<string>\",\n  \"amount\": 123,\n  \"contractDesc\": \"<string>\",\n  \"createdDateTime\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"expirationDateTime\": \"<string>\",\n  \"floorMaxAmount\": 123,\n  \"solicitationDateTime\": \"<string>\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contractNumber\": \"<string>\",\n  \"frequency\": 123,\n  \"idRecorrencia\": \"<string>\",\n  \"payer\": {\n    \"account\": \"<string>\",\n    \"cpfCnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"personType\": 123,\n    \"agency\": \"<string>\"\n  },\n  \"recipient\": {\n    \"cnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"startDate\": \"<string>\",\n  \"amount\": 123,\n  \"contractDesc\": \"<string>\",\n  \"createdDateTime\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"expirationDateTime\": \"<string>\",\n  \"floorMaxAmount\": 123,\n  \"solicitationDateTime\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations")

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  \"contractNumber\": \"<string>\",\n  \"frequency\": 123,\n  \"idRecorrencia\": \"<string>\",\n  \"payer\": {\n    \"account\": \"<string>\",\n    \"cpfCnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"personType\": 123,\n    \"agency\": \"<string>\"\n  },\n  \"recipient\": {\n    \"cnpj\": \"<string>\",\n    \"ispb\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"startDate\": \"<string>\",\n  \"amount\": 123,\n  \"contractDesc\": \"<string>\",\n  \"createdDateTime\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"expirationDateTime\": \"<string>\",\n  \"floorMaxAmount\": 123,\n  \"solicitationDateTime\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "idRecorrencia": "<string>",
  "idReqJdPi": "<string>",
  "requestedAt": "<string>",
  "status": "<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
​
contractNumber
string
required

Contract/order identifier (nrContrato).

​
frequency
integer<int64>
required

tpFrequencia (0=Weekly,1=Monthly,2=Quarterly,3=Semiannual,4=Annual).

​
idRecorrencia
string
required

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

​
payer
object
required
​
recipient
object
required
​
startDate
string
required

First payment date (dtInicialRecorrencia; aaaa-mm-dd).

​
amount
number<double>

Fixed payment amount in reais (valor; omit/0 for a variable recurrence).

​
contractDesc
string

Free-text contract description (descContrato).

​
createdDateTime
string

Recurrence creation timestamp (dtHrCriacaoRecorrencia, UTC).

​
debtor
object
​
endDate
string

Last payment date (dtFinalRecorrencia; aaaa-mm-dd).

​
expirationDateTime
string

Solicitation expiration timestamp (dtHrExpiracaoSolicitacao, UTC).

​
floorMaxAmount
number<double>

Receiver floor in reais (pisoValorMaximo).

​
solicitationDateTime
string

Solicitation creation timestamp (dtHrCriacaoSolicitacao, UTC).

Response

Accepted

​
idRecorrencia
string
required

The recurrence id (echoed).

​
idReqJdPi
string
required

The upstream request id (36-char GUID).

​
requestedAt
string
required

Upstream request timestamp (upstream request timestamp, UTC).

​
status
string
required

The resulting local authorization status.