Skip to main content
POST
/
v1
/
pix-automatico
/
composite
/
cobv
Create a CobV (due-date) composite Pix Automático QR code
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "daysAfterDue": 123,
  "dueDate": "<string>",
  "finalAmount": 123,
  "jwkUrl": "<string>",
  "key": "<string>",
  "paymentPayloadUrl": "<string>",
  "recipientStreet": "<string>",
  "recurrence": {
    "contractNumber": "<string>",
    "debtor": {
      "cpfCnpj": "<string>",
      "name": "<string>",
      "personType": 123
    },
    "frequency": 123,
    "recipient": {
      "cnpj": "<string>",
      "ispb": "<string>",
      "name": "<string>"
    },
    "recurrenceId": "<string>",
    "retry": 123,
    "startDate": "<string>",
    "amount": 123,
    "contractDesc": "<string>",
    "endDate": "<string>",
    "maxFloorAmount": 123
  },
  "recurrencePayloadUrl": "<string>",
  "state": "<string>",
  "txId": "<string>",
  "zipCode": "<string>",
  "certificateIspb": "<string>",
  "description": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "discount": 123,
  "fine": 123,
  "interest": 123,
  "originalAmount": 123,
  "payer": {
    "document": "<string>",
    "name": "<string>",
    "request": "<string>"
  },
  "rebate": 123
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv"

