Consultar um lote específico de cobranças com vencimento.

GET

/lotecobv/{id}

LoteCobV

Endpoint para consultar um lote de cobranças com vencimento.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

lotecobv.read-Permissão para consulta de lotes de cobranças com vencimento

Parâmetros de Caminho

Respostas

🟢200

application/json

Lote de cobranças com vencimento.

Bodyapplication/json

🟠403AcessoNegado

🟠404NaoEncontrado

🔴503ServicoIndisponivel

Response Example

200 - Exemplo de lote de cobranças com vencimento 1

{
    "descricao": "Cobranças dos alunos do turno vespertino",
    "criacao": "2020-11-01T20:15:00.358Z",
    "cobsv": [
        {
            "criacao": "2020-11-01T20:15:00.358Z",
            "txid": "fb2761260e554ad593c7226beb5cb650",
            "status": "CRIADA"
        },
        {
            "txid": "7978c0c97ea847e78e8849634473c1f1",
            "status": "NEGADA",
            "problema": {
                "type": "https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida",
                "title": "Cobrança inválida.",
                "status": 400,
                "detail": "A requisição que busca alterar ou criar uma cobrança com vencimento não respeita o _schema_ ou está semanticamente errada.",
                "violacoes": [
                    {
                        "razao": "O objeto cobv.devedor não respeita o _schema_.",
                        "propriedade": "cobv.devedor"
                    }
                ]
            }
        }
    ]
}

Página anterior

Utilizado para revisar cobranças específicas dentro de um lote de cobranças com vencimento.

Próxima página

Criar location do payload.