Consultar os detalhes de uma carteira

Esse endpoint permite a realização de uma consulta detalhada dos dados de cadastro de uma carteira de cobranças associada a uma conta.

Parâmetros da URL

• wallet_id (string/uuid v4): ID de cadastro da wallet.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

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

• 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): Taxa 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.

• 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, caso seja uma pessoa física..

• 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, caso seja uma pessoa jurídica..

• account -> company -> name (string): Nome do titular da conta..

• account -> company -> taxpayerId (string): Número do CNPJ da empresa.

Exemplo de JSON:

{
  "id": "<string>",
  "name": "<string>",
  "wallet_code": "<number>",
  "fine": "<number>",
  "days_to_expire_after_payment": "<number>",
  "discount_modality": "<string>",
  "discount_value": "<number>",
  "interest": "<number>",
  "status": "<string>",
  "account": {
    "id": "<string>",
    "person": {
      "id": "<string>",
      "name": "<string>",
      "taxpayerId": "<string>"
    },
    "branch": "<string>",
    "account": "<string>"
  }
}