Esse endpoint permite a busca das tentativas de desembolso realizadas para uma Solicitação. É possível realizar paginação e vários filtros no resultado.
Parâmetros da URL
-
page(integer): O número da página para paginação. -
size(integer): O número de itens por página.
Resposta
Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:
-
content (object): Objeto contendo o resultado com as tentativas de desembolso da solicitação que atendam aos filtros aplicados.
-
total_pages (int): Quantidade de páginas para paginação.
-
total_elements (int): Quantidade total de registros encontrados.
-
has_next (boolean): Flag para indicar se terá a próxima página para paginação.
Objeto "content"
-
id(string/uuid v4): Identificador da requisição para tentativa de desembolso. -
status(string): Status da requisição. -
status_description(string): Descrição do status. -
payment_orders(object): Objeto contendo uma lista das ordens de pagamentos. -
requested_at(datetime): Data de envio da requisição -
processed_at(datetime): Data de processamento da requisição. -
created_at(datetime): Data da criação da tentativa de desembolso. -
updated_at(datetime): Data da última atualização realizada. -
version(int): Número de versionamento do registro da tentativa de desembolso.
Objeto "payment_orders"
-
id(string/uuid v4): Identificador único da ordem de pagamento. -
amount(float): Valor a ser pago. -
type(string): Tipo da ordem de pagamento. Possíveis valores: PIX_OUT. -
status(string): Status do processamento da ordem de pagamento. Possíveis valores: READY_FOR_PROCESSING, ERROR. -
beneficiary_account(objeto): Objeto com os dados da conta bancária do beneficiário.
Objeto "beneficiary_account"
-
registered_account_id: ID da conta registrada. -
holder -> name: Nome da carteira. -
holder -> taxpayer_id: Número do documento do operador da carteira. -
external_bank_account: Objeto contendo os dados da conta bancária para depósito.
Objeto "external_bank_account"
-
bank_code(string): Código do banco. -
bank_account(string): Número da conta. -
bank_account_digit(string): Dígito do número da conta. -
bank_branch(string): Número da agência. -
bank_account_type(string): Tipo da conta bancária. -
ispb_code(string): Código ISPB relacionado ao banco da conta informada. -
pix(object): Objeto contendo os dados de uma chave PIX. -
pix -> key(string): Chave PIX. -
pix -> key_type(string): Tipo da chave PIX. Valores aceitos: ALEATORY_KEY, EMAIL, PHONE_NUMBER, TAXPAYER_ID -
baas -> account_number: Número da conta bancária no baas.