Contas (Account)

Os eventos do contexto de contas (Account) disparam mensagens que comunicam ao destinatário sobre:

A abertura e o encerramento de uma conta;
O bloqueio e o desbloqueio de uma conta;
O processo de bloqueio/desbloqueio judicial de valores.

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

Configurar previamente o recebedor de eventos do webhook.
Conhecer a estrutura básica dos eventos que acompanha o objeto data.

Informações sobre os eventos

Contexto e nome do evento

Os campos context e name poderão variar de acordo com a tabela a seguir:

Contexto	Nome do evento	Descrição
`Account`	`ACCOUNT_HOLDER_WAS_CREATED`	O titular da conta foi criado com sucesso após a conclusão do registro do cliente (pessoa física ou jurídica).
`Account`	`ACCOUNT_HOLDER_WAS_CANCELED`	O vínculo com o titular da conta foi encerrado.
`Account`	`ACCOUNT_WAS_CREATED`	A conta foi criada.
`Account`	`ACCOUNT_WAS_CLOSED`	A conta foi encerrada tecnicamente.
`Account`	`ACCOUNT_WAS_LEGALLY_CLOSED`	A conta foi encerrada legalmente. Neste caso, o Banco Central foi informado do encerramento.
`Account`	`PAYMENT_ACCOUNT_WAS_LOCKED`	A conta foi bloqueada (v2).
`Account`	`PAYMENT_ACCOUNT_WAS_UNLOCKED`	A conta foi desbloqueada (v2).
`Account`	`AMOUNT_WAS_BLOCKED`	O valor foi bloqueado (bloqueio judicial).
`Account`	`AMOUNT_WAS_UNBLOCKED`	O valor foi desbloqueado (bloqueio judicial).

Fluxo dos eventos

Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem. Cliques nas imagens para ampliá-las:

Criação da conta

Bloqueio da conta

Bloqueio de saldo

Encerramento da conta

Identificador (entityId)

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão, conforme a tabela a seguir:

Evento	Identificador (`entityId`)	Descrição
`ACCOUNT_HOLDER_WAS_CREATED`	`id`	Código único gerado no momento da criação do titular da conta.
`ACCOUNT_HOLDER_WAS_CANCELED`	`id`	Código único gerado no momento da criação do titular da conta.
`ACCOUNT_WAS_CREATED`	`account.number`	Número da conta do cliente.
`ACCOUNT_WAS_CLOSED`	`account.number`	Número da conta do cliente.
`ACCOUNT_WAS_LEGALLY_CLOSED`	`account.number`	Número da conta do cliente.
`AMOUNT_WAS_BLOCKED`	`judicialBlockId`	Identificador único do bloqueio judicial.
`AMOUNT_WAS_UNBLOCKED`	`judicialBlockId`	Identificador único do bloqueio judicial.
`PAYMENT_ACCOUNT_WAS_LOCKED`	`account.number`	Número da conta do cliente.
`PAYMENT_ACCOUNT_WAS_UNLOCKED`	`account.number`	Número da conta do cliente.

Dados dos eventos

ACCOUNT_HOLDER_WAS_CREATED

Esse evento sinaliza que o titular da conta foi criado com sucesso após a conclusão do registro do cliente no processo de Onboarding.

