Pocket

beta

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:

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

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:

contextnameDescrição
PocketPOCKET_ACCOUNT_WAS_CREATEDUma conta pocket foi criada.
PocketPOCKET_ACCOUNT_WAS_FULLY_CLOSEDUma conta pocket foi totalmente encerrada.
PocketPOCKET_ACCOUNT_WAS_TECHNICALLY_CLOSEDFoi realizado o encerramento técnico de uma conta pocket.
PocketPOCKET_ACCOUNT_SAVING_WAS_COMPLETEDA conta pocket recebeu um depósito.
PocketPOCKET_ACCOUNT_REDEEM_WAS_COMPLETEDUm valor foi resgatado da conta pocket.
PocketPOCKET_ACCOUNT_SAVING_ERROR_OCCURREDO depósito na conta pocket não pôde ser completado.
PocketPOCKET_ACCOUNT_REDEEM_ERROR_OCCURREDO resgate de valor da conta pocket não pôde ser completado.
PocketPOCKET_ACCOUNT_USER_WAS_CHANGEDO usuário da conta pocket foi alterado.

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:

EventoIdentificador (entityId )Descrição
POCKET_ACCOUNT_WAS_CREATEDpocketNumberNúmero da conta pocket.
POCKET_ACCOUNT_WAS_FULLY_CLOSEDpocketNumberNúmero da conta pocket.
POCKET_ACCOUNT_WAS_TECHNICALLY_CLOSEDpocketNumberNúmero da conta pocket.
POCKET_ACCOUNT_SAVING_WAS_COMPLETEDauthenticationCodeIdentificador da transação.
POCKET_ACCOUNT_REDEEM_WAS_COMPLETEDauthenticationCodeIdentificador da transação.
POCKET_ACCOUNT_SAVING_ERROR_OCCURREDauthenticationCodeIdentificador da transação.
POCKET_ACCOUNT_REDEEM_ERROR_OCCURREDauthenticationCodeIdentificador da transação.
POCKET_ACCOUNT_USER_WAS_CHANGEDpocketNumberNúmero da conta pocket.

Dados dos eventos

POCKET_ACCOUNT_WAS_CREATED

Esse evento sinaliza que uma conta pocket 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:

NomeTipoDescrição
numberstringNúmero da conta pocket.
labelstringNome descritivo da conta pocket.
suffixstringSufixo atribuído ao número da pocket. Exemplo: BRL.
currencystringSigla da moeda corrente da pocket.
typestringTipo da conta com a sigla da moeda. Exemplo: POCKET_BRL.
statusstringSituação da conta pocket.
reasonstringMotivo da situação da conta pocket. Nesse caso, sempre será HOLDER_REQUEST.
categorystringCategoria da conta.
useCasestringMotivo de uso da conta pocket, que pode ser: “ACCOUNT_FOR_UNDER_AGE” (Conta para menor de idade), “CORPORATE_EXPENSES” (Despesas corporativas), “FLEXIBLE_BENEFITS” (Benefícios flexíveis) e “BALANCE_SEGREGATION” (Segregação de saldo).
createdAtstringData de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
userobjectObjeto que contém os dados do usuário da conta pocket.
user.namestringNome do usuário.
user.documentobjectObjeto que contém os dados do documento do usuário da conta pocket.
user.document.valuestringNúmero do documento.
user.document.typestringTipo de documento.
user.birthDatestringData de nascimento do usuário.
accountobjectObjeto que contém os dados da conta de pagamento à qual a pocket está atrealada.
account.branchstringNúmero da agência da conta de pagamento à qual a conta pocket está atrelada.
account.numberstringNúmero da conta de pagamento.
account.statusstringSituação da conta de pagamento que, nesse caso, será “ACTIVE”.
account.reasonstringMotivo da situação da conta de pagamento.
account.createdAtstringData de criação da conta de pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
account.bankobjectObjeto que contém os dados do banco da conta de pagamento.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.
account.categorystringCategoria da conta, que pode ser: “STANDARD_ACCOUNT” (conta padrão) e “PARTNER_ACCOUNT” (conta atrelada ao CNPJ do parceiro).
account.holderobjectObjeto que contém os dados do titular da conta de pagamento à qual a pocket está atrelada.
account.holder.documentobjectObjeto que contém os dados do documento do titular da conta.
account.holder.document.valuestringNúmero do documento.
account.holder.document.typestringTipo do documento.
account.holder.typestringTipo de titular da conta de pagamento, que pode ser “CUSTOMER” e “BUSINESS”.
account.holder.namestringNome do titular da conta de pagamento.
account.holder.statusstringSituação do titular da conta.
account.holder.createdAtstringData de criação 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": "2495218BRL",
      "companyKey": "ACESSO",
      "idempotencyKey": "b4b9812d-b5ce-4577-a223-b0dff8850f0f",
      "context": "Pocket",
      "name": "POCKET_ACCOUNT_WAS_CREATED",
      "version": "2",
      "timestamp": "2022-11-11T20:04:27.7976728Z",
      "correlationId": "a9f174c0-2a95-473c-935a-cc26fded2720",
      "data": {
         "number": "2495218BRL",
         "label": "BRL",
         "suffix": "BRL",
         "currency": "BRL",
         "type": "POCKET_BRL",
         "status": "ACTIVE",
         "reason": "HOLDER_REQUEST",
         "category": "POCKET",
         "useCase": "ACCOUNT_FOR_UNDER_AGE",
         "createdAt": "2022-11-11T20:04:27.7976728Z",
         "user": {
            "name": "Nísia Floresta",
            "document": {
               "value": "47742663023",
               "type": "CPF"
            },
            "birthDate": "1810-10-12T00:00:00Z"
         },
         "account": {
            "branch": "0001",
            "number": "15164",
            "status": "ACTIVE",
            "reason": "HOLDER_REQUEST",
            "createdAt": "2022-11-10T15:14:17.3534",
            "bank": {
               "ispb": "13140088",
               "code": "332",
               "name": "Acesso Soluções De Pagamento S.A."
            },
            "category": "STANDARD_ACCOUNT",
            "holder": {
               "document": {
                  "value": "31293323080",
                  "type": "CPF"
               },
               "type": "CUSTOMER",
               "name": " Dionísia Gonçalves Pinto",
               "status": "ACTIVE",
               "createdAt": "2022-11-10T15:13:02.6346"
            }
         }
      }
   }
]

POCKET_ACCOUNT_WAS_FULLY_CLOSED

Esse evento sinaliza que uma conta pocket foi totalmente encerrada.

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:

