Saltar al contenido principal
PUT
/
v1
/
pix-automatico
/
composite
/
recurrence
/
{id}
Actualizar un QR compuesto de Pix Automático solo de recurrencia
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"
}

Autorizaciones

Authorization
string
header
requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Parámetros de ruta

id
string
requerido

The recurrence/charge document id (idDocumento, GUID). El id de documento de la recurrencia/cobro (idDocumento, GUID).

Cuerpo

application/json
recurrenceStatus
integer<int64>
requerido

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

certificateIspb
string

ISPB del certificado del PSP indirecto (ispbCertificadoJws, cadena).

debtorName
string

Nombre del deudor actualizado (devedor.nome).

jwkUrl
string

Nueva URL del JWK Set (urlJwk; sin esquema).

recurrencePayloadUrl
string

Nueva URL del host JWS de la recurrencia (urlPayloadJsonRec; sin esquema).

startDate
string

Nueva fecha del primer pago (dtInicialRecorrencia; aaaa-mm-dd).

txId
string

Id de conciliación (idConciliacaoRecebedor).

Respuesta

OK

qrCode
string
requerido

El payload del QR compuesto EMV regenerado (decodificado de base64, listo para renderizar).

documentId
string

El id de documento de la recurrencia/cobro (idDocumento, GUID).

payloadJws
string

El JWS de pago firmado (payloadJws; dynamic + cobv).

recurrencePayload
string

El JWS de recurrencia firmado (payloadJwsRecorrencia).

revision
integer<int64>

La revisión del cobro calculada por el upstream (revisao; solo para actualizaciones dynamic + cobv).