📘
Nota
O registro do cliente é confirmado pelo evento CUSTOMER_WAS_APPROVED, em caso de pessoa física, e pelo evento BUSINESS_WAS_APPROVED, em caso de pessoa jurídica.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição	Número máximo de caracteres
`license`	`object`	Objeto que contém informações sobre a licença bancária utilizada pelo parceiro.	—
`license.uuid`	`string`	Identificador único da licença.	40
`document`	`object`	Objeto que contém informações sobre o documento do cliente.	—
`document.value`	`string`	Número do documento.	14
`document.type`	`string`	Tipo do documento, que pode ser `"CPF"` ou `"CNPJ"`.	4
`name`	`string`	Nome do cliente.	256
`status`	`string`	Situação do registro do cliente (status da análise KYC). Nesse caso, sempre `"APPROVED"`.	20
`type`	`string`	Tipo de cliente, que pode ser `"Customer"` ou `"Business"`.	15

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
 "entityId": "d8026b493fe04873775ef3d4fd9884bb6c6aea63",
 "companyKey": "HIPERBANCO_SANDBOX",
 "licenseUuid": "24ac71da-4309-4348-9cc0-a0c88f867993",
 "idempotencyKey": "519fecda-84a8-45bb-8737-efdf3805053a",
 "context": "Account",
 "name": "ACCOUNT_HOLDER_WAS_CREATED",
 "timestamp": "2024-03-05T13:32:36.6267395Z",
 "correlationId": "4de50511-3aa7-44fa-b20b-4a844c90a9f5",
 "data": {
    "license": {
       "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
    },
    "document": {
       "value": "47742663023",
       "type": "CPF"
    },
    "name": "Nísia Floresta",
    "status": "APPROVED",
    "type": "Customer"
 }
}

ACCOUNT_HOLDER_WAS_CANCELED

Esse evento sinaliza que o vínculo comercial com o cliente e todas as suas contas foram encerrados com sucesso por meio do processo de Offboarding.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição	Número máximo de caracteres
`license`	`object`	Objeto que contém informações sobre a licença bancária utilizada pelo parceiro.	—
`license.uuid`	`string`	Identificador único da licença.	40
`document`	`object`	Objeto que contém informações sobre o documento do cliente.	—
`document.value`	`string`	Número do documento.	14
`document.type`	`string`	Tipo do documento, que pode ser `"CPF"` ou `"CNPJ"`.	4
`type`	`string`	Tipo de cliente, que pode ser `"Customer"` ou `"Business"`.	15
`name`	`string`	Nome do cliente.	256
`status`	`string`	Situação do registro do cliente (status da análise KYC). Nesse caso, sempre `"CANCELED"`.	20
`accounts`	`array of objects`	Lista de objetos que contém informações sobre a(s) conta(s). Caso o cliente não possua nenhuma conta aberta, este objeto retornará `null`.	—
`accounts.programId`	`string`	Identificador do programa de contas.	40
`accounts.branch`	`string`	Número da agência.	4
`accounts.number`	`string`	Número da conta.	15
`accounts.type`	`string`	Tipo da conta, que pode ser `"Payment"` (pagamento) ou `"Checking"` (corrente).	20
`accounts.status`	`string`	Situação da conta, que pode ser `"Active"` ou `"Closed"`.	30
`accounts.reason`	`string`	Motivo da abertura ou fechamento da conta.	32
`accounts.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.	—
`accounts.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.	15
`accounts.bank.code`	`string`	Código do banco.	5
`accounts.bank.name`	`string`	Nome do banco.	255
`accounts.specialType`	`string`	Tipo da conta.	30
`accounts.statusReason`	`string`	Motivo da abertura ou fechamento da conta. Campo obsoleto, porém retorna neste evento.	32
`accounts.specialAccountType`	`string`	Tipo da conta. Campo obsoleto, porém retorna neste evento.	30

Payload do evento

Os payloads abaixo exemplificam a estrutura dos eventos que deverão ser recebidos pelo parceiro. Clique na seta para expandi-los:

