Update an immediate dynamic Pix QR code

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"
}

Update an immediate dynamic Pix QR code

Updates an existing immediate dynamic Pix QR code: the charge amount, conciliation, expiration, optional payer, and the charge status (0=Active, 1=Concluded, 2=Removed by recipient, 3=Removed by PSP). The recipient name + city are CRM-sourced (never the body). The service re-hosts the updated signed JWS so the QR stays end-to-end resolvable; the response carries the upstream revision and the resolvable payload URL.

PUT

qrcodes

dynamic

{documentId}

Update an immediate dynamic Pix QR code

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"
}

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

documentId

string

required

The existing charge GUID to update.

Body

application/json

accountId

string

required

The CRM account id of the recipient (sources name + city).

amount

number<double>

required

Amount in reais (a JSON number).

key

string

required

The recipient Pix key the dynamic QR pays into.

status

integer<int64>

required

Charge status: 0=Active, 1=Concluded, 2=Removed by recipient, 3=Removed by PSP.

description

object[] | null

Optional additional-data entries (dadosAdicionais).

Show child attributes

expirationTime

integer<int64>

QR expiration in seconds.

payer

object

Show child attributes

recipientConciliationId

string

Conciliation id (idConciliacaoRecebedor).

zipCode

string

Recipient postal code (cep).

Response

qrCode

string

required

The updated EMV QR-code payload (base64-decoded, ready to render).

revision

integer<int64>

required

The upstream-computed charge revision (revisao).

payloadUrl

string

The resolvable JWS host URL the dynamic QR embeds (urlPayloadJson; schema-less).

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Update an immediate dynamic Pix QR code

Authorizations

Path Parameters

Body

Response