payload = {
    "accountId": "<string>",
    "daysAfterDue": 123,
    "dueDate": "<string>",
    "finalAmount": 123,
    "jwkUrl": "<string>",
    "key": "<string>",
    "paymentPayloadUrl": "<string>",
    "recipientStreet": "<string>",
    "recurrence": {
        "contractNumber": "<string>",
        "debtor": {
            "cpfCnpj": "<string>",
            "name": "<string>",
            "personType": 123
        },
        "frequency": 123,
        "recipient": {
            "cnpj": "<string>",
            "ispb": "<string>",
            "name": "<string>"
        },
        "recurrenceId": "<string>",
        "retry": 123,
        "startDate": "<string>",
        "amount": 123,
        "contractDesc": "<string>",
        "endDate": "<string>",
        "maxFloorAmount": 123
    },
    "recurrencePayloadUrl": "<string>",
    "state": "<string>",
    "txId": "<string>",
    "zipCode": "<string>",
    "certificateIspb": "<string>",
    "description": [
        {
            "name": "<string>",
            "value": "<string>"
        }
    ],
    "discount": 123,
    "fine": 123,
    "interest": 123,
    "originalAmount": 123,
    "payer": {
        "document": "<string>",
        "name": "<string>",
        "request": "<string>"
    },
    "rebate": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accountId: '<string>',
    daysAfterDue: 123,
    dueDate: '<string>',
    finalAmount: 123,
    jwkUrl: '<string>',
    key: '<string>',
    paymentPayloadUrl: '<string>',
    recipientStreet: '<string>',
    recurrence: {
      contractNumber: '<string>',
      debtor: {cpfCnpj: '<string>', name: '<string>', personType: 123},
      frequency: 123,
      recipient: {cnpj: '<string>', ispb: '<string>', name: '<string>'},
      recurrenceId: '<string>',
      retry: 123,
      startDate: '<string>',
      amount: 123,
      contractDesc: '<string>',
      endDate: '<string>',
      maxFloorAmount: 123
    },
    recurrencePayloadUrl: '<string>',
    state: '<string>',
    txId: '<string>',
    zipCode: '<string>',
    certificateIspb: '<string>',
    description: [{name: '<string>', value: '<string>'}],
    discount: 123,
    fine: 123,
    interest: 123,
    originalAmount: 123,
    payer: {document: '<string>', name: '<string>', request: '<string>'},
    rebate: 123
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'accountId' => '<string>',
    'daysAfterDue' => 123,
    'dueDate' => '<string>',
    'finalAmount' => 123,
    'jwkUrl' => '<string>',
    'key' => '<string>',
    'paymentPayloadUrl' => '<string>',
    'recipientStreet' => '<string>',
    'recurrence' => [
        'contractNumber' => '<string>',
        'debtor' => [
                'cpfCnpj' => '<string>',
                'name' => '<string>',
                'personType' => 123
        ],
        'frequency' => 123,
        'recipient' => [
                'cnpj' => '<string>',
                'ispb' => '<string>',
                'name' => '<string>'
        ],
        'recurrenceId' => '<string>',
        'retry' => 123,
        'startDate' => '<string>',
        'amount' => 123,
        'contractDesc' => '<string>',
        'endDate' => '<string>',
        'maxFloorAmount' => 123
    ],
    'recurrencePayloadUrl' => '<string>',
    'state' => '<string>',
    'txId' => '<string>',
    'zipCode' => '<string>',
    'certificateIspb' => '<string>',
    'description' => [
        [
                'name' => '<string>',
                'value' => '<string>'
        ]
    ],
    'discount' => 123,
    'fine' => 123,
    'interest' => 123,
    'originalAmount' => 123,
    'payer' => [
        'document' => '<string>',
        'name' => '<string>',
        'request' => '<string>'
    ],
    'rebate' => 123
  ]),
  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"

	payload := strings.NewReader("{\n  \"accountId\": \"<string>\",\n  \"daysAfterDue\": 123,\n  \"dueDate\": \"<string>\",\n  \"finalAmount\": 123,\n  \"jwkUrl\": \"<string>\",\n  \"key\": \"<string>\",\n  \"paymentPayloadUrl\": \"<string>\",\n  \"recipientStreet\": \"<string>\",\n  \"recurrence\": {\n    \"contractNumber\": \"<string>\",\n    \"debtor\": {\n      \"cpfCnpj\": \"<string>\",\n      \"name\": \"<string>\",\n      \"personType\": 123\n    },\n    \"frequency\": 123,\n    \"recipient\": {\n      \"cnpj\": \"<string>\",\n      \"ispb\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"recurrenceId\": \"<string>\",\n    \"retry\": 123,\n    \"startDate\": \"<string>\",\n    \"amount\": 123,\n    \"contractDesc\": \"<string>\",\n    \"endDate\": \"<string>\",\n    \"maxFloorAmount\": 123\n  },\n  \"recurrencePayloadUrl\": \"<string>\",\n  \"state\": \"<string>\",\n  \"txId\": \"<string>\",\n  \"zipCode\": \"<string>\",\n  \"certificateIspb\": \"<string>\",\n  \"description\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"discount\": 123,\n  \"fine\": 123,\n  \"interest\": 123,\n  \"originalAmount\": 123,\n  \"payer\": {\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"request\": \"<string>\"\n  },\n  \"rebate\": 123\n}")

	req, _ := http.NewRequest("POST", 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.post("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountId\": \"<string>\",\n  \"daysAfterDue\": 123,\n  \"dueDate\": \"<string>\",\n  \"finalAmount\": 123,\n  \"jwkUrl\": \"<string>\",\n  \"key\": \"<string>\",\n  \"paymentPayloadUrl\": \"<string>\",\n  \"recipientStreet\": \"<string>\",\n  \"recurrence\": {\n    \"contractNumber\": \"<string>\",\n    \"debtor\": {\n      \"cpfCnpj\": \"<string>\",\n      \"name\": \"<string>\",\n      \"personType\": 123\n    },\n    \"frequency\": 123,\n    \"recipient\": {\n      \"cnpj\": \"<string>\",\n      \"ispb\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"recurrenceId\": \"<string>\",\n    \"retry\": 123,\n    \"startDate\": \"<string>\",\n    \"amount\": 123,\n    \"contractDesc\": \"<string>\",\n    \"endDate\": \"<string>\",\n    \"maxFloorAmount\": 123\n  },\n  \"recurrencePayloadUrl\": \"<string>\",\n  \"state\": \"<string>\",\n  \"txId\": \"<string>\",\n  \"zipCode\": \"<string>\",\n  \"certificateIspb\": \"<string>\",\n  \"description\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"discount\": 123,\n  \"fine\": 123,\n  \"interest\": 123,\n  \"originalAmount\": 123,\n  \"payer\": {\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"request\": \"<string>\"\n  },\n  \"rebate\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/cobv")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"accountId\": \"<string>\",\n  \"daysAfterDue\": 123,\n  \"dueDate\": \"<string>\",\n  \"finalAmount\": 123,\n  \"jwkUrl\": \"<string>\",\n  \"key\": \"<string>\",\n  \"paymentPayloadUrl\": \"<string>\",\n  \"recipientStreet\": \"<string>\",\n  \"recurrence\": {\n    \"contractNumber\": \"<string>\",\n    \"debtor\": {\n      \"cpfCnpj\": \"<string>\",\n      \"name\": \"<string>\",\n      \"personType\": 123\n    },\n    \"frequency\": 123,\n    \"recipient\": {\n      \"cnpj\": \"<string>\",\n      \"ispb\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"recurrenceId\": \"<string>\",\n    \"retry\": 123,\n    \"startDate\": \"<string>\",\n    \"amount\": 123,\n    \"contractDesc\": \"<string>\",\n    \"endDate\": \"<string>\",\n    \"maxFloorAmount\": 123\n  },\n  \"recurrencePayloadUrl\": \"<string>\",\n  \"state\": \"<string>\",\n  \"txId\": \"<string>\",\n  \"zipCode\": \"<string>\",\n  \"certificateIspb\": \"<string>\",\n  \"description\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"discount\": 123,\n  \"fine\": 123,\n  \"interest\": 123,\n  \"originalAmount\": 123,\n  \"payer\": {\n    \"document\": \"<string>\",\n    \"name\": \"<string>\",\n    \"request\": \"<string>\"\n  },\n  \"rebate\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "qrCode": "<string>",
  "documentId": "<string>",
  "recurrencePayload": "<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).

Body

application/json
​
accountId
string
required

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

​
daysAfterDue
integer<int64>
required

Days after the due date the charge can still be paid (diasAposVenc).

​
dueDate
string
required

Due date for payment (dtVenc; aaaa-mm-dd).

​
finalAmount
number<double>
required

Final charge amount in reais (valorFinal, after adjustments).

​
jwkUrl
string
required

JWK Set URL (urlJwk; no scheme).

​
key
string
required

The recipient Pix key the composite QR pays into.

​
paymentPayloadUrl
string
required

CobV JWS host URL (urlPayloadJson; no scheme).

​
recipientStreet
string
required

Recipient street (logradouroRecebedor).

​
recurrence
object
required
​
recurrencePayloadUrl
string
required

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

​
state
string
required

Recipient state (uf).

​
txId
string
required

Conciliation id (idConciliacaoRecebedor).

​
zipCode
string
required

Recipient postal code (cep).

​
certificateIspb
string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

​
description
object[] | null

Optional additional-data entries (dadosAdicionais).

​
discount
number<double>

Discount in reais (desconto; omit/0 to skip).

​
fine
number<double>

Fine in reais (multa; omit/0 to skip).

​
interest
number<double>

Interest in reais (juros; omit/0 to skip).

​
originalAmount
number<double>

Original charge amount in reais (valorOriginal, before adjustments).

​
payer
object
​
rebate
number<double>

Rebate in reais (abatimento; omit/0 to skip).

Response

Created

​
qrCode
string
required

The generated EMV composite-QR payload (base64-decoded, ready to render).

​
documentId
string

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

​
recurrencePayload
string

The signed recurrence JWS (payloadJwsRecorrencia).