Exemplo de payload

 {
    "entityId": "d8026b493fe04873775ef3d4fd9884bb6c6aea63",
    "companyKey": "HIPERBANCO_SANDBOX",
    "idempotencyKey": "e21ae7ff-b1b5-4f52-8723-118566e27168",
    "context": "Account",
    "name": "ACCOUNT_HOLDER_WAS_CANCELED",
    "timestamp": "2024-03-05T14:52:38.9873694Z",
    "correlationId": "f2450fba-21a5-4af3-a064-d5414f6d6abe",
    "data": {
       "license": {
          "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
       },
       "document": {
          "value": "47742663023",
          "type": "CPF"
       },
       "name": "Nísia Floresta",
       "status": "CANCELED",
       "type": "Customer",
       "accounts": [
          {
             "programId": "97b85afb-8c4f-4fcf-940c-054299aa6acc",
             "branch": "0001",
             "number": "1101894102",
             "type": "Payment",
             "status": "Closed",
             "reason": "HOLDER_REQUEST",
             "bank": {
                "ispb": "13140088",
                "code": "332",
                "name": "Acesso Soluções De Pagamento S.A."
             },
             "specialType": "STANDARD_ACCOUNT",
             "statusReason": "HOLDER_REQUEST",
             "specialAccountType": "PAYMENT_ACCOUNT"
          }
       ],
    },
    "statusReason": "HOLDER_REQUEST"
 }

 {
    "entityId": "d8026b493fe04873775ef3d4fd9884bb6c6aea63",
    "companyKey": "HIPERBANCO_SANDBOX",
    "idempotencyKey": "e21ae7ff-b1b5-4f52-8723-118566e27168",
    "context": "Account",
    "name": "ACCOUNT_HOLDER_WAS_CANCELED",
    "timestamp": "2024-03-05T14:52:38.9873694Z",
    "correlationId": "f2450fba-21a5-4af3-a064-d5414f6d6abe",
    "data": {
       "license": {
          "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993"
       },
       "document": {
          "value": "47742663023",
          "type": "CPF"
       },
       "name": "Nísia Floresta",
       "status": "CANCELED",
       "type": "Customer",
       "accounts": null,
       "specialType": null,
       "statusReason": null,
       "specialAccountType": null
    },
    "statusReason": "HOLDER_REQUEST"
 }

ACCOUNT_WAS_CREATED

Este evento sinaliza que a conta foi criada.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento, que pode ser `"CPF"` ou `"CNPJ"`.
`type`	`string`	Tipo de cliente, que pode ser `"Customer"` ou `"Business"`.
`name`	`string`	Nome do cliente.
`account`	`object`	Objeto que contém informações sobre a conta.
`account.programId`	`string`	Identificador do programa de contas que determina o tipo de conta.
`account.branch`	`string`	Número da agência.
`account.number`	`string`	Número da conta.
`account.type`	`string`	Tipo da conta, que pode ser `"Payment"` (de pagamento) ou `"Checking"` (corrente).
`account.status`	`string`	Situação da conta, que pode ser `"Active"` ou `"Closed"`.
`account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`account.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`account.code`	`string`	Código do banco.
`account.name`	`string`	Nome do banco.
`account.specialAccountType`	`string`	Obsoleto. Considere o campo `specialType`.
`account.specialType`	`string`	Indica se a conta pertence a um parceiro (`PARTNER_ACCOUNT`) ou a um cliente parceiro (`STANDARD_ACCOUNT`).

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
 "correlationId": "ac020000-a9fe-0a58-23b8-08da26b7388b",
 "entityId": "88046761",
 "companyKey": "HIPERBANCO_SANDBOX",
 "idempotencyKey": "95de993-94f8-4cb6-86b7-7be083e2d4a7",
 "context": "Account",
 "name": "ACCOUNT_WAS_CREATED",
 "timestamp": "2022-04-25T12:30:12.8733831Z",
 "data": {
    "document": {
       "value": "47742663023",
       "type": "CPF"
    },
    "type": "Customer",
    "name": "Nísia Floresta",
    "account": {
       "programId": "d83c37b2-fb71-477c-b689-8ec95ab810c8",
       "branch": "0001",
       "number": "15164",
       "type": "Payment",
       "status": "Active",
       "bank": {
          "ispb": "13140088",
          "code": "332",
          "name": "Acesso Soluções De Pagamento S.A."
       },
       "specialAccountType": "PAYMENT_ACCOUNT",
       "specialType": "STANDARD_ACCOUNT"
    }
 },
 "version": "1"
}

