Listar Cobrança com Vencimento
Através desse endpoint será possível listar as cobranças com vencimento por Pix.
GET https://sandbox-api.openbank.stone.com.br/api/v1/cobv
HEADERS
authorization* string
Bearer token de autenticação.
x-stone-account-id* string
Necessário para permissionamento.
QUERY PARAMS
inicio* string
Format: date-time
fim* string
Format: date-time
cpf string
cnpj string
status string
Possíveis valores: ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP
paginacao[paginaAtual] integer
paginacao[itensPorPagina] integer
Response
200 OK
{
"parametros": {
"inicio": "2020-04-01T00:00:00Z",
"fim": "2020-04-01T23:59:59Z",
"paginacao": {
"paginaAtual": 0,
"itensPorPagina": 100,
"quantidadeDePaginas": 1,
"quantidadeTotalDeItens": 1
}
},
"cobs": [{
"calendario": {
"dataDeVencimento": "2020-12-31",
"validadeAposVencimento": 30
},
"loc": {
"id": 789
},
"devedor": {
"cpf": "12345678909",
"nome": "Francisco da Silva"
},
"valor": {
"original": "123.45",
"multa": {
"modalidade": "2",
"valorPerc": "15.00"
},
"juros": {
"modalidade": "2",
"valorPerc": "2.00"
},
"desconto": {
"modalidade": "1",
"descontoDataFixa": [{
"data": "2020-11-30",
"valorPerc": "30.00"
}]
}
},
"chave": "5f84a4c5-c5cb-4599-9f13-7eb4d419dacc",
"solicitacaoPagador": "Cobrança dos serviços prestados."
}]
}
403 Forbidden
{
"type": "https://pix.bcb.gov.br/api/v2/error/AcessoNegado",
"title": "Acesso Negado",
"status": 403,
"detail": "Requisição de participante autenticado que viola alguma regra de autorização."
}
Última modificação: 23.07.2022