Consultar os detalhes de uma solicitação realizada

Esse endpoint permite a consulta de uma solicitação realizada, retornando todos os dados pertinentes a solicitação, status atualizado do processamento, usuário responsável pela revisão e em casos de cancelamentos também será retornado os dados do usuário que cancelou a solicitação.

Parâmetros da URL

  • posting_id (string): ID de identificação da solicitação a ser consultada.

Resposta

Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:

  • 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.
  • executedAt (datetime): Data da execução da solicitação.
Exemplo de JSON:
{ "id": "<string>", "status": "EXECUTING", "account": { "id": "<string>", "branch": "<string>", "account": "<string>" }, "amount": "<number>", "type": "PIX", "scheduledDate": "<string>", "accountDestination": { "id": "<string>", "name": "<string>", "bank": "<string>", "branch": "<string>", "account": "<string>", "type": "<string>" }, "barCode": "<string>", "review": { "reviewedBy": { "id": "<uuid>", "fullName": "<string>" }, "reviewedAt": "<string>" }, "cancel": { "canceledBy": { "id": "<uuid>", "fullName": "<string>" }, "canceledAt": "<string>" }, "executedAt": "<string>", "error": "<string>" }
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Headers
string
Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
English
Powered by Localize
Português (Brasil)