Pular para o conteúdo principal
PUT
/
v1
/
pix-automatico
/
composite
/
cobv
/
{id}
Atualizar QR code composto de Pix Automático CobV (com vencimento)
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"
}

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

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

​
daysAfterDue
integer<int64>
obrigatório

Dias após a data de vencimento em que a cobrança ainda pode ser paga (diasAposVenc).

​
dueDate
string
obrigatório

Data de vencimento para pagamento (dtVenc; aaaa-mm-dd).

​
finalAmount
number<double>
obrigatório

Valor final da cobrança em reais (valorFinal).

​
key
string
obrigatório

A chave Pix na qual o QR composto recebe.

​
paymentPayloadUrl
string
obrigatório

URL do host JWS da CobV (urlPayloadJson; sem esquema).

​
recipientName
string
obrigatório

Nome do recebedor/beneficiário (nomeRecebedor).

​
recipientStreet
string
obrigatório

Logradouro do recebedor (logradouroRecebedor).

​
recurrenceStatus
integer<int64>
obrigatório

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

​
state
string
obrigatório

UF do recebedor (uf).

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

​
zipCode
string
obrigatório

CEP do recebedor (cep).

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

​
discount
number<double>

Desconto em reais (desconto; omita/0 para pular).

​
fine
number<double>

Multa em reais (multa; omita/0 para pular).

​
interest
number<double>

Juros em reais (juros; omita/0 para pular).

​
jwkUrl
string

URL do JWK Set (urlJwk; sem esquema).

​
originalAmount
number<double>

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

​
payer
object
​
rebate
number<double>

Abatimento em reais (abatimento; omita/0 para pular).

​
recurrencePayloadUrl
string

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

​
startDate
string

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

Resposta

OK

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