ACCOUNT_WAS_CLOSED

Este evento sinaliza que a conta foi encerrada tecnicamente.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento, que pode ser `"CPF"` ou `"CNPJ"`.
`type`	`string`	Tipo de cliente, que pode ser `"Customer"` ou `"Business"`.
`name`	`string`	Nome do cliente.
`account`	`object`	Objeto que contém informações sobre a conta.
`account.programId`	`string`	Identificador do programa de contas que determina o tipo de conta.
`account.branch`	`string`	Número da agência.
`account.number`	`string`	Número da conta.
`account.type`	`string`	Tipo da conta, que pode ser `"Payment"` (de pagamento) ou `"Checking"` (corrente).
`account.status`	`string`	Situação da conta, que pode ser `"Active"` ou `"Closed"`.
`account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`account.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`account.code`	`string`	Código do banco.
`account.name`	`string`	Nome do banco.
`statusReason`	`string`	Obsoleto. Considere o campo `reason`.
`reason`	`string`	Motivo pelo qual ocorreu o encerramento da conta, que pode ser `"HOLDER_REQUEST"`, `"COMMERCIAL_DISAGREEMENT"`, `"CONFIRMED_FRAUD"` ou `"BEHAVIOR_RISK"`.
`account.specialAccountType`	`string`	Obsoleto. Considere o campo `specialType`.
`account.specialType`	`string`	Indica se a conta pertence a um parceiro (`PARTNER_ACCOUNT`) ou a um cliente parceiro (`STANDARD_ACCOUNT`). Pode retornar também `PAYMENT_ACCOUNT` para contas criadas antes de 15/02/2023.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
 "correlationId": "c260fa8-ee90-4981-8928-4c665eeae3b9",
 "entityId": "66635780",
 "companyKey": "HIPERBANCO_SANDBOX",
 "idempotencyKey": "a7edbb9-b8a7-4bb9-94ac-434e13c65d54",
 "context": "Account",
 "name": "ACCOUNT_WAS_CLOSED",
 "timestamp": "2022-04-25T12:18:41.9412139+00:00",
 "data": {
    "document": {
       "value": "47742663023",
       "type": "CPF"
    },
    "type": "Customer",
    "name": "Nísia Floresta",
    "account": {
       "programId": "d83c37b2-fb71-477c-b689-8ec95ab810c8",
       "branch": "0001",
       "number": "15164",
       "type": "Payment",
       "status": "Closed",
       "bank": {
          "ispb": "13140088",
          "code": "332",
          "name": "Acesso Soluções De Pagamento S.A."
       },
       "statusReason": "HOLDER_REQUEST",
       "reason": "HOLDER_REQUEST",
       "specialAccountType": "PAYMENT_ACCOUNT",
       "specialType": "STANDARD_ACCOUNT"
    }
 },
 "version": "1"
}

ACCOUNT_WAS_LEGALLY_CLOSED

