Consultar lista de cobranças imediatas.

GET

/cob

Cob

Endpoint para consultar cobranças imediatas através de parâmetros como início, fim, cpf, cnpj e status.

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:

cob.read-Permissão para consulta de cobranças imediatas

Parâmetros de Consulta

Respostas

🟢200

application/json

Lista de cobranças imediatas.

Bodyapplication/json

🟠403AcessoNegado

🔴503ServicoIndisponivel

Request Example

Shell

JavaScript

Java

Swift

curl --location '/cob?inicio=undefined&fim=undefined&cpf=undefined&cnpj=undefined&locationPresente=undefined&status=undefined&paginacao.paginaAtual=undefined&paginacao.itensPorPagina=undefined'

Response Example

200 - Exemplo de retorno da consulta de cobranças 1

{
    "parametros": {
        "inicio": "2020-04-01T00:00:00Z",
        "fim": "2020-04-02T10:00:00Z",
        "paginacao": {
            "paginaAtual": 0,
            "itensPorPagina": 100,
            "quantidadeDePaginas": 1,
            "quantidadeTotalDeItens": 2
        }
    },
    "cobs": [
        {
            "allOf": [
                {
                    "$ref": "#/components/examples/cobResponse1/value"
                }
            ]
        },
        {
            "allOf": [
                {
                    "$ref": "#/components/examples/cobResponse2/value"
                }
            ]
        },
        {
            "allOf": [
                {
                    "$ref": "#/components/examples/cobResponse5/value"
                }
            ]
        },
        {
            "allOf": [
                {
                    "$ref": "#/components/examples/cobResponse6/value"
                }
            ]
        },
        {
            "allOf": [
                {
                    "$ref": "#/components/examples/cobResponse7/value"
                }
            ]
        }
    ]
}

Página anterior

Criar cobrança imediata.

Próxima página

Criar cobrança imediata.