get https://sandbox.auth.flowfinance.com.br/escrow/api/v1/wallets//charges
Esse endpoint é responsável por retornar uma lista paginada de cobranças da carteira. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados.
Parâmetros da URL
wallet_id(string/uuid v4): ID de cadastro da wallet.
Parâmetros da Requisição
chargeCode(string): Código da cobrança.
status(string): Status da cobrança. Possíveis valores aceitos:
taxpayerId(string): Número do CPF ou CNPJ do pagador.
debtorName(string): Nome do devedor.
minCreatedAt(datetime): Data início para filtro por data de cadastro da cobrança.
maxCreatedAt(datetime): Data final para filtro por data de cadastro da cobrança.
minDueDate(datetime): Data início para filtro por data de vencimento da cobrança.
maxDueDate(datetime): Data final para filtro por data de vencimento da cobrança.
sort(string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, status, account.
Resposta
Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:
content(object list): Objeto contendo a lista com o resultado do filtro realizado.
- hasNext (boolean): Campo para indicar se tem uma próxima página.
- totalElements (int): Quantidade total de registros retornados para a busca realizada.
- totalPages (int): Quantidade total de páginas retornadas para a busca realizada.
Objeto 'content'
id(string): ID de cadastro da cobrança.
chargeCode(string): Código de identificação para cobrança.
status(string): Status da cobrança. Possíveis valores:
discount_limit_date(datetime): Data máxima para aplicação do desconto, ex: vencimento da cobrança dia 25 e desconto até o dia 20.
created_at(datetime): Data da criação da cobrança.
days_to_expire_after_payment(integer): Dias após o vencimento que a cobraça pode ser paga.
fine(float): Percentual de multa a ser aplicada em caso de atraso no pagamento.
discount_modality(string): Modalidade de desconto.
discount_value(float): Valor de desconto a ser aplicado.
interest(float): Taxa de juros em caso de atraso no pagamento.
receiver(object): Objeto contedo os dados do recebedor.
debtor(object): Objeto contendo os dados do devedor.
Objeto 'receiver'
account(string): Número da conta.
document(string): Número do documento de identificação do recebedor.
Objeto 'debtor'
number(string): Número do endereço informado.
name(string): Nome da rua.
postal_code(string): Código de CEP para o endereço.
neighborhood(string): Campo para informar o bairro.
city(string): Nome da cidade.
state(string): Código da UF para o estado do endereço.
public_area(string): Complemento.
Exemplo de JSON:
{
"content": [
{
"id": "<string>",
"fine": "<number>",
"chargeCode": "<number>",
"status": "<string>",
"discount_limit_date": "<dateTime>",
"due_date": "<dateTime>",
"amount": "<number>",
"days_to_expire_after_payment": "<number>",
"discount_modality": "<string>",
"discount_value": "<number>",
"interest": "<number>",
"created_at": "<dateTime>",
"receiver": {
"account": "<string>",
"document": "<string>"
},
"debtor": {
"number": "<string>",
"neighborhood": "<string>",
"name": "<string>",
"document": "<string>",
"city": "<string>",
"public_area": "<string>",
"state": "<string>",
"postal_code": "<string>"
},
"error": "<string>"
},
{
"id": "<string>",
"fine": "<number>",
"chargeCode": "<number>",
"status": "<string>",
"discount_limit_date": "<dateTime>",
"due_date": "<dateTime>",
"amount": "<number>",
"days_to_expire_after_payment": "<number>",
"discount_modality": "<string>",
"discount_value": "<number>",
"interest": "<number>",
"created_at": "<dateTime>",
"receiver": {
"account": "<string>",
"document": "<string>"
},
"debtor": {
"number": "<string>",
"neighborhood": "<string>",
"name": "<string>",
"document": "<string>",
"city": "<string>",
"public_area": "<string>",
"state": "<string>",
"postal_code": "<string>"
},
"error": "<string>"
}
],
"hasNext": "<boolean>",
"totalElements": "<number>",
"totalPages": "<number>"
}