Este evento sinaliza que a conta foi encerrada legalmente.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`document`	`object`	Objeto que contém informações sobre o documento do cliente.
`document.value`	`string`	Número do documento.
`document.type`	`string`	Tipo do documento, que pode ser `"CPF"` ou `"CNPJ"`.
`type`	`string`	Tipo de cliente, que pode ser `"Customer"` ou `"Business"`.
`name`	`string`	Nome do cliente.
`account`	`object`	Objeto que contém informações sobre a conta.
`account.programId`	`string`	Identificador do programa de contas que determina o tipo de conta.
`account.branch`	`string`	Número da agência.
`account.number`	`string`	Número da conta.
`account.type`	`string`	Tipo da conta, que pode ser `"Payment"` (de pagamento) ou `"Checking"` (corrente).
`account.status`	`string`	Situação da conta, que pode ser `"Active"` ou `"Closed"`.
`account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`account.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`account.code`	`string`	Código do banco.
`account.name`	`string`	Nome do banco.
`statusReason`	`string`	Obsoleto. Considere o campo `reason`.
`reason`	`string`	Motivo pelo qual ocorreu o encerramento da conta, que pode ser `"HOLDER_REQUEST"`, `"COMMERCIAL_DISAGREEMENT"`, `"CONFIRMED_FRAUD"` ou `"BEHAVIOR_RISK"`.
`account.specialAccountType`	`string`	Obsoleto. Considere o campo `specialType`.
`account.specialType`	`string`	Indica se a conta pertence a um parceiro (`PARTNER_ACCOUNT`) ou a um cliente parceiro (`STANDARD_ACCOUNT`). Pode retornar também `PAYMENT_ACCOUNT` para contas criadas antes de 15/02/2023.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
 "correlationId": "af48363-efbb-4b2c-ae06-fedd2b5e641a",
 "entityId": "55371710",
 "companyKey": "HIPERBANCO_SANDBOX",
 "idempotencyKey": "1e4f560-8fd1-440b-a2ce-a17afc8b8d47",
 "context": "Account",
 "name": "ACCOUNT_WAS_LEGALLY_CLOSED",
 "timestamp": "2022-04-25T05:22:31.1886271+00:00",
 "data": {
    "document": {
       "value": "47742663023",
       "type": "CPF"
    },
    "type": "Customer",
    "name": "Nísia Floresta",
    "account": {
       "programId": "d83c37b2-fb71-477c-b689-8ec95ab810c8",
       "branch": "0001",
       "number": "15164",
       "type": "Payment",
       "status": "Closed",
       "bank": {
          "ispb": "13140088",
          "code": "332",
          "name": "Acesso Soluções De Pagamento S.A."
       },
       "statusReason": "HOLDER_REQUEST",
       "reason": "HOLDER_REQUEST",
       "specialAccountType": "PAYMENT_ACCOUNT",
       "specialType": "STANDARD_ACCOUNT"
    }
 },
 "version": "1"
}

AMOUNT_WAS_BLOCKED

