Atualizar QR code composto de Pix Automático dinâmico imediato

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}

Atualizar QR code composto de Pix Automático dinâmico imediato

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

Autorizações

Authorization

string

header

obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de caminho

string

obrigatório

O id do documento da recorrência/cobrança (idDocumento, GUID).

Corpo

application/json

city

string

obrigatório

Cidade do estabelecimento (cidade).

jwkUrl

string

obrigatório

URL do JWK Set (urlJwk; sem esquema).

key

string

obrigatório

A chave Pix na qual o QR composto recebe.

originalAmount

number<double>

obrigatório

Valor original da cobrança em reais (valorOriginal).

paymentPayloadUrl

string

obrigatório

URL do host JWS de pagamento (urlPayloadJson; sem esquema).

recipientName

string

obrigatório

Nome do recebedor/beneficiário (nomeRecebedor).

recurrenceStatus

integer<int64>

obrigatório

Transição stRecorrencia da recorrência (0..4).

status

integer<int64>

obrigatório

Situação da cobrança (0=Ativa, 1=Concluída, 2=Removida pelo recebedor, 3=Removida pelo PSP).

txId

string

obrigatório

Id de conciliação (idConciliacaoRecebedor).

certificateIspb

string

ISPB do certificado do PSP indireto (ispbCertificadoJws, string).

debtorName

string

Nome do devedor atualizado (dadosRecorrencia.devedor.nome).

description

object[] | null

Entradas opcionais de dados adicionais (dadosAdicionais).

Show child attributes

expirationTime

integer<int64>

Expiração do QR em segundos.

payer

object

Show child attributes

recurrencePayloadUrl

string

URL do host JWS de recorrência (urlPayloadJsonRec; sem esquema).

startDate

string

Data do primeiro pagamento da recorrência atualizada (dtInicialRecorrencia).

zipCode

string

CEP do recebedor (cep).

Resposta

qrCode

string

obrigatório

A EMV composta-QR regenerada (payload decodificado em base64, pronto para renderizar).

documentId

string

O id do documento da recorrência/cobrança (idDocumento, GUID).

payloadJws

string

O JWS de pagamento assinado (payloadJws; dinâmico + cobv).

recurrencePayload

string

O JWS de recorrência assinado (payloadJwsRecorrencia).

revision

integer<int64>

A revisão de cobrança computada pelo upstream (revisao; somente atualizações dinâmico + cobv).

Pix — Lerian SPI (mensageria nativa)

Pix — JD (interface, direto)

Pix — BTG (interface, indireto)

TED — Lerian SPB (mensageria nativa)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (mensageria nativa)

Lerian SLC (mensageria nativa)

Lerian STA (mensageria nativa)

Lerian SISBAJUD (mensageria nativa)

Lerian Consignado — Dataprev

Atualizar QR code composto de Pix Automático dinâmico imediato

Autorizações

Parâmetros de caminho

Corpo

Resposta