Pocket

stable

Os eventos relacionados às pockets disparam mensagens sempre que há atualizações sobre a criação, mudança de usuário, encerramento, depósitos, resgates de valores e falhas nas transações com contas pockets.

Para mais informações sobre quando essas mensagens são disparadas e sobre o seu conteúdo, consulte as páginas:

• Criação de conta pocket;
• Alteração do usuário;
• Encerramento de conta pocket;
• Depósito em uma conta pocket;
• Resgate de um valor da conta pocket.

🚧

Importante

Os eventos POCKET_ACCOUNT_WAS_CREATED, POCKET_ACCOUNT_WAS_FULLY_CLOSED, POCKET_ACCOUNT_WAS_TECHNICALLY_CLOSED, POCKET_ACCOUNT_SAVING_WAS_COMPLETED, POCKET_ACCOUNT_REDEEM_WAS_COMPLETED e POCKET_ACCOUNT_USER_WAS_CHANGED já estão na versão 2.0. Para acessar a documentação que descreve os campos retornados nestes eventos, basta selecionar a versão desejada (v2) no menu suspenso localizado no canto superior esquerdo da página.

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

O contexto (context) e o nome do evento (name) poderão variar de acordo com a tabela a seguir:

context	name	Descrição
Pocket	POCKET_ACCOUNT_WAS_CREATED	Uma conta pocket foi criada (v2).
Pocket	POCKET_ACCOUNT_WAS_FULLY_CLOSED	Uma conta pocket foi totalmente encerrada (v2).
Pocket	POCKET_ACCOUNT_WAS_TECHNICALLY_CLOSED	Foi realizado o encerramento técnico de uma conta pocket (v2).
Pocket	POCKET_ACCOUNT_SAVING_WAS_COMPLETED	A conta pocket recebeu um depósito (v2).
Pocket	POCKET_ACCOUNT_REDEEM_WAS_COMPLETED	Um valor foi resgatado da conta pocket (v2).
Pocket	POCKET_ACCOUNT_SAVING_ERROR_OCCURRED	O depósito na conta pocket não pôde ser completado.
Pocket	POCKET_ACCOUNT_REDEEM_ERROR_OCCURRED	O resgate de valor da conta pocket não pôde ser completado.
Pocket	POCKET_ACCOUNT_USER_WAS_CHANGED	O usuário da conta pocket foi alterado (v2).

Fluxo dos eventos

Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem com base no contexto em que eles estão inseridos. Clique nas imagens para ampliá-las:

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
POCKET_ACCOUNT_SAVING_ERROR_OCCURRED	authenticationCode	Identificador da transação.
POCKET_ACCOUNT_REDEEM_ERROR_OCCURRED	authenticationCode	Identificador da transação.

🚧

Importante

Recordamos que esta documentação apenas descreve os eventos na versão 1.0. Para saber os detalhes dos demais eventos, acesse a documentação da versão 2.0.

Dados dos eventos

POCKET_ACCOUNT_SAVING_ERROR_OCCURRED

Esse evento sinaliza que o depósito na conta pocket não pôde ser completado.

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
authenticationCode	string	Identificador da transação.
amount	object	Objeto que contém os dados do valor da transação.
amount.value	number	Valor da transação.
amount.currency	string	Sigla da moeda corrente do valor da transação.
status	string	Situação da transação, que pode ser “CREATED” (criada), “IN_PROCESS” (em processamento), “DONE” (concluída), “UNDONE” (desfeita) e “ERROR” (erro). Nesse caso, será “ERROR”.
pocket	object	Objeto que contém os dados da conta pocket.
pocket.number	string	Número da conta.
pocket.status	string	Situação da conta pocket, que pode ser: “ACTIVE” (ativa), “DORMANT” (não recebeu nenhuma movimentação no período de 60 dias), “LOCKED” (não permite realizar movimentações), “CLOSED” (fechada).
account	object	Objeto que contém os dados da conta de pagamento.
account.branch	string	Número da agência.
account.number	string	Número da conta.
account.status	string	Status que indica a situação da conta de pagamento.
errors[]	array of objects	Lista de objetos que contém detalhes do erro.
errors[].code	string	Código do erro.
errors[].messages	array of strings	Lista de erros.

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

JSON

{
      "entityId": "062c2297-3d6e-4a05-843e-8bfd82be0452",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "ACESSO",
      "context": "Pocket",
      "name": "POCKET_ACCOUNT_SAVING_ERROR_OCCURRED",
      "timestamp": "2021-10-05T00:00:01.000Z",
      "correlationId": "61833e96-86ea-4248-9700-5fd08a00bcb2",
      "version": "1",
      "metadata": {
         "key1": "value1",
         "key2": "value2"
      },
      "data": {
         "authenticationCode": "062c2297-3d6e-4a05-843e-8bfd82be0452",
         "amount": {
            "value": 2.3,
            "currency": "BRL"
         },
         "status": "ERROR",
         "pocket": {
            "number": "24635282BRL",
            "status": "Active"
         },
         "account": {
            "branch": "0001",
            "number": "15164",
            "status": "Active"
         }
      },
      "errors": [
         {
            "code": "SOME_ERROR",
            "messages": [
               "some error occurs"
            ]
         }
      ]
 }

POCKET_ACCOUNT_REDEEM_ERROR_OCCURRED

Esse evento sinaliza que o resgate de valor da conta pocket não pôde ser completado.

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
authenticationCode	string	Identificador da transação.
amount	object	Objeto que contém os dados do valor da transação.
amount.value	number	Valor da transação.
amount.currency	string	Sigla da moeda corrente do valor da transação.
status	string	Situação da transação, que pode ser “CREATED” (criada), “IN_PROCESS” (em processamento), “DONE” (concluída), “UNDONE” (desfeita) e “ERROR” (erro). Nesse caso, será “ERROR”.
pocket	object	Objeto que contém os dados da conta pocket.
pocket.number	string	Número da conta pocket.
pocket.status	string	Situação da conta pocket, que pode ser: “ACTIVE” (ativa), “DORMANT” (não recebeu nenhuma movimentação no período de 60 dias), “LOCKED” (não permite realizar movimentações), “CLOSED” (fechada).
account	object	Objeto que contém os dados da conta de pagamento.
account.branch	string	Número da agência da conta de pagamento.
account.number	string	Número da conta de pagamento.
account.status	string	Status que indica a situação da conta de pagamento.
errors[]	array of objects	Lista de objetos que contém detalhes do erro.
errors[].code	string	Código do erro.
errors[].messages	array of strings	Lista de erros.

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

JSON

{
      "entityId": "062c2297-3d6e-4a05-843e-8bfd82be0452",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "ACESSO",
      "context": "Pocket",
      "name": "POCKET_ACCOUNT_REDEEM_ERROR_OCCURRED",
      "timestamp": "2021-10-05T00:00:01.000Z",
      "correlationId": "61833e96-86ea-4248-9700-5fd08a00bcb2",
      "version": "1",
      "metadata": {
         "key1": "value1",
         "key2": "value2"
      },
      "data": {
         "authenticationCode": "062c2297-3d6e-4a05-843e-8bfd82be0452",
         "amount": {
            "value": 2.3,
            "currency": "BRL"
         },
         "status": "ERROR",
         "pocket": {
            "number": "24635282BRL",
            "status": "Active"
         },
         "account": {
            "branch": "0001",
            "number": "15164",
            "status": "Active"
         }
      },
      "errors": [
         {
            "code": "SOME_ERROR",
            "messages": [
               "some error occurs"
            ]
         }
      ]
 }