Este evento sinaliza que o valor foi bloqueado.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`judicialBlockId`	`string`	Identificador único do bloqueio judicial.
`createdAt`	`string`	Data em que ocorreu o bloqueio judicial, no formato ISO 8601 - UTC.
`status`	`string`	Situação do bloqueio judicial, que pode ser `"FullyBlocked"` (bloqueio completo) ou `"PartiallyBlocked"` (bloqueio parcial).
`blockedValue`	`object`	Objeto que contém informações sobre o valor bloqueado.
`blockedAmount.value`	`number`	Valor bloqueado.
`blockedValue.currency`	`string`	Código da moeda com base na ISO-4217.
`details`	`object`	Objeto que contém informações sobre a ordem judicial.
`details.lawsuitNumber`	`string`	Número do processo judicial.
`details.judicialOrderAmount`	`object`	Objeto que contém informações sobre o valor a ser bloqueado de acordo com a ordem judicial.
`details.judicialOrderAmount.value`	`number`	Valor determinado para ser bloqueado.
`details.judicialOrderAmount.currency`	`string`	Código da moeda com base na ISO-4217.
`holder`	`object`	Objeto que contém informações sobre o titular da conta que foi bloqueada.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo do documento, que pode ser `"CPF"` ou `"CNPJ"`.
`holder.type`	`string`	Tipo de titular, que pode ser `"Customer"` ou `"Business"`.
`holder.account`	`object`	Objeto que contém informações sobre a conta do titular.
`holder.account.branch`	`string`	Número da agência.
`holder.account.number`	`string`	Número da conta.
`holder.account.type`	`string`	Tipo de conta, que pode ser `"CHECKING"` (corrente), `"SALARY"` (salário), `"SAVINGS"` (poupança) ou `"PAYMENT"` (pagamento).
`holder.account.status`	`string`	Situação da conta, que pode ser `"Active"` ou `"Closed"`.
`holder.account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`holder.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`holder.account.bank.code`	`string`	Código do banco.
`holder.account.bank.name`	`string`	Nome do banco.
`holder.balances`	`object`	Objeto que contém informações sobre o saldo disponível e bloqueado da conta.
`holder.balances.available`	`object`	Objeto que contém informações sobre o saldo disponível na conta após o bloqueio.
`holder.balances.value`	`number`	Valor disponível na conta.
`holder.balances.currency`	`string`	Código da moeda com base na ISO-4217.
`holder.balances.blocked`	`object`	Objeto que contém informações sobre o saldo bloqueado.
`holder.balances.blocked.value`	`number`	Saldo total bloqueado.
`holder.balances.blocked.currency`	`string`	Código da moeda com base na ISO-4217.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
 "entityId": "bfdc7c7e-02d0-470e-aceb-8873bda5fd3f",
 "companyKey": "HIPERBANCO_SANDBOX",
 "idempotencyKey": "854acc51-d330-4c56-9cbc-951e1d510f48",
 "context": "Account",
 "name": "AMOUNT_WAS_BLOCKED",
 "timestamp": "2022-05-24T14:27:37.290Z",
 "correlationId": "ea262099-a8c3-4d89-b5bf-c45e8760464c",
 "data": {
    "judicialBlockId": "bfdc7c7e-02d0-470e-aceb-8873bda5fd3f",
    "createdAt": "2022-05-24T14:27:35.592Z",
    "status": "FullyBlocked",
    "blockedAmount": {
       "value": 450,
       "currency": "BRL"
    },
    "details": {
       "lawsuitNumber": "1000131-03.2020.5.02.0607",
       "judicialOrderAmount": {
          "value": 450,
          "currency": "BRL"
       }
    },
    "holder": {
       "document": {
          "value": "47742663023",
          "type": "CPF"
       },
       "type": "Customer",
       "account": {
          "branch": "0001",
          "number": "15164",
          "type": "Payment",
          "status": "Active",
          "bank": {
             "ispb": "13140088",
             "code": "332",
             "name": "Acesso Soluções De Pagamento S.A."
          },
          "balances": {
             "available": {
                "value": 0,
                "currency": "BRL"
             },
             "blocked": {
                "value": 0,
                "currency": "BRL"
             }
          }
       }
    }
 }
}

AMOUNT_WAS_UNBLOCKED

