Referência API
Postman CollectionStatus PageReferência APIGrafeno Digital

Listar cobranças

get
https://pagamentos.grafeno.be/api/v2/charges

Este recurso retorna uma lista com todas as cobranças já criadas.

Query Params
string

Número de controle definido pelo cliente.

int32

CPF ou CNPJ do pagador.

date

Data de criação da cobrança igual a.
Formato: YYYY-MM-DD

date

Data de criação da cobrança maior igual que.
Formato: YYYY-MM-DD

date

Data de criação da cobrança menor igual que.
Formato: YYYY-MM-DD

date

Data do pagamento da cobrança igual a.
Formato: YYYY-MM-DD

date

Data de pagamento da cobrança maior que.
Formato: YYYY-MM-DD

date

Data de pagamento da cobrança menor que.
Formato: YYYY-MM-DD

string
enum

Status da cobrança igual a.
valores permitidos: pending (pendente), paid (paga), paid_externally (baixada) e overpaid (pago a mais)

Allowed:
string
enum

Método de pagamento da cobrança igual a.
valores permitidos: ted ou boleto

Allowed:
date

Data de vencimento da cobrança igual a.
Formato: YYYY-MM-DD

date

Data de vencimento da cobrança maior que.
Formato: YYYY-MM-DD

date

Data de vencimento da cobrança menor que.
Formato: YYYY-MM-DD

string

Seu número do boleto bancário igual a.

date

Data de liquidação do pagamento da cobrança igual a.
Formato: YYYY-MM-DD

date

Data de liquidação do pagamento da cobrança maior que
Formato: YYYY-MM-DD

date

Data de liquidação do pagamento da cobrança menor que
Formato: YYYY-MM-DD

int32

Número da página que será retornada.

int32

Quantidade de itens que serão retornados por página.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 1 year ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
Updated over 1 year ago