Criar Conta Adicional

Este endpoint possibilita criar uma nova conta para uma Pessoa Física (PF) ou Pessoa Jurídica (PJ) no Hiperbanco.

📘
Nota
Para utilizar este endpoint, é necessário que o titular já possua uma conta aprovada. A nova conta criada será vinculada ao mesmo titular.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/AccountsInternal/createAccount

curl --location 'https://sandbox.hiperbanco.com.br/AccountsInternal/createAccount' \
--header 'version: cutting-edge' \
--header 'Authorization: Bearer {{accessToken}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer {{accessToken}}`	Obrigatório. Token de autenticação do parceiro.

Resposta (Response)

O status code 201 indicará sucesso na operação.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`id`	`string`	Identificador da conta em processo de criação.
`message`	`string`	Mensagem de confirmação do início da operação.

{
    "id": "c2dfab65-24e8-495f-a1d6-b64716aad8f1",
    "message": "Account is being created!"
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são:

Nome do evento (name)	Descrição
ACCOUNT_WAS_CREATED	Este evento sinaliza que a conta foi criada.