Update an immediate dynamic composite Pix Automático QR code

curl --request PUT \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/dynamic/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "city": "<string>",
  "jwkUrl": "<string>",
  "key": "<string>",
  "originalAmount": 123,
  "paymentPayloadUrl": "<string>",
  "recipientName": "<string>",
  "recurrenceStatus": 123,
  "status": 123,
  "txId": "<string>",
  "certificateIspb": "<string>",
  "debtorName": "<string>",
  "description": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "expirationTime": 123,
  "payer": {
    "document": "<string>",
    "name": "<string>",
    "request": "<string>"
  },
  "recurrencePayloadUrl": "<string>",
  "startDate": "<string>",
  "zipCode": "<string>"
}
'

import requests

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

payload = {
    "city": "<string>",
    "jwkUrl": "<string>",
    "key": "<string>",
    "originalAmount": 123,
    "paymentPayloadUrl": "<string>",
    "recipientName": "<string>",
    "recurrenceStatus": 123,
    "status": 123,
    "txId": "<string>",
    "certificateIspb": "<string>",
    "debtorName": "<string>",
    "description": [
        {
            "name": "<string>",
            "value": "<string>"
        }
    ],
    "expirationTime": 123,
    "payer": {
        "document": "<string>",
        "name": "<string>",
        "request": "<string>"
    },
    "recurrencePayloadUrl": "<string>",
    "startDate": "<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({
    city: '<string>',
    jwkUrl: '<string>',
    key: '<string>',
    originalAmount: 123,
    paymentPayloadUrl: '<string>',
    recipientName: '<string>',
    recurrenceStatus: 123,
    status: 123,
    txId: '<string>',
    certificateIspb: '<string>',
    debtorName: '<string>',
    description: [{name: '<string>', value: '<string>'}],
    expirationTime: 123,
    payer: {document: '<string>', name: '<string>', request: '<string>'},
    recurrencePayloadUrl: '<string>',
    startDate: '<string>',
    zipCode: '<string>'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/dynamic/{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/dynamic/{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([
    'city' => '<string>',
    'jwkUrl' => '<string>',
    'key' => '<string>',
    'originalAmount' => 123,
    'paymentPayloadUrl' => '<string>',
    'recipientName' => '<string>',
    'recurrenceStatus' => 123,
    'status' => 123,
    'txId' => '<string>',
    'certificateIspb' => '<string>',
    'debtorName' => '<string>',
    'description' => [
        [
                'name' => '<string>',
                'value' => '<string>'
        ]
    ],
    'expirationTime' => 123,
    'payer' => [
        'document' => '<string>',
        'name' => '<string>',
        'request' => '<string>'
    ],
    'recurrencePayloadUrl' => '<string>',
    'startDate' => '<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/pix-automatico/composite/dynamic/{id}"

	payload := strings.NewReader("{\n  \"city\": \"<string>\",\n  \"jwkUrl\": \"<string>\",\n  \"key\": \"<string>\",\n  \"originalAmount\": 123,\n  \"paymentPayloadUrl\": \"<string>\",\n  \"recipientName\": \"<string>\",\n  \"recurrenceStatus\": 123,\n  \"status\": 123,\n  \"txId\": \"<string>\",\n  \"certificateIspb\": \"<string>\",\n  \"debtorName\": \"<string>\",\n  \"description\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"expirationTime\": 123,\n  \"payer\": {\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"request\": \"<string>\"\n  },\n  \"recurrencePayloadUrl\": \"<string>\",\n  \"startDate\": \"<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/pix-automatico/composite/dynamic/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"city\": \"<string>\",\n  \"jwkUrl\": \"<string>\",\n  \"key\": \"<string>\",\n  \"originalAmount\": 123,\n  \"paymentPayloadUrl\": \"<string>\",\n  \"recipientName\": \"<string>\",\n  \"recurrenceStatus\": 123,\n  \"status\": 123,\n  \"txId\": \"<string>\",\n  \"certificateIspb\": \"<string>\",\n  \"debtorName\": \"<string>\",\n  \"description\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"expirationTime\": 123,\n  \"payer\": {\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"request\": \"<string>\"\n  },\n  \"recurrencePayloadUrl\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"zipCode\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/dynamic/{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  \"city\": \"<string>\",\n  \"jwkUrl\": \"<string>\",\n  \"key\": \"<string>\",\n  \"originalAmount\": 123,\n  \"paymentPayloadUrl\": \"<string>\",\n  \"recipientName\": \"<string>\",\n  \"recurrenceStatus\": 123,\n  \"status\": 123,\n  \"txId\": \"<string>\",\n  \"certificateIspb\": \"<string>\",\n  \"debtorName\": \"<string>\",\n  \"description\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"expirationTime\": 123,\n  \"payer\": {\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"request\": \"<string>\"\n  },\n  \"recurrencePayloadUrl\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"zipCode\": \"<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"
}

PUT

pix-automatico

composite

dynamic

{id}

Update an immediate dynamic composite Pix Automático QR code

curl --request PUT \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/dynamic/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "city": "<string>",
  "jwkUrl": "<string>",
  "key": "<string>",
  "originalAmount": 123,
  "paymentPayloadUrl": "<string>",
  "recipientName": "<string>",
  "recurrenceStatus": 123,
  "status": 123,
  "txId": "<string>",
  "certificateIspb": "<string>",
  "debtorName": "<string>",
  "description": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "expirationTime": 123,
  "payer": {
    "document": "<string>",
    "name": "<string>",
    "request": "<string>"
  },
  "recurrencePayloadUrl": "<string>",
  "startDate": "<string>",
  "zipCode": "<string>"
}
'

import requests

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

payload = {
    "city": "<string>",
    "jwkUrl": "<string>",
    "key": "<string>",
    "originalAmount": 123,
    "paymentPayloadUrl": "<string>",
    "recipientName": "<string>",
    "recurrenceStatus": 123,
    "status": 123,
    "txId": "<string>",
    "certificateIspb": "<string>",
    "debtorName": "<string>",
    "description": [
        {
            "name": "<string>",
            "value": "<string>"
        }
    ],
    "expirationTime": 123,
    "payer": {
        "document": "<string>",
        "name": "<string>",
        "request": "<string>"
    },
    "recurrencePayloadUrl": "<string>",
    "startDate": "<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({
    city: '<string>',
    jwkUrl: '<string>',
    key: '<string>',
    originalAmount: 123,
    paymentPayloadUrl: '<string>',
    recipientName: '<string>',
    recurrenceStatus: 123,
    status: 123,
    txId: '<string>',
    certificateIspb: '<string>',
    debtorName: '<string>',
    description: [{name: '<string>', value: '<string>'}],
    expirationTime: 123,
    payer: {document: '<string>', name: '<string>', request: '<string>'},
    recurrencePayloadUrl: '<string>',
    startDate: '<string>',
    zipCode: '<string>'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/dynamic/{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/dynamic/{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([
    'city' => '<string>',
    'jwkUrl' => '<string>',
    'key' => '<string>',
    'originalAmount' => 123,
    'paymentPayloadUrl' => '<string>',
    'recipientName' => '<string>',
    'recurrenceStatus' => 123,
    'status' => 123,
    'txId' => '<string>',
    'certificateIspb' => '<string>',
    'debtorName' => '<string>',
    'description' => [
        [
                'name' => '<string>',
                'value' => '<string>'
        ]
    ],
    'expirationTime' => 123,
    'payer' => [
        'document' => '<string>',
        'name' => '<string>',
        'request' => '<string>'
    ],
    'recurrencePayloadUrl' => '<string>',
    'startDate' => '<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/pix-automatico/composite/dynamic/{id}"

	payload := strings.NewReader("{\n  \"city\": \"<string>\",\n  \"jwkUrl\": \"<string>\",\n  \"key\": \"<string>\",\n  \"originalAmount\": 123,\n  \"paymentPayloadUrl\": \"<string>\",\n  \"recipientName\": \"<string>\",\n  \"recurrenceStatus\": 123,\n  \"status\": 123,\n  \"txId\": \"<string>\",\n  \"certificateIspb\": \"<string>\",\n  \"debtorName\": \"<string>\",\n  \"description\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"expirationTime\": 123,\n  \"payer\": {\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"request\": \"<string>\"\n  },\n  \"recurrencePayloadUrl\": \"<string>\",\n  \"startDate\": \"<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/pix-automatico/composite/dynamic/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"city\": \"<string>\",\n  \"jwkUrl\": \"<string>\",\n  \"key\": \"<string>\",\n  \"originalAmount\": 123,\n  \"paymentPayloadUrl\": \"<string>\",\n  \"recipientName\": \"<string>\",\n  \"recurrenceStatus\": 123,\n  \"status\": 123,\n  \"txId\": \"<string>\",\n  \"certificateIspb\": \"<string>\",\n  \"debtorName\": \"<string>\",\n  \"description\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"expirationTime\": 123,\n  \"payer\": {\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"request\": \"<string>\"\n  },\n  \"recurrencePayloadUrl\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"zipCode\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/dynamic/{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  \"city\": \"<string>\",\n  \"jwkUrl\": \"<string>\",\n  \"key\": \"<string>\",\n  \"originalAmount\": 123,\n  \"paymentPayloadUrl\": \"<string>\",\n  \"recipientName\": \"<string>\",\n  \"recurrenceStatus\": 123,\n  \"status\": 123,\n  \"txId\": \"<string>\",\n  \"certificateIspb\": \"<string>\",\n  \"debtorName\": \"<string>\",\n  \"description\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"expirationTime\": 123,\n  \"payer\": {\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"request\": \"<string>\"\n  },\n  \"recurrencePayloadUrl\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"zipCode\": \"<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

string

required

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

Body

application/json

city

string

required

Merchant city (cidade).

jwkUrl

string

required

JWK Set URL (urlJwk; no scheme).

key

string

required

The recipient Pix key the composite QR pays into.

originalAmount

number<double>

required

Original charge amount in reais (valorOriginal).

paymentPayloadUrl

string

required

Payment JWS host URL (urlPayloadJson; no scheme).

recipientName

string

required

Recipient/beneficiary name (nomeRecebedor).

recurrenceStatus

integer<int64>

required

Recurrence stRecorrencia transition (0..4).

status

integer<int64>

required

Charge situation (0=Active,1=Completed,2=Removed by recipient,3=Removed by PSP).

txId

string

required

Conciliation id (idConciliacaoRecebedor).

certificateIspb

string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

debtorName

string

Updated debtor name (dadosRecorrencia.devedor.nome).

description

object[] | null

Optional additional-data entries (dadosAdicionais).

Show child attributes

expirationTime

integer<int64>

QR expiration in seconds.

payer

object

Show child attributes

recurrencePayloadUrl

string

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

startDate

string

Updated recurrence first payment date (dtInicialRecorrencia).

zipCode

string

Recipient postal code (cep).

Response

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).

⌘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 composite Pix Automático QR code

Authorizations

Path Parameters

Body

Response