Skip to main content
POST
/
v1
/
pix-automatico
/
composite
/
recurrence
Create a recurrence-only composite Pix Automático QR code
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/recurrence \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "<string>",
  "jwkUrl": "<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>",
  "certificateIspb": "<string>",
  "txId": "<string>"
}
'
import requests

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

payload = {
    "accountId": "<string>",
    "jwkUrl": "<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>",
    "certificateIspb": "<string>",
    "txId": "<string>"
}
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>',
    jwkUrl: '<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>',
    certificateIspb: '<string>',
    txId: '<string>'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/pix-automatico/composite/recurrence', 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/recurrence",
  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>',
    'jwkUrl' => '<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>',
    'certificateIspb' => '<string>',
    'txId' => '<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/recurrence"

	payload := strings.NewReader("{\n  \"accountId\": \"<string>\",\n  \"jwkUrl\": \"<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  \"certificateIspb\": \"<string>\",\n  \"txId\": \"<string>\"\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/recurrence")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountId\": \"<string>\",\n  \"jwkUrl\": \"<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  \"certificateIspb\": \"<string>\",\n  \"txId\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"jwkUrl\": \"<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  \"certificateIspb\": \"<string>\",\n  \"txId\": \"<string>\"\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).

​
jwkUrl
string
required

JWK Set URL (urlJwk; no scheme).

​
recurrence
object
required
​
recurrencePayloadUrl
string
required

Recurrence JWS host URL (urlPayloadJsonRec; no scheme).

​
certificateIspb
string

Indirect-PSP certificate ISPB (ispbCertificadoJws, string).

​
txId
string

Conciliation id (idConciliacaoRecebedor).

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