Skip to main content
PUT
/
v1
/
pix-automatico
/
composite
/
recurrence
/
{id}
Update a recurrence-only composite Pix Automático QR code
curl --request PUT \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/recurrence/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recurrenceStatus": 123,
  "certificateIspb": "<string>",
  "debtorName": "<string>",
  "jwkUrl": "<string>",
  "recurrencePayloadUrl": "<string>",
  "startDate": "<string>",
  "txId": "<string>"
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/recurrence/{id}"

payload = {
"recurrenceStatus": 123,
"certificateIspb": "<string>",
"debtorName": "<string>",
"jwkUrl": "<string>",
"recurrencePayloadUrl": "<string>",
"startDate": "<string>",
"txId": "<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({
recurrenceStatus: 123,
certificateIspb: '<string>',
debtorName: '<string>',
jwkUrl: '<string>',
recurrencePayloadUrl: '<string>',
startDate: '<string>',
txId: '<string>'
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/recurrence/{id}', 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/composite/recurrence/{id}",
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([
'recurrenceStatus' => 123,
'certificateIspb' => '<string>',
'debtorName' => '<string>',
'jwkUrl' => '<string>',
'recurrencePayloadUrl' => '<string>',
'startDate' => '<string>',
'txId' => '<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/composite/recurrence/{id}"

payload := strings.NewReader("{\n \"recurrenceStatus\": 123,\n \"certificateIspb\": \"<string>\",\n \"debtorName\": \"<string>\",\n \"jwkUrl\": \"<string>\",\n \"recurrencePayloadUrl\": \"<string>\",\n \"startDate\": \"<string>\",\n \"txId\": \"<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/composite/recurrence/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recurrenceStatus\": 123,\n \"certificateIspb\": \"<string>\",\n \"debtorName\": \"<string>\",\n \"jwkUrl\": \"<string>\",\n \"recurrencePayloadUrl\": \"<string>\",\n \"startDate\": \"<string>\",\n \"txId\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/recurrence/{id}")

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 \"recurrenceStatus\": 123,\n \"certificateIspb\": \"<string>\",\n \"debtorName\": \"<string>\",\n \"jwkUrl\": \"<string>\",\n \"recurrencePayloadUrl\": \"<string>\",\n \"startDate\": \"<string>\",\n \"txId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "qrCode": "<string>",
  "documentId": "<string>",
  "payloadJws": "<string>",
  "recurrencePayload": "<string>",
  "revision": 123
}
{
"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

id
string
required

The recurrence/charge document id (idDocumento, GUID).

Body

application/json
recurrenceStatus
integer<int64>
required

stRecorrencia transition (0=Created,1=Approved,2=Rejected,3=Expired,4=Cancelled).

certificateIspb
string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

debtorName
string

Updated debtor name (devedor.nome).

jwkUrl
string

New JWK Set URL (urlJwk; no scheme).

recurrencePayloadUrl
string

New recurrence JWS host URL (urlPayloadJsonRec; no scheme).

startDate
string

New first payment date (dtInicialRecorrencia; aaaa-mm-dd).

txId
string

Conciliation id (idConciliacaoRecebedor).

Response

OK

qrCode
string
required

The regenerated EMV composite-QR payload (base64-decoded, ready to render).

documentId
string

The recurrence/charge document id (idDocumento, GUID).

payloadJws
string

The signed payment JWS (payloadJws; dynamic + cobv).

recurrencePayload
string

The signed recurrence JWS (payloadJwsRecorrencia).

revision
integer<int64>

The upstream-computed charge revision (revisao; dynamic + cobv updates only).