List immediate charges
curl --request GET \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cob \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/cob"
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/cob', 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/cob"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"cobs": [
{
"calendario": {
"criacao": "<string>",
"expiracao": 123
},
"chave": "<string>",
"revisao": 123,
"status": "ATIVA",
"txid": "<string>",
"valor": {
"original": "250.00",
"modalidadeAlteracao": 0,
"retirada": {
"saque": {
"modalidadeAgente": "AGPSS",
"prestadorDoServicoDeSaque": "12345678",
"valor": "5.00",
"modalidadeAlteracao": 0
},
"troco": {
"modalidadeAgente": "AGPSS",
"prestadorDoServicoDeSaque": "12345678",
"valor": "5.00",
"modalidadeAlteracao": 0
}
}
},
"devedor": {
"cpf": "12345678901",
"nome": "Fulano de Tal",
"cep": "<string>",
"cidade": "<string>",
"cnpj": "12ABC34501DE35",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": {
"criacao": "<string>",
"id": 123,
"tipoCob": "cob",
"location": "<string>"
},
"location": "<string>",
"pix": [
{
"endToEndId": "<string>",
"horario": "<string>",
"valor": "<string>",
"txid": "<string>"
}
],
"pixCopiaECola": "<string>",
"solicitacaoPagador": "<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 immediate charges
Lists immediate charges by start date, end date, cpf, cnpj, locationPresente, and status. Pix API v2.9 GET /cob.
GET
/
api
/
v1
/
brcode
/
cob
List immediate charges
curl --request GET \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cob \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/cob"
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/cob', 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/cob"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"cobs": [
{
"calendario": {
"criacao": "<string>",
"expiracao": 123
},
"chave": "<string>",
"revisao": 123,
"status": "ATIVA",
"txid": "<string>",
"valor": {
"original": "250.00",
"modalidadeAlteracao": 0,
"retirada": {
"saque": {
"modalidadeAgente": "AGPSS",
"prestadorDoServicoDeSaque": "12345678",
"valor": "5.00",
"modalidadeAlteracao": 0
},
"troco": {
"modalidadeAgente": "AGPSS",
"prestadorDoServicoDeSaque": "12345678",
"valor": "5.00",
"modalidadeAlteracao": 0
}
}
},
"devedor": {
"cpf": "12345678901",
"nome": "Fulano de Tal",
"cep": "<string>",
"cidade": "<string>",
"cnpj": "12ABC34501DE35",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": {
"criacao": "<string>",
"id": 123,
"tipoCob": "cob",
"location": "<string>"
},
"location": "<string>",
"pix": [
{
"endToEndId": "<string>",
"horario": "<string>",
"valor": "<string>",
"txid": "<string>"
}
],
"pixCopiaECola": "<string>",
"solicitacaoPagador": "<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"
}
}Authorizations
JWT bearer token issued by the identity provider.
Query Parameters
Início do filtro de criação (RFC 3339).
Fim do filtro de criação (RFC 3339).
Filtro pelo CPF do devedor.
Pattern:
^\d{11}$Filtro pelo CNPJ do devedor.
Pattern:
^[0-9A-Z]{14}$Filtro pela existência de location (true/false).
Filtro pelo status do registro da cobrança.
Página a ser retornada (0-based).
Required range:
x >= 0Itens por página (1..1000).
Required range:
1 <= x <= 1000Was this page helpful?