NomeTipoDescrição
numberstringNúmero da conta pocket.
labelstringNome descritivo da conta pocket.
suffixstringSufixo atribuído ao número da pocket. Exemplo: “BRL”.
currencystringSigla da moeda corrente da pocket.
typestringTipo da conta com a sigla da moeda. Exemplo: “POCKET_BRL”.
statusstringSituação da conta pocket.
reasonstringMotivo da situação da conta pocket, o qual pode ser: “HOLDER_REQUEST” (solicitação do titular), “COMMERCIAL_DISAGREEMENT” (desacordo comercial), “CONFIRMED_FRAUD” (confirmação de fraude), “DEATH_HOLDER” (morte do titular), “PERSONAL_DOCUMENT_SUSPENDED” (documento do titular suspenso), “PERSONAL_DOCUMENT_NULL” (documento do titular nulo), “PERSONAL_DOCUMENT_CANCELED” (documento do titular cancelado), “BUSINESS_DOCUMENT_WRITE_OFF” (documento da empresa perdido), “BUSINESS_DOCUMENT_NULL” (documento da empresa nulo) e “BEHAVIOR_RISK” (comportamento de risco).
categorystringCategoria da conta.
useCasestringMotivo de uso da conta pocket, que pode ser: “ACCOUNT_FOR_UNDER_AGE” (Conta para menor de idade), “CORPORATE_EXPENSES” (Despesas corporativas), “FLEXIBLE_BENEFITS” (Benefícios flexíveis) e “BALANCE_SEGREGATION” (Segregação de saldo).
createdAtstringData de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
userobjectObjeto que contém os dados do usuário da conta pocket.
user.namestringNome do usuário.
user.documentobjectObjeto que contém os dados do documento do usuário da conta pocket.
uer.document.valuestringNúmero do documento.
user.document.typestringTipo de documento.
user.birthDatestringData de nascimento do usuário.
accountobjectObjeto que contém os dados da conta de pagamento à qual a pocket está atrealada.
account.branchstringNúmero da agência da conta de pagamento à qual a conta pocket está atrelada.
account.numberstringNúmero da conta de pagamento.
account.statusstringSituação da conta de pagamento, que pode ser “ACTIVE” e “CLOSED”.
account.reasonstringMotivo da situação da conta de pagamento, que pode ser “HOLDER_REQUEST” (solicitação do cliente) ou “COMMERCIAL_DISAGREEMENT)” (desacordo comercial).
account.createdAtstringData de criação da conta de pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
account.bankobjectObjeto que contém os dados do banco da conta de pagamento.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.
account.categorystringCategoria da conta, que pode ser: “STANDARD_ACCOUNT” (conta padrão) e “PARTNER_ACCOUNT” (conta atrelada ao CNPJ do parceiro).
account.holderobjectObjeto que contém os dados do titular da conta de pagamento à qual a pocket está atrelada.
account.holder.documentobjectObjeto que contém os dados do documento do titular da conta.
account.holder.document.valuestringNúmero do documento.
account.holder.document.typestringTipo do documento.
account.holder.typestringTipo de titular da conta de pagamento, que pode ser CUSTOMER e BUSINESS.
account.holder.namestringNome do titular da conta de pagamento.
account.holder.statusstringSituação do titular da conta.
account.holder.createdAtstringData de criação 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": "2495218BRL",
      "companyKey": "Acesso",
      "idempotencyKey": "b4b9812d-b5ce-4577-a223-b0dff8850f0f",
      "context": "Pocket",
      "name": "POCKET_ACCOUNT_WAS_FULLY_CLOSED",
      "version": "2",
      "timestamp": "2022-11-11T20:04:27.7976728Z",
      "correlationId": "a9f174c0-2a95-473c-935a-cc26fded2720",
      "data": {
         "number": "2495218BRL",
         "label": "BRL",
         "suffix": "BRL",
         "currency": "BRL",
         "type": "POCKET_BRL",
         "status": "CLOSED",
         "reason": "HOLDER_REQUEST",
         "category": "POCKET",
         "useCase": "ACCOUNT_FOR_UNDER_AGE",
         "createdAt": "2022-11-11T20:04:27.7976728Z",
         "user": {
            "name": "Nísia Floresta",
            "document": {
               "value": "47742663023",
               "type": "CPF"
            },
            "birthDate": "1810-10-12T00:00:00Z"
         },
         "account": {
            "branch": "0001",
            "number": "15164",
            "status": "ACTIVE",
            "reason": "HOLDER_REQUEST",
            "createdAt": "2022-11-10T15:14:17.3534",
            "bank": {
               "ispb": "13140088",
               "code": "332",
               "name": "Acesso Soluções De Pagamento S.A."
            },
            "category": "STANDARD_ACCOUNT",
            "holder": {
               "document": {
                  "value": "31293323080",
                  "type": "CPF"
               },
               "type": "CUSTOMER",
               "name": "Dionísia Gonçalves Pinto",
               "status": "ACTIVE",
               "createdAt": "2022-11-10T15:13:02.6346"
            }
         }
      }
   }
]

POCKET_ACCOUNT_WAS_TECHNICALLY_CLOSED

Esse evento sinaliza que foi realizado o encerramento técnico de uma conta pocket.

Descrição do objeto data do evento

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