Este evento sinaliza que o valor foi desbloqueado.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`judicialBlockId`	`string`	Identificador único do bloqueio judicial.
`createdAt`	`string`	Data em que ocorreu o desbloqueio judicial, no formato ISO 8601 - UTC.
`status`	`string`	Situação do desbloqueio judicial, que pode ser `FullyUnblocked` (desbloqueio completo) ou `PartiallyUnblocked` (desbloqueio parcial).
`unblockedValue`	`object`	Objeto que contém informações sobre o valor desbloqueado.
`unblockedValue.value`	`number`	Valor desbloqueado.
`unblockedValue.currency`	`string`	Código da moeda com base na ISO 4217.
`details`	`object`	Objeto que contém informações sobre a ordem judicial.
`details.lawsuitNumber`	`string`	Número do processo judicial.
`details.judicialOrderAmount`	`object`	Objeto que contém informações sobre o valor a ser bloqueado de acordo com a ordem judicial.
`details.judicialOrderAmount.value`	`number`	Valor determinado para ser bloqueado.
`details.judicialOrderAmount.currency`	`string`	Código da moeda com base na ISO 4217.
`holder`	`object`	Objeto que contém informações sobre o titular da conta que foi bloqueada.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo do documento, que pode ser `CPF` ou `CNPJ`.
`holder.type`	`string`	Tipo de titular, que pode ser `Customer` ou `Business`.
`holder.account`	`object`	Objeto que contém informações sobre a conta do titular.
`holder.account.branch`	`string`	Número da agência.
`holder.account.number`	`string`	Número da conta.
`holder.account.type`	`string`	Tipo de conta, que pode ser `CHECKING` (corrente), `SALARY` (salário), `SAVINGS` (poupança) ou `PAYMENT` (pagamento).
`holder.account.status`	`string`	Situação da conta, que pode ser `Active` ou `Closed`.
`holder.account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`holder.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`holder.account.bank.code`	`string`	Código do banco.
`holder.account.bank.name`	`string`	Nome do banco.
`holder.balances`	`object`	Objeto que contém informações sobre o saldo disponível e bloqueado da conta.
`holder.balances.available`	`object`	Objeto que contém informações sobre o saldo disponível na conta após o bloqueio.
`holder.balances.value`	`number`	Valor disponível na conta.
`holder.balances.currency`	`string`	Código da moeda com base na ISO 4217.
`holder.balances.blocked`	`object`	Objeto que contém informações sobre o saldo bloqueado.
`holder.balances.blocked.value`	`number`	Saldo total bloqueado.
`holder.balances.blocked.currency`	`string`	Código da moeda com base na ISO 4217.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
 "entityId": "bfdc7c7e-02d0-470e-aceb-8873bda5fd3f",
 "companyKey": "HIPERBANCO_SANDBOX",
 "idempotencyKey": "854acc51-d330-4c56-9cbc-951e1d510f48",
 "context": "Account",
 "name": "AMOUNT_WAS_UNBLOCKED",
 "timestamp": "2022-05-24T14:27:37.290Z",
 "correlationId": "ea262099-a8c3-4d89-b5bf-c45e8760464c",
 "data": {
    "judicialBlockId": "bfdc7c7e-02d0-470e-aceb-8873bda5fd3f",
    "createdAt": "2022-05-24T14:27:35.592Z",
    "status": "FullyUnblocked",
    "unblockedValue": {
       "value": 450,
       "currency": "BRL"
    },
    "details": {
       "lawsuitNumber": "1000131-03.2020.5.02.0607",
       "judicialOrderAmount": {
          "value": 450,
          "currency": "BRL"
       }
    },
    "holder": {
       "document": {
          "value": "47742663023",
          "type": "CPF"
       },
       "type": "Customer",
       "account": {
          "branch": "0001",
          "number": "15164",
          "type": "Payment",
          "status": "Active",
          "bank": {
             "ispb": "13140088",
             "code": "332",
             "name": "Acesso Soluções De Pagamento S.A."
          },
          "balances": {
             "available": {
                "value": 0,
                "currency": "BRL"
             },
             "blocked": {
                "value": 0,
                "currency": "BRL"
             }
          }
       }
    }
 }
}

PAYMENT_ACCOUNT_WAS_LOCKED

