get https://sandbox.auth.flowfinance.com.br/v1/wallets
Esse endpoint é responsável por retornar uma lista paginada de carteiras de cobrança. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados.
Parâmetros da Requisição
name
(string): Nome.
status
(string): Status da carteira. Possíveis valores aceitos: "ACTIVE", "ARCHIVED"
walletCode
(string): ID, código de identificação da carteira.
beneficiaryAccount
(string): Número da conta do beneficiário.
beneficiaryDocument
(string): Número do CPF ou CNPJ do beneficiário.
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 carteira.
wallet_code
(string): Código de identificação para carteira.
status
(string): Status do carteira. Possíveis valores: "ACTIVE", "ARCHIVED".
name
(string): Nome do beneficiário.
createdAt
(datetime): Data da criação da carteira.
days_to_expire_after_payment
(integer): Dias de expiração.
fine
(float): Percentual de multa.
discount_modality
(string): Modalidade de desconto.
discount_value
(float): Valor de desconto a ser aplicado.
interest
(float): Taxa de juros.
account
(object): Objeto contendo os dados da conta bancária.
account -> id
(string): ID da conta.
account -> branch
(string): Número da agência.
account -> account
(string): Número da conta.
account -> person
(object): Objeto contendo os dados da pessoa, titular da conta.
account -> person -> name
(string): Nome da pessoa.
account -> person -> taxpayerId
(string): Número do CPF da pessoa.
account -> company
(object): Objeto contendo os dados da empresa, titular da conta.
account -> company -> name
(string): Nome do titular da conta..
account -> company -> taxpayerId
(string): Número do CNPJ da empresa.
Exemplo de JSON:
{
"content": [
{
"id": "<string>",
"wallet_code": "<number>",
"name": "<string>",
"status": "<string>",
"days_to_expire_after_payment": "<number>",
"createdAt": "<dateTime>",
"fine": "<number>",
"discount_modality": "<string>",
"discount_value": "<number>",
"interest": "<number>",
"account": {
"id": "<string>",
"branch": "<string>",
"account": "<string>",
"company": {
"name": "<string>",
"taxpayerId": "<string>"
}
}
},
{
"id": "<string>",
"wallet_code": "<number>",
"name": "<string>",
"status": "<string>",
"days_to_expire_after_payment": "<number>",
"createdAt": "<dateTime>",
"fine": "<number>",
"discount_modality": "<string>",
"discount_value": "<number>",
"interest": "<number>",
"account": {
"id": "<string>",
"branch": "<string>",
"account": "<string>",
"company": {
"name": "<string>",
"taxpayerId": "<string>"
}
}
}
],
"hasNext": "<boolean>",
"totalElements": "<number>",
"totalPages": "<number>"
}