NomeTipoDescrição
numberstringNúmero da conta pocket.
labelstringNome descritivo da conta pocket.
suffixstringSufixo atribuído ao número da pocket. Exemplo: “BRL”.
currencystringSigla da moeda corrente da pocket.
typestringTipo da conta com a sigla da moeda. Exemplo: “POCKET_BRL”.
statusstringSituação da conta pocket.
reasonstringMotivo da situação da conta pocket, o qual pode ser: “HOLDER_REQUEST” (solicitação do titular), “COMMERCIAL_DISAGREEMENT” (desacordo comercial), “CONFIRMED_FRAUD” (confirmação de fraude), “DEATH_HOLDER” (morte do titular), “PERSONAL_DOCUMENT_SUSPENDED” (documento do titular suspenso), “PERSONAL_DOCUMENT_NULL” (documento do titular nulo), “PERSONAL_DOCUMENT_CANCELED” (documento do titular cancelado), “BUSINESS_DOCUMENT_WRITE_OFF” (documento da empresa perdido), “BUSINESS_DOCUMENT_NULL” (documento da empresa nulo) e “BEHAVIOR_RISK” (comportamento de risco).
categorystringCategoria da conta.
useCasestringMotivo de uso da conta pocket, que pode ser: “ACCOUNT_FOR_UNDER_AGE” (Conta para menor de idade), “CORPORATE_EXPENSES” (Despesas corporativas), “FLEXIBLE_BENEFITS” (Benefícios flexíveis) e “BALANCE_SEGREGATION” (Segregação de saldo).
createdAtstringData de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
userobjectObjeto que contém os dados do usuário da conta pocket.
user.namestringNome do usuário.
user.documentobjectObjeto que contém os dados do documento do usuário da conta pocket.
user.document.valuestringNúmero do documento.
user.document.typestringTipo de documento.
user.birthDatestringData de nascimento do usuário.
accountobjectObjeto que contém os dados da conta de pagamento à qual a pocket está atrealada.
account.branchstringNúmero da agência da conta de pagamento à qual a conta pocket está atrelada.
account.numberstringNúmero da conta de pagamento.
account.statusstringSituação da conta de pagamento, que pode ser “ACTIVE” ou “CLOSED”.
account.reasonstringMotivo da situação da conta de pagamento, que pode ser “HOLDER_REQUEST” (solicitação do cliente) ou “COMMERCIAL_DISAGREEMENT” (desacordo comercial).
account.createdAtstringData de criação da conta de pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
account.bankobjectObjeto que contém os dados do banco da conta de pagamento.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.
account.categorystringCategoria da conta, que pode ser: “STANDARD_ACCOUNT” (conta padrão) e “PARTNER_ACCOUNT” (conta atrelada ao CNPJ do parceiro).
account.holderobjectObjeto que contém os dados do titular da conta de pagamento à qual a pocket está atrelada.
account.holder.documentobjectObjeto que contém os dados do documento do titular da conta.
account.holder.document.valuestringNúmero do documento.
account.holder.document.typestringTipo do documento.
account.holder.typeobjectTipo de titular da conta de pagamento, que pode ser CUSTOMER e BUSINESS.
account.holder.namestringNome do titular da conta de pagamento.
account.holder.statusstringSituação do titular da conta.
account.holder.createdAtstringData de criação 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": "2495218BRL",
      "companyKey": "Acesso",
      "idempotencyKey": "b4b9812d-b5ce-4577-a223-b0dff8850f0f",
      "context": "Pocket",
      "name": " POCKET_ACCOUNT_WAS_TECHNICALLY_CLOSED ",
      "version": "2",
      "timestamp": "2022-11-11T20:04:27.7976728Z",
      "correlationId": "a9f174c0-2a95-473c-935a-cc26fded2720",
      "data": {
         "number": "2495218BRL",
         "label": "BRL",
         "suffix": "BRL",
         "currency": "BRL",
         "type": "POCKET_BRL",
         "status": "CLOSED",
         "reason": "HOLDER_REQUEST",
         "category": "POCKET",
         "useCase": "ACCOUNT_FOR_UNDER_AGE",
         "createdAt": "2022-11-11T20:04:27.7976728Z",
         "user": {
            "name": "Nísia Floresta",
            "document": {
               "value": "47742663023",
               "type": "CPF"
            },
            "birthDate": "1810-10-12T00:00:00Z"
         },
         "account": {
            "branch": "0001",
            "number": "15164",
            "status": "ACTIVE",
            "reason": "HOLDER_REQUEST",
            "createdAt": "2022-11-10T15:14:17.3534",
            "bank": {
               "ispb": "13140088",
               "code": "332",
               "name": "Acesso Soluções De Pagamento S.A."
            },
            "category": "STANDARD_ACCOUNT",
            "holder": {
               "document": {
                  "value": "31293323080",
                  "type": "CPF"
               },
               "type": "CUSTOMER",
               "name": "Dionísia Gonçalves Pinto",
               "status": "ACTIVE",
               "createdAt": "2022-11-10T15:13:02.6346"
            }
         }
      }
   }
]

POCKET_ACCOUNT_SAVING_WAS_COMPLETED

