get https://sandbox.auth.flowfinance.com.br/escrow/api/v1/postings
Esse endpoint é responsável por retornar uma lista paginada de solicitações realizadas. É possível realizar uma série de filtros, ordenações e navegar entre as páginas de resultados.
Parâmetros da Requisição
status(string): Status do processamento da solicitação. Possíveis valores aceitos: PENDING_APPROVAL, EXECUTING, REJECTED, EXPIRED, SCHEDULED, CANCELED, ERROR, SUCCESS.
dateFrom(datetime): Data de início da criação das solicitações.
dateTo(datetime): Data de fim da criação das solicitações.
taxpayerId(string): Nº do CPF ou CNPJ do pagador.
account(string): ID da conta para consulta das solicitações
name(string): Nome do participante.
sort(string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, scheduledDate, type, amount, status.
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 para identificação da solicitação.
status(string): Status do processamento da solicitação. Possíveis valores: PENDING_APPROVAL, EXECUTING, REJECTED, EXPIRED, SCHEDULED, CANCELED, ERROR, SUCCESS.
account(object): Objeto contendo os dados da conta bancária.
account -> id(string): ID da conta bancária.
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.
amount(float): Valor da transação.
type(string): Tipo da transação.
scheduledDate(datetime): Data do agendamento para a solicitação.
createdAt(datetime): Data da criação da solicitação.
review(object): Objeto contendo os dados referente a parte de revisão da solicitação.
review -> reviewBy(object): Objeto contendo os detalhes do usuário revisor.
review -> reviewBy -> id(string, uuid v4): ID do usuário que fez a revisão da solicitação.
review -> reviewBy -> fullName(string): Nome completo do usuário que fez a revisão da solicitação.
review -> reviewAt(datetime): Data que foi feita a revisão.
cancel(object): Objeto contendo os dados referente a parte de cancelamento da solicitação.
cancel -> cancelBy(object): Objeto contendo os detalhes do usuário que cancelou.
cancel -> cancelBy -> id(string, uuid v4): ID do usuário que fez o cancelamento da solicitação.
cancel -> cancelBy -> fullName(string): Nome completo do usuário que fez o cancelamento da solicitação.
cancel -> cancelBy(datetime): Data que foi feita o cancelamento.
accountDestination(object): Objeto contendo os dados da conta de destino, se aplicável.
accountDestination -> id(string): ID da conta bancária.
accountDestination -> branch(string): Número da agência.
accountDestination -> account(string): Número da conta.
accountDestination -> name(string): Nome do beneficiário.
accountDestination -> bank(string): Código do banco.
accountDestination -> type(string): Tipo da conta.
accountDestination -> taxpayerId(string): Número do CPF do beneficiário.
billpaymentBeneficiary(string): Nome do beneficiário.
billpaymentPayer(string): Nome do pagador.
barCode(string): Código de barras no caso de uma solicitação de Boleto.
error(string): Retorno em caso de algum erro no processamento da solicitação.
Exemplo de JSON:
{
"content": [
{
"id": "<string>",
"status": "EXPIRED",
"account": {
"id": "<string>",
"branch": "<string>",
"account": "<string>",
"person": {
"name": "<string>",
"taxpayerId": "<string>"
}
},
"amount": "<number>",
"type": "TED",
"scheduledDate": "<string>",
"createdAt": "<dateTime>",
"error": "<string>",
"review": {
"reviewedBy": {
"id": "<uuid>",
"fullName": "<string>"
},
"reviewedAt": "<string>"
},
"accountDestination": {
"id": "<string>",
"name": "<string>",
"bank": "<string>",
"branch": "<string>",
"account": "<string>",
"type": "<string>",
"taxpayerId": "<string>"
},
"billpaymentBeneficiary": "<string>",
"billpaymentPayer": "<string>",
"barCode": "<string>"
}
],
"hasNext": "<boolean>",
"totalElements": "<number>",
"totalPages": "<number>"
}