List recurring charges
curl --request GET \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cobr \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/cobr"
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/cobr', 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/cobr"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"cobsr": [
{
"ajusteDiaUtil": true,
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataDeVencimento": "<string>",
"criacao": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"conta": "<string>",
"tipoConta": "CORRENTE",
"agencia": "<string>"
},
"revisao": 123,
"status": "CRIADA",
"txid": "<string>",
"valor": {
"original": "<string>"
},
"atestacaoTitularidade": {
"atestadaEm": "<string>",
"atestadaPor": "<string>",
"conta": "<string>",
"tipoConta": "<string>",
"agencia": "<string>"
},
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"encerramento": {
"cancelamento": {
"codigo": "<string>",
"descricao": "<string>",
"solicitante": "<string>"
},
"rejeicao": {
"codigo": "<string>",
"descricao": "<string>"
}
},
"infoAdicional": "<string>",
"tentativas": [
{
"atualizacao": [
{
"data": "<string>",
"status": "SOLICITADA"
}
],
"dataLiquidacao": "<string>",
"endToEndId": "<string>",
"status": "SOLICITADA",
"tipo": "AGND",
"rejeicao": {
"codigo": "<string>",
"descricao": "<string>"
}
}
]
}
],
"parametros": {
"fim": "<string>",
"inicio": "<string>",
"paginacao": {
"itensPorPagina": 123,
"paginaAtual": 123,
"quantidadeDePaginas": 123,
"quantidadeTotalDeItens": 123
}
}
}{
"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"
}
}List recurring charges
Lists recurring charges by start date, end date, idRec, and status. Pix API GET /cobr.
GET
/
api
/
v1
/
brcode
/
cobr
List recurring charges
curl --request GET \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cobr \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/cobr"
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/cobr', 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/cobr"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"cobsr": [
{
"ajusteDiaUtil": true,
"atualizacao": [
{
"data": "<string>",
"status": "CRIADA"
}
],
"calendario": {
"dataDeVencimento": "<string>",
"criacao": "<string>"
},
"idRec": "<string>",
"politicaRetentativa": "NAO_PERMITE",
"recebedor": {
"conta": "<string>",
"tipoConta": "CORRENTE",
"agencia": "<string>"
},
"revisao": 123,
"status": "CRIADA",
"txid": "<string>",
"valor": {
"original": "<string>"
},
"atestacaoTitularidade": {
"atestadaEm": "<string>",
"atestadaPor": "<string>",
"conta": "<string>",
"tipoConta": "<string>",
"agencia": "<string>"
},
"devedor": {
"cep": "<string>",
"cidade": "<string>",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"encerramento": {
"cancelamento": {
"codigo": "<string>",
"descricao": "<string>",
"solicitante": "<string>"
},
"rejeicao": {
"codigo": "<string>",
"descricao": "<string>"
}
},
"infoAdicional": "<string>",
"tentativas": [
{
"atualizacao": [
{
"data": "<string>",
"status": "SOLICITADA"
}
],
"dataLiquidacao": "<string>",
"endToEndId": "<string>",
"status": "SOLICITADA",
"tipo": "AGND",
"rejeicao": {
"codigo": "<string>",
"descricao": "<string>"
}
}
]
}
],
"parametros": {
"fim": "<string>",
"inicio": "<string>",
"paginacao": {
"itensPorPagina": 123,
"paginaAtual": 123,
"quantidadeDePaginas": 123,
"quantidadeTotalDeItens": 123
}
}
}{
"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"
}
}Autorizaciones
JWT bearer token issued by the identity provider.
Parámetros de consulta
Início do filtro de criação (RFC 3339).
Fim do filtro de criação (RFC 3339).
Filtro pela recorrência.
Pattern:
^[a-zA-Z0-9]{29}$Filtro pelo status da cobrança recorrente.
Página a ser retornada (0-based).
Rango requerido:
x >= 0Itens por página (1..1000).
Rango requerido:
1 <= x <= 1000¿Esta página le ayudó?