Create recurrence request (Pix Automático)

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/solicrec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calendario": {
    "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z"
  },
  "destinatario": {
    "conta": "<string>",
    "ispbParticipante": "<string>",
    "agencia": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>"
  },
  "idRec": "<string>"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/brcode/solicrec"

payload = {
    "calendario": { "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z" },
    "destinatario": {
        "conta": "<string>",
        "ispbParticipante": "<string>",
        "agencia": "<string>",
        "cnpj": "<string>",
        "cpf": "<string>"
    },
    "idRec": "<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({
    calendario: {dataExpiracaoSolicitacao: '2023-11-07T05:31:56Z'},
    destinatario: {
      conta: '<string>',
      ispbParticipante: '<string>',
      agencia: '<string>',
      cnpj: '<string>',
      cpf: '<string>'
    },
    idRec: '<string>'
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/solicrec', 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://spi.sandbox.lerian.net/api/v1/brcode/solicrec",
  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([
    'calendario' => [
        'dataExpiracaoSolicitacao' => '2023-11-07T05:31:56Z'
    ],
    'destinatario' => [
        'conta' => '<string>',
        'ispbParticipante' => '<string>',
        'agencia' => '<string>',
        'cnpj' => '<string>',
        'cpf' => '<string>'
    ],
    'idRec' => '<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://spi.sandbox.lerian.net/api/v1/brcode/solicrec"

	payload := strings.NewReader("{\n  \"calendario\": {\n    \"dataExpiracaoSolicitacao\": \"2023-11-07T05:31:56Z\"\n  },\n  \"destinatario\": {\n    \"conta\": \"<string>\",\n    \"ispbParticipante\": \"<string>\",\n    \"agencia\": \"<string>\",\n    \"cnpj\": \"<string>\",\n    \"cpf\": \"<string>\"\n  },\n  \"idRec\": \"<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://spi.sandbox.lerian.net/api/v1/brcode/solicrec")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calendario\": {\n    \"dataExpiracaoSolicitacao\": \"2023-11-07T05:31:56Z\"\n  },\n  \"destinatario\": {\n    \"conta\": \"<string>\",\n    \"ispbParticipante\": \"<string>\",\n    \"agencia\": \"<string>\",\n    \"cnpj\": \"<string>\",\n    \"cpf\": \"<string>\"\n  },\n  \"idRec\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/solicrec")

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  \"calendario\": {\n    \"dataExpiracaoSolicitacao\": \"2023-11-07T05:31:56Z\"\n  },\n  \"destinatario\": {\n    \"conta\": \"<string>\",\n    \"ispbParticipante\": \"<string>\",\n    \"agencia\": \"<string>\",\n    \"cnpj\": \"<string>\",\n    \"cpf\": \"<string>\"\n  },\n  \"idRec\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "calendario": {
    "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z"
  },
  "destinatario": {
    "conta": "<string>",
    "ispbParticipante": "<string>",
    "agencia": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>"
  },
  "idRec": "<string>",
  "idSolicRec": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

api

brcode

solicrec

Create recurrence request (Pix Automático)

curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/solicrec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calendario": {
    "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z"
  },
  "destinatario": {
    "conta": "<string>",
    "ispbParticipante": "<string>",
    "agencia": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>"
  },
  "idRec": "<string>"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/brcode/solicrec"

payload = {
    "calendario": { "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z" },
    "destinatario": {
        "conta": "<string>",
        "ispbParticipante": "<string>",
        "agencia": "<string>",
        "cnpj": "<string>",
        "cpf": "<string>"
    },
    "idRec": "<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({
    calendario: {dataExpiracaoSolicitacao: '2023-11-07T05:31:56Z'},
    destinatario: {
      conta: '<string>',
      ispbParticipante: '<string>',
      agencia: '<string>',
      cnpj: '<string>',
      cpf: '<string>'
    },
    idRec: '<string>'
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/solicrec', 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://spi.sandbox.lerian.net/api/v1/brcode/solicrec",
  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([
    'calendario' => [
        'dataExpiracaoSolicitacao' => '2023-11-07T05:31:56Z'
    ],
    'destinatario' => [
        'conta' => '<string>',
        'ispbParticipante' => '<string>',
        'agencia' => '<string>',
        'cnpj' => '<string>',
        'cpf' => '<string>'
    ],
    'idRec' => '<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://spi.sandbox.lerian.net/api/v1/brcode/solicrec"

	payload := strings.NewReader("{\n  \"calendario\": {\n    \"dataExpiracaoSolicitacao\": \"2023-11-07T05:31:56Z\"\n  },\n  \"destinatario\": {\n    \"conta\": \"<string>\",\n    \"ispbParticipante\": \"<string>\",\n    \"agencia\": \"<string>\",\n    \"cnpj\": \"<string>\",\n    \"cpf\": \"<string>\"\n  },\n  \"idRec\": \"<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://spi.sandbox.lerian.net/api/v1/brcode/solicrec")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"calendario\": {\n    \"dataExpiracaoSolicitacao\": \"2023-11-07T05:31:56Z\"\n  },\n  \"destinatario\": {\n    \"conta\": \"<string>\",\n    \"ispbParticipante\": \"<string>\",\n    \"agencia\": \"<string>\",\n    \"cnpj\": \"<string>\",\n    \"cpf\": \"<string>\"\n  },\n  \"idRec\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/solicrec")

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  \"calendario\": {\n    \"dataExpiracaoSolicitacao\": \"2023-11-07T05:31:56Z\"\n  },\n  \"destinatario\": {\n    \"conta\": \"<string>\",\n    \"ispbParticipante\": \"<string>\",\n    \"agencia\": \"<string>\",\n    \"cnpj\": \"<string>\",\n    \"cpf\": \"<string>\"\n  },\n  \"idRec\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "calendario": {
    "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z"
  },
  "destinatario": {
    "conta": "<string>",
    "ispbParticipante": "<string>",
    "agencia": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>"
  },
  "idRec": "<string>",
  "idSolicRec": "<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 issued by the identity provider.

Headers

Idempotency-Key

string

Idempotency key, max 255 characters.

Body

application/json

calendario

object

required

Calendário da solicitação.

Show child attributes

destinatario

object

required

Destinatário (conta + participante, CPF ou CNPJ).

Show child attributes

idRec

string

required

Identificador da recorrência (Rec) a confirmar.

Pattern: ^[a-zA-Z0-9]{29}$

Example:

"RN123456782024011577825445612"

Response

Created

calendario

object

required

Show child attributes

destinatario

object

required

Show child attributes

idRec

string

required

Pattern: ^[a-zA-Z0-9]{29}$

idSolicRec

string

required

Identificador da solicitação.

Pattern: ^[a-zA-Z0-9]{29}$

status

enum<string>

required

Available options:

CRIADA,

ENVIADA,

RECEBIDA,

REJEITADA,

ACEITA,

EXPIRADA,

CANCELADA

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Create recurrence request (Pix Automático)

Authorizations

Headers

Body

Response