Retrieve due-date charge

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	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/cobv/{txid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "calendario": {
    "criacao": "<string>",
    "dataDeVencimento": "<string>",
    "validadeAposVencimento": 1
  },
  "chave": "<string>",
  "devedor": {
    "cpf": "12345678901",
    "nome": "Fulano de Tal",
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "12ABC34501DE35",
    "email": "<string>",
    "logradouro": "<string>",
    "uf": "<string>"
  },
  "recebedor": {
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>",
    "logradouro": "<string>",
    "nome": "<string>",
    "nomeFantasia": "<string>",
    "uf": "<string>"
  },
  "revisao": 123,
  "status": "ATIVA",
  "txid": "<string>",
  "valor": {
    "abatimento": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "desconto": {
      "modalidade": 3,
      "descontoDataFixa": [
        {
          "data": "2030-03-01",
          "valorPerc": "<string>"
        }
      ],
      "valorPerc": "<string>"
    },
    "juros": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "multa": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "original": "250.00"
  },
  "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>"
}

{
  "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"
  }
}

GET

api

brcode

cobv

{txid}

Retrieve due-date charge

curl --request GET \
  --url https://spi.sandbox.lerian.net/api/v1/brcode/cobv/{txid} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	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/cobv/{txid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "calendario": {
    "criacao": "<string>",
    "dataDeVencimento": "<string>",
    "validadeAposVencimento": 1
  },
  "chave": "<string>",
  "devedor": {
    "cpf": "12345678901",
    "nome": "Fulano de Tal",
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "12ABC34501DE35",
    "email": "<string>",
    "logradouro": "<string>",
    "uf": "<string>"
  },
  "recebedor": {
    "cep": "<string>",
    "cidade": "<string>",
    "cnpj": "<string>",
    "cpf": "<string>",
    "logradouro": "<string>",
    "nome": "<string>",
    "nomeFantasia": "<string>",
    "uf": "<string>"
  },
  "revisao": 123,
  "status": "ATIVA",
  "txid": "<string>",
  "valor": {
    "abatimento": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "desconto": {
      "modalidade": 3,
      "descontoDataFixa": [
        {
          "data": "2030-03-01",
          "valorPerc": "<string>"
        }
      ],
      "valorPerc": "<string>"
    },
    "juros": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "multa": {
      "modalidade": 123,
      "valorPerc": "<string>"
    },
    "original": "250.00"
  },
  "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>"
}

{
  "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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

txid

string

required

Identificador da transação [a-zA-Z0-9]{26,35}.

Query Parameters

cpf

string

Qualificador do recebedor (CPF), necessário apenas quando o txid é usado por mais de um recebedor.

Pattern: ^\d{11}$

cnpj

string

Qualificador do recebedor (CNPJ), necessário apenas quando o txid é usado por mais de um recebedor.

Pattern: ^[0-9A-Z]{14}$

Response

calendario

object

required

Show child attributes

chave

string

required

Chave DICT do recebedor.

Maximum string length: 77

devedor

Pessoa Física · object

required

Pessoa Física
Pessoa Jurídica

Show child attributes

recebedor

object

required

Show child attributes

revisao

integer<int64>

required

Revisão da cobrança (inicia em 0).

status

enum<string>

required

Status do registro da cobrança.

Available options:

ATIVA,

CONCLUIDA,

REMOVIDA_PELO_USUARIO_RECEBEDOR,

REMOVIDA_PELO_PSP

txid

string

required

Identificador da transação.

Pattern: [a-zA-Z0-9]{26,35}

valor

object

required

Show child attributes

infoAdicionais

object[]

Show child attributes

loc

object

Show child attributes

location

string

Localização do payload.

Maximum string length: 77

pix

object[]

Pix recebidos vinculados à cobrança.

Show child attributes

pixCopiaECola

string

Pix Copia e Cola (BR Code) correspondente à cobrança.

Maximum string length: 512

solicitacaoPagador

string

Maximum string length: 140