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.
updatedAt(datetime): Data da última atualização.
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.
updatedAt(datetime): Data da última atualização.
paid_at(datetime): Data da confirmação do pagamento, se for 'bolepix' o status será alterado para 'CONFIRMED'.
payed_amount(float): Valor total pago.
bar_code(string): Código de barras do boleto de pagamento.
pix_code(string): Código PIX do pagamento.
boleto_details(string): Objeto contendo os detalhes referente ao tipo de pagamento se boleto.
pix_details(string): Objeto contendo os detalhes referente ao tipo de pagamento se pix.
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.
Objeto 'boleto_details'
transactionId(string): ID da transação.
status(string): Status do processamento.
bankEmissor(string): Nome do banco emissor do boleto.
bankNumber(string): Código de identificação do banco.
bankAgency(string): Código da agência do banco.
bankAccount(string): Número da conta.
barCode(string): Código de barras do boleto.
bankLine(string): Linha digitável do boleto.
bankAssignor(string): Nome da instituição emissora.
Objeto 'pix_details'
transactionId(string): ID da transação.
transactionIdentification(string): Identificação da transação.
status(string): Status do processamento.
key(string): Chave PIX utilizada no pagamento.
emv(string): Código de barras/QRCode do PIX.
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>",
"updated_at": "<dateTime>",
"paid_at": "<dateTime>",
"payed_amount": "<number>",
"bar_code": "<string>",
"pix_code": "<string>",
"boleto_details": {
"transactionId": "<string>",
"status": "<string>",
"bankEmissor": "<string>",
"bankNumber": "<string>",
"bankAgency": "<string>",
"bankAccount": "<string>",
"barCode": "<string>",
"bankLine": "<string>",
"bankAssignor": "<string>"
},
"pix_details": {
"transactionId": "<string>",
"transactionIdentification": "<string>",
"status": "<string>",
"key": "<string>",
"emv": "<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>",
"updated_at": "<dateTime>",
"paid_at": "<dateTime>",
"payed_amount": "<number>",
"bar_code": "<string>",
"pix_code": "<string>",
"boleto_details": {
"transactionId": "<string>",
"status": "<string>",
"bankEmissor": "<string>",
"bankNumber": "<string>",
"bankAgency": "<string>",
"bankAccount": "<string>",
"barCode": "<string>",
"bankLine": "<string>",
"bankAssignor": "<string>"
},
"pix_details": {
"transactionId": "<string>",
"transactionIdentification": "<string>",
"status": "<string>",
"key": "<string>",
"emv": "<string>"
}
}
],
"hasNext": "<boolean>",
"totalElements": "<number>",
"totalPages": "<number>"
}