Pular para o conteúdo principal
POST
/
api
/
v1
/
brcode
/
rec
Criar recorrência (Pix Automático)
curl --request POST \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/rec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "calendario": {
    "dataInicial": "<string>",
    "dataFinal": "<string>"
  },
  "recebedor": {
    "conta": "<string>",
    "agencia": "<string>",
    "convenio": "<string>"
  },
  "vinculo": {
    "contrato": "<string>",
    "devedor": {
      "cnpj": "<string>",
      "cpf": "<string>",
      "nome": "<string>"
    },
    "objeto": "<string>"
  },
  "valor": {
    "valorMinimoRecebedor": "<string>",
    "valorRec": "<string>"
  }
}
'
import requests

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

payload = {
"calendario": {
"dataInicial": "<string>",
"dataFinal": "<string>"
},
"recebedor": {
"conta": "<string>",
"agencia": "<string>",
"convenio": "<string>"
},
"vinculo": {
"contrato": "<string>",
"devedor": {
"cnpj": "<string>",
"cpf": "<string>",
"nome": "<string>"
},
"objeto": "<string>"
},
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "<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: {dataInicial: '<string>', dataFinal: '<string>'},
recebedor: {conta: '<string>', agencia: '<string>', convenio: '<string>'},
vinculo: {
contrato: '<string>',
devedor: {cnpj: '<string>', cpf: '<string>', nome: '<string>'},
objeto: '<string>'
},
valor: {valorMinimoRecebedor: '<string>', valorRec: '<string>'}
})
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/rec', 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/rec",
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' => [
'dataInicial' => '<string>',
'dataFinal' => '<string>'
],
'recebedor' => [
'conta' => '<string>',
'agencia' => '<string>',
'convenio' => '<string>'
],
'vinculo' => [
'contrato' => '<string>',
'devedor' => [
'cnpj' => '<string>',
'cpf' => '<string>',
'nome' => '<string>'
],
'objeto' => '<string>'
],
'valor' => [
'valorMinimoRecebedor' => '<string>',
'valorRec' => '<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/rec"

payload := strings.NewReader("{\n \"calendario\": {\n \"dataInicial\": \"<string>\",\n \"dataFinal\": \"<string>\"\n },\n \"recebedor\": {\n \"conta\": \"<string>\",\n \"agencia\": \"<string>\",\n \"convenio\": \"<string>\"\n },\n \"vinculo\": {\n \"contrato\": \"<string>\",\n \"devedor\": {\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"nome\": \"<string>\"\n },\n \"objeto\": \"<string>\"\n },\n \"valor\": {\n \"valorMinimoRecebedor\": \"<string>\",\n \"valorRec\": \"<string>\"\n }\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/rec")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"calendario\": {\n \"dataInicial\": \"<string>\",\n \"dataFinal\": \"<string>\"\n },\n \"recebedor\": {\n \"conta\": \"<string>\",\n \"agencia\": \"<string>\",\n \"convenio\": \"<string>\"\n },\n \"vinculo\": {\n \"contrato\": \"<string>\",\n \"devedor\": {\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"nome\": \"<string>\"\n },\n \"objeto\": \"<string>\"\n },\n \"valor\": {\n \"valorMinimoRecebedor\": \"<string>\",\n \"valorRec\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"dataInicial\": \"<string>\",\n \"dataFinal\": \"<string>\"\n },\n \"recebedor\": {\n \"conta\": \"<string>\",\n \"agencia\": \"<string>\",\n \"convenio\": \"<string>\"\n },\n \"vinculo\": {\n \"contrato\": \"<string>\",\n \"devedor\": {\n \"cnpj\": \"<string>\",\n \"cpf\": \"<string>\",\n \"nome\": \"<string>\"\n },\n \"objeto\": \"<string>\"\n },\n \"valor\": {\n \"valorMinimoRecebedor\": \"<string>\",\n \"valorRec\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "calendario": {
    "dataInicial": "<string>",
    "dataFinal": "<string>"
  },
  "idRec": "<string>",
  "recebedor": {
    "conta": "<string>",
    "agencia": "<string>",
    "convenio": "<string>"
  },
  "vinculo": {
    "contrato": "<string>",
    "devedor": {
      "cnpj": "<string>",
      "cpf": "<string>",
      "nome": "<string>"
    },
    "objeto": "<string>"
  },
  "atualizacao": [
    {
      "data": "<string>"
    }
  ],
  "solicitacao": [
    {
      "calendario": {
        "dataExpiracaoSolicitacao": "2023-11-07T05:31:56Z"
      },
      "destinatario": {
        "conta": "<string>",
        "ispbParticipante": "<string>",
        "agencia": "<string>",
        "cnpj": "<string>",
        "cpf": "<string>"
      },
      "idRec": "<string>",
      "idSolicRec": "<string>"
    }
  ],
  "valor": {
    "valorMinimoRecebedor": "<string>",
    "valorRec": "<string>"
  }
}
{
"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

JWT bearer token issued by the identity provider.

Cabeçalhos

Idempotency-Key
string

Idempotency key, max 255 characters.

Corpo

application/json
calendario
object
obrigatório

Cadência da recorrência.

politicaRetentativa
enum<string>
obrigatório

Política de retentativa.

Opções disponíveis:
NAO_PERMITE,
PERMITE_3R_7D
Exemplo:

"PERMITE_3R_7D"

recebedor
object
obrigatório

Conta bancária do recebedor.

vinculo
object
obrigatório

Vínculo (contrato + devedor).

valor
object

Valor da recorrência (opcional; fixo ou piso).

Resposta

Created

calendario
object
obrigatório
idRec
string
obrigatório

Identificador da recorrência.

Pattern: ^[a-zA-Z0-9]{29}$
politicaRetentativa
enum<string>
obrigatório
Opções disponíveis:
NAO_PERMITE,
PERMITE_3R_7D
recebedor
object
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
CRIADA,
APROVADA,
REJEITADA,
EXPIRADA,
CANCELADA
vinculo
object
obrigatório
atualizacao
object[] | null
solicitacao
object[] | null
valor
object