Objeto Account

A account (conta) é uma entidade organizacional que permite o cadastramento de dispositivos. Esta API foi projetada para atender a Normativa 491 do BACEN, portanto, dados de account devem seguir um padrão para as informações definidas pelo Banco Central, mas quaisquer outros campos necessários podem ser adicionados aos dados da account.

Definição do Objeto Account

Request Body

{
  "account_id": "12345678",
  "account_type": "natural_person",
  "registration_date": "2019-12-11T11:37:15.12-03:00",
  "account_data": {
    "account_number": "12345678",
    "agency_number": "1234"
    ...
  }
}

Todas as trocas de informação de uma account utilizam a seguinte definição para este objeto. Em alguns casos, para facilitar a implementação e diminuir o fluxo de dados entre as partes, algumas informações poderão ser omitidas.

nome	tipo	descrição
account_id	string	Identificador da account. É essencial que este número seja único para cada account (obrigatório)
account_type	string	Identificador do tipo de account cadastrada no sistema de cadastro de dispositivo. As accounts podem ser do tipo pessoa física natural_person ou pessoa jurídica legal_person .(obrigatório)
registration_date	datetime	Data e hora do registro da account, com fuso horário. (obrigatório)
account_data	object	objeto que pode conter quaisquer dados da account, mas se contiver o número da account account_number e agência agency_number os dois devem ser obrigatoriamente do tipo string.

Enviar um Account

Request Body

  {
    "account_id": "12345",
    ...
  }

Response Body

  {
    "account_id": "12345678",
    "account_type": "natural_person",
    "registration_date": "2019-12-11T11:37:15.12-03:00",
    "account_data": {
      "account_number": "12345678",
      "agency_number": "1234"
      ...
    }
  }

Para realizar a criação de uma account, basta enviar um objeto do tipo Account ao seguinte endpoint:

POST https://api.caas.qitech.app/device_manager/account