Skip to main content
PUT
/
v1
/
pix-automatico
/
authorizations
/
{idRecorrencia}
/
respond
Respond to a Pix Automático authorization
curl --request PUT \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/respond \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountType": 123,
  "payerName": "<string>",
  "result": true,
  "authorizedAt": "<string>",
  "ibgeCode": 123,
  "payerMaxAmount": 123,
  "rejectionReason": "<string>"
}
'
import requests

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

payload = {
"accountType": 123,
"payerName": "<string>",
"result": True,
"authorizedAt": "<string>",
"ibgeCode": 123,
"payerMaxAmount": 123,
"rejectionReason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accountType: 123,
payerName: '<string>',
result: true,
authorizedAt: '<string>',
ibgeCode: 123,
payerMaxAmount: 123,
rejectionReason: '<string>'
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/respond', 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/{idRecorrencia}/respond",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'accountType' => 123,
'payerName' => '<string>',
'result' => true,
'authorizedAt' => '<string>',
'ibgeCode' => 123,
'payerMaxAmount' => 123,
'rejectionReason' => '<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/{idRecorrencia}/respond"

payload := strings.NewReader("{\n \"accountType\": 123,\n \"payerName\": \"<string>\",\n \"result\": true,\n \"authorizedAt\": \"<string>\",\n \"ibgeCode\": 123,\n \"payerMaxAmount\": 123,\n \"rejectionReason\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", 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.put("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/authorizations/{idRecorrencia}/respond")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountType\": 123,\n \"payerName\": \"<string>\",\n \"result\": true,\n \"authorizedAt\": \"<string>\",\n \"ibgeCode\": 123,\n \"payerMaxAmount\": 123,\n \"rejectionReason\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountType\": 123,\n \"payerName\": \"<string>\",\n \"result\": true,\n \"authorizedAt\": \"<string>\",\n \"ibgeCode\": 123,\n \"payerMaxAmount\": 123,\n \"rejectionReason\": \"<string>\"\n}"

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

Path Parameters

idRecorrencia
string
required

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

Body

application/json
accountType
integer<int64>
required

tpContaPagador (0..3).

payerName
string
required

Payer name (nomePagador).

result
boolean
required

resultadoAutorizacao (true=accept, false=reject).

authorizedAt
string

Authorization timestamp (dtHrAutorizacaoRecorrencia, UTC; required when accepting).

ibgeCode
integer<int64>

Municipality IBGE code (codMunIbge; required when accepting).

payerMaxAmount
number<double>

Payer max cap in reais (vlrMaxPagador).

rejectionReason
string

Rejection reason (motivoRejeicao; AP13/AP14/AP15; required when rejecting).

Response

Accepted

idRecorrencia
string
required

The recurrence id.

requestedAt
string
required

Upstream request timestamp (upstream request timestamp, UTC).

idReqJdPi
string

The upstream request id (36-char GUID; omitted by 4.3.10).

status
string

The resulting local authorization status.