Esse evento sinaliza que a conta pocket recebeu um depósito.

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:

NomeTipoDescrição
authenticationCodestringIdentificador da transação.
amountobjectObjeto que contém os dados do valor da transação.
amount.valuenumberValor transferido.
amount.currencystringSigla da moeda corrente do valor transferido.
pocketobjectObjeto que contém os dados da conta pocket que recebeu o valor transferido.
pocket.numberstringNúmero da conta pocket.
pocket.statusstringSituaçã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).
pocket.balancesobjectObjeto que contém os dados do saldo da conta pocket.
pocket.balances.totalobjectObjeto que contém os dados do total do saldo da conta pocket.
pocket.balances.total.valuenumberValor do saldo.
pocket.balances.total.currencynumberSigla da moeda corrente do saldo.
pocket.accountobjectObjeto que contém os dados da conta de pagamento (origem da transferência).
pocket.account.branchstringNúmero da agência.
pocket.account.numberstringNúmero da conta.
pocket.account.statusstringSituação da conta de pagamento, a qual pode ser “ACTIVE” (ativa) e “CLOSED” (fechada).
pocket.account.balancesobjectObjeto que contém os dados do saldo da conta de pagamento (origem da transferência).
pocket.account.balances.totalobjectObjeto que contém os dados do total do saldo.
pocket.account.balances.total.valuenumberValor do saldo.
pocket.account.balances.total.currencystringSigla da moeda corrente do saldo.
typestringTipo da transação, que nesse caso será “SAVING”.
statusstringSituação da transação, que pode ser: “CREATED” (criada), “IN_PROCESS” (em processamento), “DONE” (concluída), “UNDONE” (desfeita) e “ERROR” (erro). Nesse caso, será “DONE”.
createdAtstringData e hora da criação da transação no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
updatedAtstringData e hora da atualização da transação no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
descriptionstringDescrição da transação.

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": "b6be9119-acf8-4e9e-88d4-920c58d593f2",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "7c361368-815f-402e-a1f1-2e755d92e81b",
      "context": "Pocket",
      "name": "POCKET_ACCOUNT_SAVING_WAS_COMPLETED",
      "timestamp": "2022-11-14T23:27:39.395993Z",
      "correlationId": "b6be9119-acf8-4e9e-88d4-920c58d593f2",
      "metadata": null,
      "data": {
         "authenticationCode": "b6be9119-acf8-4e9e-88d4-920c58d593f2",
         "amount": {
            "value": 1,
            "currency": "BRL"
         },
         "pocket": {
            "number": "31959760BRL",
            "status": "Active",
            "balances": {
               "total": {
                  "value": 1,
                  "currency": "BRL"
               }
            },
            "account": {
               "branch": "0001",
               "number": "319597",
               "status": "Active",
               "balances": {
                  "total": {
                     "value": 1,
                     "currency": "BRL"
                  }
               }
            }
         },
         "type": "SAVING",
         "status": "DONE",
         "createdAt": "2022-11-14T23:27:36.8126991Z",
         "updatedAt": "2022-11-14T23:27:39.3861663Z",
         "description": "teste"
      },
      "version": "2"
   }
]

POCKET_ACCOUNT_REDEEM_WAS_COMPLETED

Esse evento sinaliza que um valor foi resgatado da conta pocket.

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:

