Update a CobV (due-date) composite Pix Automático QR code
curl --request PUT \
--url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"city": "<string>",
"daysAfterDue": 123,
"dueDate": "<string>",
"finalAmount": 123,
"key": "<string>",
"paymentPayloadUrl": "<string>",
"recipientName": "<string>",
"recipientStreet": "<string>",
"recurrenceStatus": 123,
"state": "<string>",
"status": 123,
"txId": "<string>",
"zipCode": "<string>",
"certificateIspb": "<string>",
"debtorName": "<string>",
"description": [
{
"name": "<string>",
"value": "<string>"
}
],
"discount": 123,
"fine": 123,
"interest": 123,
"jwkUrl": "<string>",
"originalAmount": 123,
"payer": {
"document": "<string>",
"name": "<string>",
"request": "<string>"
},
"rebate": 123,
"recurrencePayloadUrl": "<string>",
"startDate": "<string>"
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv/{id}"
payload = {
"city": "<string>",
"daysAfterDue": 123,
"dueDate": "<string>",
"finalAmount": 123,
"key": "<string>",
"paymentPayloadUrl": "<string>",
"recipientName": "<string>",
"recipientStreet": "<string>",
"recurrenceStatus": 123,
"state": "<string>",
"status": 123,
"txId": "<string>",
"zipCode": "<string>",
"certificateIspb": "<string>",
"debtorName": "<string>",
"description": [
{
"name": "<string>",
"value": "<string>"
}
],
"discount": 123,
"fine": 123,
"interest": 123,
"jwkUrl": "<string>",
"originalAmount": 123,
"payer": {
"document": "<string>",
"name": "<string>",
"request": "<string>"
},
"rebate": 123,
"recurrencePayloadUrl": "<string>",
"startDate": "<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>',
daysAfterDue: 123,
dueDate: '<string>',
finalAmount: 123,
key: '<string>',
paymentPayloadUrl: '<string>',
recipientName: '<string>',
recipientStreet: '<string>',
recurrenceStatus: 123,
state: '<string>',
status: 123,
txId: '<string>',
zipCode: '<string>',
certificateIspb: '<string>',
debtorName: '<string>',
description: [{name: '<string>', value: '<string>'}],
discount: 123,
fine: 123,
interest: 123,
jwkUrl: '<string>',
originalAmount: 123,
payer: {document: '<string>', name: '<string>', request: '<string>'},
rebate: 123,
recurrencePayloadUrl: '<string>',
startDate: '<string>'
})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv/{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/cobv/{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>',
'daysAfterDue' => 123,
'dueDate' => '<string>',
'finalAmount' => 123,
'key' => '<string>',
'paymentPayloadUrl' => '<string>',
'recipientName' => '<string>',
'recipientStreet' => '<string>',
'recurrenceStatus' => 123,
'state' => '<string>',
'status' => 123,
'txId' => '<string>',
'zipCode' => '<string>',
'certificateIspb' => '<string>',
'debtorName' => '<string>',
'description' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'discount' => 123,
'fine' => 123,
'interest' => 123,
'jwkUrl' => '<string>',
'originalAmount' => 123,
'payer' => [
'document' => '<string>',
'name' => '<string>',
'request' => '<string>'
],
'rebate' => 123,
'recurrencePayloadUrl' => '<string>',
'startDate' => '<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/cobv/{id}"
payload := strings.NewReader("{\n \"city\": \"<string>\",\n \"daysAfterDue\": 123,\n \"dueDate\": \"<string>\",\n \"finalAmount\": 123,\n \"key\": \"<string>\",\n \"paymentPayloadUrl\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientStreet\": \"<string>\",\n \"recurrenceStatus\": 123,\n \"state\": \"<string>\",\n \"status\": 123,\n \"txId\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"certificateIspb\": \"<string>\",\n \"debtorName\": \"<string>\",\n \"description\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"discount\": 123,\n \"fine\": 123,\n \"interest\": 123,\n \"jwkUrl\": \"<string>\",\n \"originalAmount\": 123,\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"request\": \"<string>\"\n },\n \"rebate\": 123,\n \"recurrencePayloadUrl\": \"<string>\",\n \"startDate\": \"<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/cobv/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"city\": \"<string>\",\n \"daysAfterDue\": 123,\n \"dueDate\": \"<string>\",\n \"finalAmount\": 123,\n \"key\": \"<string>\",\n \"paymentPayloadUrl\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientStreet\": \"<string>\",\n \"recurrenceStatus\": 123,\n \"state\": \"<string>\",\n \"status\": 123,\n \"txId\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"certificateIspb\": \"<string>\",\n \"debtorName\": \"<string>\",\n \"description\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"discount\": 123,\n \"fine\": 123,\n \"interest\": 123,\n \"jwkUrl\": \"<string>\",\n \"originalAmount\": 123,\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"request\": \"<string>\"\n },\n \"rebate\": 123,\n \"recurrencePayloadUrl\": \"<string>\",\n \"startDate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv/{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 \"daysAfterDue\": 123,\n \"dueDate\": \"<string>\",\n \"finalAmount\": 123,\n \"key\": \"<string>\",\n \"paymentPayloadUrl\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientStreet\": \"<string>\",\n \"recurrenceStatus\": 123,\n \"state\": \"<string>\",\n \"status\": 123,\n \"txId\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"certificateIspb\": \"<string>\",\n \"debtorName\": \"<string>\",\n \"description\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"discount\": 123,\n \"fine\": 123,\n \"interest\": 123,\n \"jwkUrl\": \"<string>\",\n \"originalAmount\": 123,\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"request\": \"<string>\"\n },\n \"rebate\": 123,\n \"recurrencePayloadUrl\": \"<string>\",\n \"startDate\": \"<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"
}Update a CobV (due-date) composite Pix Automático QR code
Updates a previously generated CobV (cobrança com vencimento) composite Pix QR code, keyed by its document id (idDocumento). The response carries the upstream-computed revision (revisao).
PUT
/
v1
/
pix-automatico
/
composite
/
cobv
/
{id}
Update a CobV (due-date) composite Pix Automático QR code
curl --request PUT \
--url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"city": "<string>",
"daysAfterDue": 123,
"dueDate": "<string>",
"finalAmount": 123,
"key": "<string>",
"paymentPayloadUrl": "<string>",
"recipientName": "<string>",
"recipientStreet": "<string>",
"recurrenceStatus": 123,
"state": "<string>",
"status": 123,
"txId": "<string>",
"zipCode": "<string>",
"certificateIspb": "<string>",
"debtorName": "<string>",
"description": [
{
"name": "<string>",
"value": "<string>"
}
],
"discount": 123,
"fine": 123,
"interest": 123,
"jwkUrl": "<string>",
"originalAmount": 123,
"payer": {
"document": "<string>",
"name": "<string>",
"request": "<string>"
},
"rebate": 123,
"recurrencePayloadUrl": "<string>",
"startDate": "<string>"
}
'import requests
url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv/{id}"
payload = {
"city": "<string>",
"daysAfterDue": 123,
"dueDate": "<string>",
"finalAmount": 123,
"key": "<string>",
"paymentPayloadUrl": "<string>",
"recipientName": "<string>",
"recipientStreet": "<string>",
"recurrenceStatus": 123,
"state": "<string>",
"status": 123,
"txId": "<string>",
"zipCode": "<string>",
"certificateIspb": "<string>",
"debtorName": "<string>",
"description": [
{
"name": "<string>",
"value": "<string>"
}
],
"discount": 123,
"fine": 123,
"interest": 123,
"jwkUrl": "<string>",
"originalAmount": 123,
"payer": {
"document": "<string>",
"name": "<string>",
"request": "<string>"
},
"rebate": 123,
"recurrencePayloadUrl": "<string>",
"startDate": "<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>',
daysAfterDue: 123,
dueDate: '<string>',
finalAmount: 123,
key: '<string>',
paymentPayloadUrl: '<string>',
recipientName: '<string>',
recipientStreet: '<string>',
recurrenceStatus: 123,
state: '<string>',
status: 123,
txId: '<string>',
zipCode: '<string>',
certificateIspb: '<string>',
debtorName: '<string>',
description: [{name: '<string>', value: '<string>'}],
discount: 123,
fine: 123,
interest: 123,
jwkUrl: '<string>',
originalAmount: 123,
payer: {document: '<string>', name: '<string>', request: '<string>'},
rebate: 123,
recurrencePayloadUrl: '<string>',
startDate: '<string>'
})
};
fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv/{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/cobv/{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>',
'daysAfterDue' => 123,
'dueDate' => '<string>',
'finalAmount' => 123,
'key' => '<string>',
'paymentPayloadUrl' => '<string>',
'recipientName' => '<string>',
'recipientStreet' => '<string>',
'recurrenceStatus' => 123,
'state' => '<string>',
'status' => 123,
'txId' => '<string>',
'zipCode' => '<string>',
'certificateIspb' => '<string>',
'debtorName' => '<string>',
'description' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'discount' => 123,
'fine' => 123,
'interest' => 123,
'jwkUrl' => '<string>',
'originalAmount' => 123,
'payer' => [
'document' => '<string>',
'name' => '<string>',
'request' => '<string>'
],
'rebate' => 123,
'recurrencePayloadUrl' => '<string>',
'startDate' => '<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/cobv/{id}"
payload := strings.NewReader("{\n \"city\": \"<string>\",\n \"daysAfterDue\": 123,\n \"dueDate\": \"<string>\",\n \"finalAmount\": 123,\n \"key\": \"<string>\",\n \"paymentPayloadUrl\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientStreet\": \"<string>\",\n \"recurrenceStatus\": 123,\n \"state\": \"<string>\",\n \"status\": 123,\n \"txId\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"certificateIspb\": \"<string>\",\n \"debtorName\": \"<string>\",\n \"description\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"discount\": 123,\n \"fine\": 123,\n \"interest\": 123,\n \"jwkUrl\": \"<string>\",\n \"originalAmount\": 123,\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"request\": \"<string>\"\n },\n \"rebate\": 123,\n \"recurrencePayloadUrl\": \"<string>\",\n \"startDate\": \"<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/cobv/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"city\": \"<string>\",\n \"daysAfterDue\": 123,\n \"dueDate\": \"<string>\",\n \"finalAmount\": 123,\n \"key\": \"<string>\",\n \"paymentPayloadUrl\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientStreet\": \"<string>\",\n \"recurrenceStatus\": 123,\n \"state\": \"<string>\",\n \"status\": 123,\n \"txId\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"certificateIspb\": \"<string>\",\n \"debtorName\": \"<string>\",\n \"description\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"discount\": 123,\n \"fine\": 123,\n \"interest\": 123,\n \"jwkUrl\": \"<string>\",\n \"originalAmount\": 123,\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"request\": \"<string>\"\n },\n \"rebate\": 123,\n \"recurrencePayloadUrl\": \"<string>\",\n \"startDate\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv/{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 \"daysAfterDue\": 123,\n \"dueDate\": \"<string>\",\n \"finalAmount\": 123,\n \"key\": \"<string>\",\n \"paymentPayloadUrl\": \"<string>\",\n \"recipientName\": \"<string>\",\n \"recipientStreet\": \"<string>\",\n \"recurrenceStatus\": 123,\n \"state\": \"<string>\",\n \"status\": 123,\n \"txId\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"certificateIspb\": \"<string>\",\n \"debtorName\": \"<string>\",\n \"description\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"discount\": 123,\n \"fine\": 123,\n \"interest\": 123,\n \"jwkUrl\": \"<string>\",\n \"originalAmount\": 123,\n \"payer\": {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"request\": \"<string>\"\n },\n \"rebate\": 123,\n \"recurrencePayloadUrl\": \"<string>\",\n \"startDate\": \"<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
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
The recurrence/charge document id (idDocumento, GUID).
Body
application/json
Merchant city (cidade).
Days after the due date the charge can still be paid (diasAposVenc).
Due date for payment (dtVenc; aaaa-mm-dd).
Final charge amount in reais (valorFinal).
The recipient Pix key the composite QR pays into.
CobV JWS host URL (urlPayloadJson; no scheme).
Recipient/beneficiary name (nomeRecebedor).
Recipient street (logradouroRecebedor).
Recurrence stRecorrencia transition (0..4).
Recipient state (uf).
Charge situation (0=Active,1=Completed,2=Removed by recipient,3=Removed by PSP).
Conciliation id (idConciliacaoRecebedor).
Recipient postal code (cep).
Indirect-PSP certificate ISPB (ispbCertificadoJws, string).
Updated debtor name (dadosRecorrencia.devedor.nome).
Optional additional-data entries (dadosAdicionais).
Show child attributes
Show child attributes
Discount in reais (desconto; omit/0 to skip).
Fine in reais (multa; omit/0 to skip).
Interest in reais (juros; omit/0 to skip).
JWK Set URL (urlJwk; no scheme).
Original charge amount in reais (valorOriginal).
Show child attributes
Show child attributes
Rebate in reais (abatimento; omit/0 to skip).
Recurrence JWS host URL (urlPayloadJsonRec; no scheme).
Updated recurrence first payment date (dtInicialRecorrencia).
Response
OK
The regenerated EMV composite-QR payload (base64-decoded, ready to render).
The recurrence/charge document id (idDocumento, GUID).
The signed payment JWS (payloadJws; dynamic + cobv).
The signed recurrence JWS (payloadJwsRecorrencia).
The upstream-computed charge revision (revisao; dynamic + cobv updates only).
Was this page helpful?
⌘I