Saltar al contenido principal
PUT
/
v1
/
qrcodes
/
dynamic
/
{documentId}
Actualizar un QR Pix dinámico inmediato
curl --request PUT \
  --url https://plugin-pix-direct.api.lerian.net/v1/qrcodes/dynamic/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "amount": 123,
  "key": "<string>",
  "status": 123,
  "description": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "expirationTime": 123,
  "payer": {
    "document": "<string>",
    "name": "<string>",
    "validate": true
  },
  "recipientConciliationId": "<string>",
  "zipCode": "<string>"
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/qrcodes/dynamic/{documentId}"

payload = {
"accountId": "<string>",
"amount": 123,
"key": "<string>",
"status": 123,
"description": [
{
"name": "<string>",
"value": "<string>"
}
],
"expirationTime": 123,
"payer": {
"document": "<string>",
"name": "<string>",
"validate": True
},
"recipientConciliationId": "<string>",
"zipCode": "<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({
accountId: '<string>',
amount: 123,
key: '<string>',
status: 123,
description: [{name: '<string>', value: '<string>'}],
expirationTime: 123,
payer: {document: '<string>', name: '<string>', validate: true},
recipientConciliationId: '<string>',
zipCode: '<string>'
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/qrcodes/dynamic/{documentId}', 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/qrcodes/dynamic/{documentId}",
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([
'accountId' => '<string>',
'amount' => 123,
'key' => '<string>',
'status' => 123,
'description' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'expirationTime' => 123,
'payer' => [
'document' => '<string>',
'name' => '<string>',
'validate' => true
],
'recipientConciliationId' => '<string>',
'zipCode' => '<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/qrcodes/dynamic/{documentId}"

payload := strings.NewReader("{\n \"accountId\": \"<string>\",\n \"amount\": 123,\n \"key\": \"<string>\",\n \"status\": 123,\n \"description\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"expirationTime\": 123,\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"validate\": true\n },\n \"recipientConciliationId\": \"<string>\",\n \"zipCode\": \"<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/qrcodes/dynamic/{documentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"<string>\",\n \"amount\": 123,\n \"key\": \"<string>\",\n \"status\": 123,\n \"description\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"expirationTime\": 123,\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"validate\": true\n },\n \"recipientConciliationId\": \"<string>\",\n \"zipCode\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/qrcodes/dynamic/{documentId}")

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 \"accountId\": \"<string>\",\n \"amount\": 123,\n \"key\": \"<string>\",\n \"status\": 123,\n \"description\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"expirationTime\": 123,\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"validate\": true\n },\n \"recipientConciliationId\": \"<string>\",\n \"zipCode\": \"<string>\"\n}"

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

documentId
string
requerido

The existing charge GUID to update. El GUID del cobro existente que se va a actualizar.

Cuerpo

application/json
accountId
string
requerido

El id de cuenta del CRM del beneficiario (aporta nombre + ciudad).

amount
number<double>
requerido

Monto en reales (un número JSON).

key
string
requerido

La clave Pix del beneficiario a la que paga el QR dinámico.

status
integer<int64>
requerido

Estado del cobro: 0=Active, 1=Concluded, 2=Removed by recipient, 3=Removed by PSP.

description
object[] | null

Entradas de datos adicionales opcionales (dadosAdicionais).

expirationTime
integer<int64>

Expiración del QR en segundos.

payer
object
recipientConciliationId
string

Id de conciliación (idConciliacaoRecebedor).

zipCode
string

Código postal del beneficiario (cep).

Respuesta

OK

qrCode
string
requerido

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

revision
integer<int64>
requerido

La revisión del cobro calculada por el upstream (revisao).

payloadUrl
string

La URL del host JWS resoluble que embebe el QR dinámico (urlPayloadJson; sin esquema).