NomeTipoDescrição
authenticationCodestringIdentificador da transação.
amountobjectObjeto que contém os dados do valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda corrente do valor da transação.
pocketobjectObjeto que contém os dados da conta pocket.
pocket.numberstringNúmero da conta pocket.
pocket.statusstringSituaçã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).
pocket.balancesobjectObjeto que contém os dados do saldo da conta pocket.
pocket.balances.totalobjectObjeto que contém os dados do total do saldo.
pocket.balances.total.valuenumberValor do saldo.
pocket.balances.total.currencynumberSigla da moeda corrente do saldo.
pocket.accountobjectObjeto que contém os dados da conta de pagamento à qual a pocket está atrelada.
pocket.account.branchstringNúmero da agência.
pocket.account.numberstringNúmero da conta.
pocket.account.statusstringSituação da conta de pagamento, a qual pode ser “ACTIVE” (ativa) e “CLOSED” (fechada).
pocket.account.balancesobjectObjeto que contém os dados do saldo da conta de pagamento.
pocket.account.balances.totalobjectObjeto que contém os dados do total do saldo.
pocket.account.balances.total.valuenumberValor do saldo.
pocket.account.balances.total.currencystringSigla da moeda corrente do saldo.
pocket.account.bankobjectObjeto que contém os dados do banco da conta de pagamento.
pocket.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
pocket.account.bank.codestringCódigo do banco.
pocket.account.bank.namestringNome do banco.
typestringTipo da transação, que nesse caso será “REDEEM”.
statusstringSituação da transação, que pode ser: “CREATED” (criada), “IN_PROCESS” (em processamento), “DONE” (concluída), “UNDONE” (desfeita) e “ERROR” (erro). Nesse caso, será “DONE”.
createdAtstringData e hora da criação da transação no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
updatedAtstringData e hora da atualização da transação no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
descriptionstringDescrição da transação.

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": "e5da2f2a-beec-403d-9520-c9702e14cd68",
      "companyKey": "fLORESTA_ED",
      "idempotencyKey": "2648c746-bd54-413e-b0d3-998508fbf31b",
      "context": "Pocket",
      "name": "POCKET_ACCOUNT_REDEEM_WAS_COMPLETED",
      "timestamp": "2022-11-16T14:19:16.378529Z",
      "correlationId": "e5da2f2a-beec-403d-9520-c9702e14cd68",
      "metadata": null,
      "data": {
         "authenticationCode": "e5da2f2a-beec-403d-9520-c9702e14cd68",
         "amount": {
            "value": 1,
            "currency": "BRL"
         },
         "pocket": {
            "number": "319597136BRL",
            "status": "Active",
            "balances": {
               "total": {
                  "value": 9997,
                  "currency": "BRL"
               }
            },
            "account": {
               "branch": "0001",
               "number": "319597",
               "status": "Active",
               "balances": {
                  "total": {
                     "value": 4,
                     "currency": "BRL"
                  }
               },
               "bank": {
                  "ispb": "13140088",
                  "code": "332",
                  "name": "Acesso Soluções De Pagamento S.A."
               }
            }
         },
         "type": "REDEEM",
         "status": "DONE",
         "createdAt": "2022-11-16T14:19:15.3189737Z",
         "updatedAt": "2022-11-16T14:19:16.3724601Z",
         "description": "teste"
      },
      "version": "2"
   }
]

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:

NomeTipoDescrição
authenticationCodestringIdentificador da transação.
amountobjectObjeto que contém os dados do valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda corrente do valor da transação.
statusstringSituaçã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”.
pocketobjectObjeto que contém os dados da conta pocket.
pocket.numberstringNúmero da conta.
pocket.statusstringSituaçã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).
accountobjectObjeto que contém os dados da conta de pagamento.
account.branchstringNúmero da agência.
account.numberstringNúmero da conta.
account.statusstringStatus que indica a situação da conta de pagamento.
errors[]array of objectsLista de objetos que contém detalhes do erro.
errors[].codestringCódigo do erro.
errors[].messagesarray of stringsLista 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
[
   {
      "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:

NomeTipoDescrição
authenticationCodestringIdentificador da transação.
amountobjectObjeto que contém os dados do valor da transação.
amount.valuenumberValor da transação.
amount.currencystringSigla da moeda corrente do valor da transação.
statusstringSituaçã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”.
pocketobjectObjeto que contém os dados da conta pocket.
pocket.numberstringNúmero da conta pocket.
pocket.statusstringSituaçã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).
accountobjectObjeto que contém os dados da conta de pagamento.
account.branchstringNúmero da agência da conta de pagamento.
account.numberstringNúmero da conta de pagamento.
account.statusstringStatus que indica a situação da conta de pagamento.
errors[]array of objectsLista de objetos que contém detalhes do erro.
errors[].codestringCódigo do erro.
errors[].messagesarray of stringsLista 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
[
   {
      "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"
            ]
         }
      ]
   }
]

POCKET_ACCOUNT_USER_WAS_CHANGED

Esse evento sinaliza que o usuário da conta pocket foi alterado.

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:

