curl --request GET \
--url https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec} \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataInicial": "2027-01-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"cnpj": "12ABC34501DE35",
"conta": "1234567890",
"nome": "Empresa Recebedora LTDA",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>",
"ispbParticipante": "<string>"
},
"status": "CRIADA",
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"atestacaoTitularidade": {
"atestadaEm": "<string>",
"atestadaPor": "<string>",
"conta": "<string>",
"tipoConta": "<string>",
"agencia": "<string>"
},
"ativacao": {
"tipoJornada": "JORNADA_1",
"dadosJornada": {
"txid": "<string>"
}
},
"dadosQR": {
"jornada": "JORNADA_2",
"pixCopiaECola": "<string>"
},
"encerramento": {
"cancelamento": {
"codigo": "ACCL",
"descricao": "<string>",
"solicitante": "PSP_PAGADOR"
},
"rejeicao": {
"codigo": "AP13",
"descricao": "<string>"
}
},
"loc": {
"criacao": "<string>",
"id": 123,
"location": "<string>",
"tipo": "rec",
"idRec": "<string>"
},
"pagador": {
"cnpj": "28333333150443",
"codMun": "3550308",
"cpf": "23933333316",
"ispbParticipante": "81102623"
},
"solicitacao": [
{
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
},
"destinatario": {
"conta": "550689",
"ispbParticipante": "91193552",
"agencia": "2569",
"cnpj": "<string>",
"cpf": "15231470190"
},
"idRec": "<string>",
"idSolicRec": "<string>",
"status": "CRIADA",
"recPayload": {
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataInicial": "2027-01-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"cnpj": "<string>",
"ispbParticipante": "<string>",
"nome": "<string>"
},
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
}
],
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Retrieve recurrence (Pix Automático)
Retrieves a recurrence by its idRec. Pix API GET /rec/. Projects the stored Rec fields verbatim, including recebedor.convenio. An unknown idRec returns 404 (canonical Problem envelope).
curl --request GET \
--url https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec} \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/rec/{idRec}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataInicial": "2027-01-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"cnpj": "12ABC34501DE35",
"conta": "1234567890",
"nome": "Empresa Recebedora LTDA",
"tipoConta": "CORRENTE",
"agencia": "0001",
"convenio": "<string>",
"ispbParticipante": "<string>"
},
"status": "CRIADA",
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"atestacaoTitularidade": {
"atestadaEm": "<string>",
"atestadaPor": "<string>",
"conta": "<string>",
"tipoConta": "<string>",
"agencia": "<string>"
},
"ativacao": {
"tipoJornada": "JORNADA_1",
"dadosJornada": {
"txid": "<string>"
}
},
"dadosQR": {
"jornada": "JORNADA_2",
"pixCopiaECola": "<string>"
},
"encerramento": {
"cancelamento": {
"codigo": "ACCL",
"descricao": "<string>",
"solicitante": "PSP_PAGADOR"
},
"rejeicao": {
"codigo": "AP13",
"descricao": "<string>"
}
},
"loc": {
"criacao": "<string>",
"id": 123,
"location": "<string>",
"tipo": "rec",
"idRec": "<string>"
},
"pagador": {
"cnpj": "28333333150443",
"codMun": "3550308",
"cpf": "23933333316",
"ispbParticipante": "81102623"
},
"solicitacao": [
{
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataExpiracaoSolicitacao": "2023-12-20T12:17:11Z"
},
"destinatario": {
"conta": "550689",
"ispbParticipante": "91193552",
"agencia": "2569",
"cnpj": "<string>",
"cpf": "15231470190"
},
"idRec": "<string>",
"idSolicRec": "<string>",
"status": "CRIADA",
"recPayload": {
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataInicial": "2027-01-15",
"periodicidade": "MENSAL",
"dataFinal": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"cnpj": "<string>",
"ispbParticipante": "<string>",
"nome": "<string>"
},
"vinculo": {
"contrato": "contrato-12345",
"devedor": {
"cnpj": "12ABC34501DE35",
"cpf": "12345678901",
"nome": "Fulano de Tal"
},
"objeto": "<string>"
},
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}
}
],
"valor": {
"valorMinimoRecebedor": "<string>",
"valorRec": "99.90"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}{
"correlationId": "req-7a3f9c2e",
"code": "<string>",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}Autorizações
JWT bearer token issued by the identity provider.
Parâmetros de caminho
Identificador da recorrência [a-zA-Z0-9]{29}.
^[a-zA-Z0-9]{29}$Parâmetros de consulta
txid de uma cobrança a compor com a recorrência (JORNADA_3/4). NÃO SERVIDO nesta superfície: informar txid resulta em 422.
^[a-zA-Z0-9]{26,35}$Resposta
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Identificador da recorrência.
^[a-zA-Z0-9]{29}$NAO_PERMITE, PERMITE_3R_7D Show child attributes
Show child attributes
CRIADA, APROVADA, REJEITADA, EXPIRADA, CANCELADA Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
QR Composto da recorrência (Pix Automático). Ausente em duas situações: enquanto a recorrência não tem locrec vinculada, e enquanto a instituição não tiver registrado, para o CNPJ do recebedor desta recorrência, um único perfil de recebedor, de onde sai a cidade obrigatória do BR Code (tag 60). Uma recorrência tem conta e CNPJ, não chave Pix, e nada no fluxo de recorrência cria esse registro: sem ele, ou com mais de um perfil para o mesmo CNPJ, o QR é OMITIDO em vez de sair com uma cidade inventada. Registrar um perfil de recebedor com o CNPJ correspondente é o que passa a servir o QR.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Dados do usuário pagador informados pelo PSP pagador na confirmação da recorrência.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Esta página foi útil?

