Objeto Account

A conta é uma entidade organizacional que permite o cadastramento de dispositivos. Está api foi projetada para atender a Normativa 491 do BACEM, logo nos dados da conta são obrigatórios números de agência e conta.

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 conta 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 conta. É essencial que este número seja único para cada conta (obrigatório)
account_type	string	Identificador do tipo de conta cadastrada no sistema de cadastro de dispositivo. As contas 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 conta (obrigatório)
account_data	object	objeto que pode conter quais quer dados da conta, mas deve conter no mínimo o número da conta account_number e agência agency_number sendo os dois 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 conta, basta enviar um objeto do tipo Account ao seguinte endpoint:

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