NomeTipoDescrição
numberstringNúmero da conta pocket.
labelstringNome descritivo da conta pocket.
suffixstringSufixo atribuído ao número da pocket. Exemplo: BRL.
currencystringSigla da moeda corrente da pocket.
typestringTipo da conta com a sigla da moeda. Exemplo: POCKET_BRL.
statusstringSituação da conta pocket.
reasonstringMotivo da situação da conta pocket. Nesse caso, sempre será HOLDER_REQUEST.
categorystringCategoria da conta.
useCasestringMotivo de uso da conta pocket, que pode ser: “ACCOUNT_FOR_UNDER_AGE” (Conta para menor de idade), “CORPORATE_EXPENSES” (Despesas corporativas), “FLEXIBLE_BENEFITS” (Benefícios flexíveis) e “BALANCE_SEGREGATION” (Segregação de saldo).
createdAtstringData de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
updatedAtstringData de atualização da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
userobjectObjeto que contém os dados do novo usuário da conta pocket.
user.namestringNome do usuário.
user.documentobjectObjeto que contém os dados do documento do usuário da conta pocket.
user.document.valuestringNúmero do documento.
user.document.typestringTipo de documento.
user.birthDatestringData de nascimento do usuário.
accountobjectObjeto que contém os dados da conta de pagamento à qual a pocket está atrealada.
account.branchstringNúmero da agência da conta de pagamento à qual a conta pocket está atrelada.
account.numberstringNúmero da conta de pagamento.
account.statusstringSituação da conta de pagamento que, nesse caso, será “ACTIVE”.
account.reasonstringMotivo da situação da conta de pagamento.
account.createdAtstringData de criação da conta de pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS.
account.bankobjectObjeto que contém os dados do banco da conta de pagamento.
account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.bank.codestringCódigo do banco.
account.bank.namestringNome do banco.
account.categorystringCategoria da conta, que pode ser: “STANDARD_ACCOUNT” (conta padrão) e “PARTNER_ACCOUNT” (conta atrelada ao CNPJ do parceiro).
account.holderobjectObjeto que contém os dados do titular da conta de pagamento à qual a pocket está atrelada.
account.holder.documentobjectObjeto que contém os dados do documento do titular da conta.
account.holder.document.valuestringNúmero do documento.
account.holder.document.typestringTipo do documento.
account.holder.typestringTipo de titular da conta de pagamento, que pode ser “CUSTOMER” e “BUSINESS”.
account.holder.namestringNome do titular da conta de pagamento.
account.holder.statusstringSituação do titular da conta.
account.holder.createdAtstringData de registro do titular.

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": "1516482BRL",
      "companyKey": "FLORESTA_ED",
      "idempotencyKey": "75a468d5-3f2d-4d23-b215-e86f614c65ef",
      "context": "Pocket",
      "name": "POCKET_ACCOUNT_USER_WAS_CHANGED",
      "timestamp": "2022-11-21T16:35:38.065",
      "correlationId": "00814c94-0367-433d-aae7-42edab62b024",
      "metadata": null,
      "data": {
         "number": "1516482BRL",
         "label": "BRL",
         "suffix": "BRL",
         "currency": "BRL",
         "type": "POCKET_BRL",
         "status": "ACTIVE",
         "reason": "HOLDER_REQUEST",
         "category": "POCKET",
         "useCase": "BALANCE_SEGREGATION",
         "createdAt": "2022-11-21T16:35:38.065",
         "updatedAt": "2022-11-21T16:36:26.2697645Z",
         "user": {
            "name": "Maria Quitéria de Jesus",
            "document": {
               "value": "09992220074",
               "type": "CPF"
            },
            "birthDate": "1792-07-27T00:00:00"
         },
         "account": {
            "branch": "0001",
            "number": "15164",
            "status": "ACTIVE",
            "reason": "HOLDER_REQUEST",
            "createdAt": "2022-10-07T02:08:41.0307",
            "bank": {
               "ispb": "13140088",
               "code": "332",
               "name": "Acesso Soluções De Pagamento S.A."
            },
            "category": "STANDARD_ACCOUNT",
            "holder": {
               "document": {
                  "value": "47742663023",
                  "type": "CPF"
               },
               "type": "CUSTOMER",
               "name": "Nísia Floresta",
               "status": "ACTIVE",
               "createdAt": "2022-10-07T01:59:10.2588"
            }
         }
      },
      "version": "2"
   }
]