Pocket

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.

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:

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:

🚧

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:

Payload do evento

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

{
      "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:

Payload do evento

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

{
      "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"
            ]
         }
      ]
 }