Register recebedor profile

curl --request PUT \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cep": "<string>",
  "cidade": "<string>",
  "logradouro": "<string>",
  "nome": "<string>",
  "uf": "<string>",
  "cnpj": "<string>",
  "cpf": "<string>",
  "nomeFantasia": "<string>"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave}"

payload = {
    "cep": "<string>",
    "cidade": "<string>",
    "logradouro": "<string>",
    "nome": "<string>",
    "uf": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>",
    "nomeFantasia": "<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({
    cep: '<string>',
    cidade: '<string>',
    logradouro: '<string>',
    nome: '<string>',
    uf: '<string>',
    cnpj: '<string>',
    cpf: '<string>',
    nomeFantasia: '<string>'
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave}', 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/recebedores/{chave}",
  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([
    'cep' => '<string>',
    'cidade' => '<string>',
    'logradouro' => '<string>',
    'nome' => '<string>',
    'uf' => '<string>',
    'cnpj' => '<string>',
    'cpf' => '<string>',
    'nomeFantasia' => '<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/recebedores/{chave}"

	payload := strings.NewReader("{\n  \"cep\": \"<string>\",\n  \"cidade\": \"<string>\",\n  \"logradouro\": \"<string>\",\n  \"nome\": \"<string>\",\n  \"uf\": \"<string>\",\n  \"cnpj\": \"<string>\",\n  \"cpf\": \"<string>\",\n  \"nomeFantasia\": \"<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://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cep\": \"<string>\",\n  \"cidade\": \"<string>\",\n  \"logradouro\": \"<string>\",\n  \"nome\": \"<string>\",\n  \"uf\": \"<string>\",\n  \"cnpj\": \"<string>\",\n  \"cpf\": \"<string>\",\n  \"nomeFantasia\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave}")

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  \"cep\": \"<string>\",\n  \"cidade\": \"<string>\",\n  \"logradouro\": \"<string>\",\n  \"nome\": \"<string>\",\n  \"uf\": \"<string>\",\n  \"cnpj\": \"<string>\",\n  \"cpf\": \"<string>\",\n  \"nomeFantasia\": \"<string>\"\n}"

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

{
  "cep": "<string>",
  "cidade": "<string>",
  "cnpj": "<string>",
  "cpf": "<string>",
  "logradouro": "<string>",
  "nome": "<string>",
  "nomeFantasia": "<string>",
  "uf": "<string>"
}

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

PUT

api

brcode

recebedores

{chave}

curl --request PUT \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cep": "<string>",
  "cidade": "<string>",
  "logradouro": "<string>",
  "nome": "<string>",
  "uf": "<string>",
  "cnpj": "<string>",
  "cpf": "<string>",
  "nomeFantasia": "<string>"
}
'

import requests

url = "https://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave}"

payload = {
    "cep": "<string>",
    "cidade": "<string>",
    "logradouro": "<string>",
    "nome": "<string>",
    "uf": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>",
    "nomeFantasia": "<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({
    cep: '<string>',
    cidade: '<string>',
    logradouro: '<string>',
    nome: '<string>',
    uf: '<string>',
    cnpj: '<string>',
    cpf: '<string>',
    nomeFantasia: '<string>'
  })
};

fetch('https://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave}', 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/recebedores/{chave}",
  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([
    'cep' => '<string>',
    'cidade' => '<string>',
    'logradouro' => '<string>',
    'nome' => '<string>',
    'uf' => '<string>',
    'cnpj' => '<string>',
    'cpf' => '<string>',
    'nomeFantasia' => '<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/recebedores/{chave}"

	payload := strings.NewReader("{\n  \"cep\": \"<string>\",\n  \"cidade\": \"<string>\",\n  \"logradouro\": \"<string>\",\n  \"nome\": \"<string>\",\n  \"uf\": \"<string>\",\n  \"cnpj\": \"<string>\",\n  \"cpf\": \"<string>\",\n  \"nomeFantasia\": \"<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://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cep\": \"<string>\",\n  \"cidade\": \"<string>\",\n  \"logradouro\": \"<string>\",\n  \"nome\": \"<string>\",\n  \"uf\": \"<string>\",\n  \"cnpj\": \"<string>\",\n  \"cpf\": \"<string>\",\n  \"nomeFantasia\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://spi.sandbox.lerian.net/api/v1/brcode/recebedores/{chave}")

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  \"cep\": \"<string>\",\n  \"cidade\": \"<string>\",\n  \"logradouro\": \"<string>\",\n  \"nome\": \"<string>\",\n  \"uf\": \"<string>\",\n  \"cnpj\": \"<string>\",\n  \"cpf\": \"<string>\",\n  \"nomeFantasia\": \"<string>\"\n}"

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

{
  "cep": "<string>",
  "cidade": "<string>",
  "cnpj": "<string>",
  "cpf": "<string>",
  "logradouro": "<string>",
  "nome": "<string>",
  "nomeFantasia": "<string>",
  "uf": "<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

Path Parameters

chave

string

required

Chave Pix (DICT) do recebedor.

Maximum string length: 77

Body

application/json

cep

string

required

CEP do recebedor (8 dígitos).

Maximum string length: 8

Example:

"01310100"

cidade

string

required

Cidade do recebedor.

Maximum string length: 200

Example:

"São Paulo"

logradouro

string

required

Logradouro do recebedor.

Maximum string length: 200

Example:

"Av. Paulista, 1000"

nome

string

required

Nome/razão social do recebedor.

Maximum string length: 200

Example:

"Lerian Studio LTDA"

string

required

UF do recebedor (2 caracteres).

Maximum string length: 2

Example:

"SP"

cnpj

string

CNPJ do recebedor (PJ). Mutuamente exclusivo com cpf.

Example:

"12ABC34501DE35"

cpf

string

CPF do recebedor (PF). Mutuamente exclusivo com cnpj.

Example:

"12345678901"

nomeFantasia

string

Nome fantasia do recebedor (PJ).

Maximum string length: 200

Example:

"Lerian"

Response

cep

string

CEP do recebedor.

Maximum string length: 8

cidade

string

Cidade do recebedor.

Maximum string length: 200

cnpj

string

CNPJ do recebedor (PJ).

cpf

string

CPF do recebedor (PF).

logradouro

string

Logradouro do recebedor.

Maximum string length: 200

nome

string

Nome/razão social do recebedor.

Maximum string length: 200

nomeFantasia

string

Nome fantasia do recebedor.

Maximum string length: 200

string

UF do recebedor.

Maximum string length: 2

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

Register recebedor profile

Authorizations

Headers

Path Parameters

Body

Response