Este evento sinaliza que a conta foi bloqueada para transações do tipo cash-out, emissão de boletos e consulta de chaves Pix.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`status`	`string`	Status da conta. Neste caso, "LOCKED".
`reason`	`string`	Motivo do bloqueio da conta.
`branch`	`string`	Número da agência.
`number`	`string`	Número da conta.
`bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`bank.code`	`string`	Código do banco.
`bank.name`	`string`	Nome do banco.
`holder`	`object`	Objeto que contém informações sobre o titular da conta.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular da conta.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo do documento, que pode ser "CPF" ou "CNPJ".
`holder.name`	`string`	Nome do cliente titular da conta.
`holder.status`	`string`	Status do cliente titular da conta, que pode ser `PENDING_APPROVAL` (aprovação pendente), `APPROVED` (aprovado), `IN_ANALYSIS` (em análise), `REPROVED` (reprovado) e `BLOCKLISTED` (bloqueado).
`holder.type`	`string`	Tipo de titular, que pode ser "Customer" ou "Business".

Motivos de bloqueio da conta

Motivo	Descrição
`TRANSACTION_CONTESTATION`	Bloqueio por política interna de risco relacionado ao transacional.
`SUSPICIOUS_BEHAVIOR`	Bloqueio por política interna de risco relacionado a comportamento de risco.

👍
Dica
O campo reason indica o motivo do bloqueio e funciona como referência para orientar o suporte na análise do ocorrido. Com base nessa informação, será possível verificar junto ao Banco Liquidante a viabilidade de desbloqueio da conta.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
 "entityId": "12345678",
 "idempotencyKey": "3b90efcf-78ab-4809-8308-6f0fbff65afd",
 "companyKey": "HIPERBANCO_SANDBOX",
 "context": "Account",
 "name": "PAYMENT_ACCOUNT_WAS_LOCKED",
 "timestamp": "2023-05-05 15:10:15.278000+00:00",
 "correlationId": "285af944-9383-4bde-81dd-3089a6cb89b0",
 "version": "2",
 "data": {
    "status": "LOCKED",
    "reason": "TRANSACTION_CONTESTATION",
    "branch": "0001",
    "number": "15164",
    "bank": {
       "ispb": "13140088",
       "code": "332",
       "name": "Acesso Soluções Pagamentos S.A"
    },
    "holder": {
       "document": {
          "value": "47742663023",
          "type": "CPF"
       },
       "name": "Nísia Floresta",
       "status": "APPROVED",
       "type": "CUSTOMER"
    }
 }
}

PAYMENT_ACCOUNT_WAS_UNLOCKED

Este evento sinaliza que a conta foi desbloqueada e pode voltar a realizar transações do tipo cash-out, emissão de boletos e consulta de chaves Pix.

⚠️
Importante
O desbloqueio é realizado por meio de análise de prevenção à fraude. A análise pode ser solicitada via Service Desk.

Descrição do objeto data do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`status`	`string`	Status da conta, que pode ser "Active", "Closed" ou "Locked".
`branch`	`string`	Número da agência.
`number`	`string`	Número da conta.
`bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`bank.code`	`string`	Código do banco.
`bank.name`	`string`	Nome do banco.
`holder`	`object`	Objeto que contém informações sobre o titular da conta.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular da conta.
`holder.document.value`	`string`	Número do documento do titular da conta.
`holder.document.type`	`string`	Tipo do documento, que pode ser "CPF" ou "CNPJ".
`holder.name`	`string`	Nome do cliente titular da conta.
`holder.status`	`string`	Status do cliente titular da conta, que pode ser "PENDING_APPROVAL", "APPROVED", "IN_ANALYSIS", "REPROVED" ou "BLOCKLISTED".
`holder.type`	`string`	Tipo de titular, que pode ser "Customer" ou "Business".

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
 "entityId": "12345678",
 "idempotencyKey": "3927e0f0-d29e-43a6-8f46-6cad99862a82",
 "companyKey": "HIPERBANCO_SANDBOX",
 "context": "Account",
 "name": "PAYMENT_ACCOUNT_WAS_UNLOCKED",
 "timestamp": "2023-05-16 11:36:59.801000+00:00",
 "correlationId": "271af454-fddc-4c2a-a7b4-a62bd98de42f",
 "version": "2",
 "data": {
    "status": "APPROVED",
    "branch": "0001",
    "number": "15164",
    "bank": {
       "ispb": "13140088",
       "code": "332",
       "name": "Acesso Soluções Pagamentos S.A"
    },
    "holder": {
       "document": {
          "value": "47742663023",
          "type": "CPF"
       },
       "name": "Nísia Floresta",
       "status": "APPROVED",
       "type": "CUSTOMER"
    }
 }
}