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 abaixo na seção Gestão de conta na aba v1 deste manual:
- 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
Recordamos que esta documentação apenas descreve os eventos na versão 2.0. Para saber os detalhes dos demais eventos do contexto "Pocket", acesse a documentação da versão 1.0.
Pré-requisitos
Para receber esses eventos, o parceiro deverá:
- Configurar previamente o recebedor de eventos do webhook. Para mais informações, acesse a seção Webhooks na aba v1 deste manual.
- 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. |
Pocket | POCKET_ACCOUNT_WAS_FULLY_CLOSED | Uma conta pocket foi totalmente encerrada. |
Pocket | POCKET_ACCOUNT_WAS_TECHNICALLY_CLOSED | Foi realizado o encerramento técnico de uma conta pocket. |
Pocket | POCKET_ACCOUNT_SAVING_WAS_COMPLETED | A conta pocket recebeu um depósito. |
Pocket | POCKET_ACCOUNT_REDEEM_WAS_COMPLETED | Um valor foi resgatado da conta pocket. |
Pocket | POCKET_ACCOUNT_USER_WAS_CHANGED | O 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
)
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_WAS_CREATED | pocketNumber | Número da conta pocket. |
POCKET_ACCOUNT_WAS_FULLY_CLOSED | pocketNumber | Número da conta pocket. |
POCKET_ACCOUNT_WAS_TECHNICALLY_CLOSED | pocketNumber | Número da conta pocket. |
POCKET_ACCOUNT_SAVING_WAS_COMPLETED | authenticationCode | Identificador da transação. |
POCKET_ACCOUNT_REDEEM_WAS_COMPLETED | authenticationCode | Identificador da transação. |
POCKET_ACCOUNT_USER_WAS_CHANGED | pocketNumber | Nú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
data
do eventoO 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 |
---|---|---|
number | string | Número da conta pocket. |
label | string | Nome descritivo da conta pocket. |
suffix | string | Sufixo atribuído ao número da pocket. Exemplo: BRL. |
currency | string | Sigla da moeda corrente da pocket. |
type | string | Tipo da conta com a sigla da moeda. Exemplo: POCKET_BRL. |
status | string | Situação da conta pocket. |
reason | string | Motivo da situação da conta pocket. Nesse caso, sempre será HOLDER_REQUEST. |
category | string | Categoria da conta. |
useCase | string | Motivo 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). |
createdAt | string | Data de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
user | object | Objeto que contém os dados do usuário da conta pocket. |
user.name | string | Nome do usuário. |
user.document | object | Objeto que contém os dados do documento do usuário da conta pocket. |
user.document.value | string | Número do documento. |
user.document.type | string | Tipo de documento. |
user.birthDate | string | Data de nascimento do usuário. |
account | object | Objeto que contém os dados da conta de pagamento à qual a pocket está atrealada. |
account.branch | string | Número da agência da conta de pagamento à qual a conta pocket está atrelada. |
account.number | string | Número da conta de pagamento. |
account.status | string | Situação da conta de pagamento que, nesse caso, será “ACTIVE”. |
account.reason | string | Motivo da situação da conta de pagamento. |
account.createdAt | string | Data de criação da conta de pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
account.bank | object | Objeto que contém os dados do banco da conta de pagamento. |
account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
account.bank.code | string | Código do banco. |
account.bank.name | string | Nome do banco. |
account.category | string | Categoria da conta, que pode ser: “STANDARD_ACCOUNT” (conta padrão) e “PARTNER_ACCOUNT” (conta atrelada ao CNPJ do parceiro). |
account.holder | object | Objeto que contém os dados do titular da conta de pagamento à qual a pocket está atrelada. |
account.holder.document | object | Objeto que contém os dados do documento do titular da conta. |
account.holder.document.value | string | Número do documento. |
account.holder.document.type | string | Tipo do documento. |
account.holder.type | string | Tipo de titular da conta de pagamento, que pode ser “CUSTOMER” e “BUSINESS”. |
account.holder.name | string | Nome do titular da conta de pagamento. |
account.holder.status | string | Situação do titular da conta. |
account.holder.createdAt | string | Data 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
data
do eventoO 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 |
---|---|---|
number | string | Número da conta pocket. |
label | string | Nome descritivo da conta pocket. |
suffix | string | Sufixo atribuído ao número da pocket. Exemplo: “BRL”. |
currency | string | Sigla da moeda corrente da pocket. |
type | string | Tipo da conta com a sigla da moeda. Exemplo: “POCKET_BRL”. |
status | string | Situação da conta pocket. |
reason | string | Motivo 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). |
category | string | Categoria da conta. |
useCase | string | Motivo 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). |
createdAt | string | Data de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
user | object | Objeto que contém os dados do usuário da conta pocket. |
user.name | string | Nome do usuário. |
user.document | object | Objeto que contém os dados do documento do usuário da conta pocket. |
uer.document.value | string | Número do documento. |
user.document.type | string | Tipo de documento. |
user.birthDate | string | Data de nascimento do usuário. |
account | object | Objeto que contém os dados da conta de pagamento à qual a pocket está atrealada. |
account.branch | string | Número da agência da conta de pagamento à qual a conta pocket está atrelada. |
account.number | string | Número da conta de pagamento. |
account.status | string | Situação da conta de pagamento, que pode ser “ACTIVE” e “CLOSED”. |
account.reason | string | Motivo da situação da conta de pagamento, que pode ser “HOLDER_REQUEST” (solicitação do cliente) ou “COMMERCIAL_DISAGREEMENT)” (desacordo comercial). |
account.createdAt | string | Data de criação da conta de pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
account.bank | object | Objeto que contém os dados do banco da conta de pagamento. |
account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
account.bank.code | string | Código do banco. |
account.bank.name | string | Nome do banco. |
account.category | string | Categoria da conta, que pode ser: “STANDARD_ACCOUNT” (conta padrão) e “PARTNER_ACCOUNT” (conta atrelada ao CNPJ do parceiro). |
account.holder | object | Objeto que contém os dados do titular da conta de pagamento à qual a pocket está atrelada. |
account.holder.document | object | Objeto que contém os dados do documento do titular da conta. |
account.holder.document.value | string | Número do documento. |
account.holder.document.type | string | Tipo do documento. |
account.holder.type | string | Tipo de titular da conta de pagamento, que pode ser CUSTOMER e BUSINESS. |
account.holder.name | string | Nome do titular da conta de pagamento. |
account.holder.status | string | Situação do titular da conta. |
account.holder.createdAt | string | Data 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
data
do eventoO objetodata
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 |
---|---|---|
number | string | Número da conta pocket. |
label | string | Nome descritivo da conta pocket. |
suffix | string | Sufixo atribuído ao número da pocket. Exemplo: “BRL”. |
currency | string | Sigla da moeda corrente da pocket. |
type | string | Tipo da conta com a sigla da moeda. Exemplo: “POCKET_BRL”. |
status | string | Situação da conta pocket. |
reason | string | Motivo 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). |
category | string | Categoria da conta. |
useCase | string | Motivo 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). |
createdAt | string | Data de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
user | object | Objeto que contém os dados do usuário da conta pocket. |
user.name | string | Nome do usuário. |
user.document | object | Objeto que contém os dados do documento do usuário da conta pocket. |
user.document.value | string | Número do documento. |
user.document.type | string | Tipo de documento. |
user.birthDate | string | Data de nascimento do usuário. |
account | object | Objeto que contém os dados da conta de pagamento à qual a pocket está atrealada. |
account.branch | string | Número da agência da conta de pagamento à qual a conta pocket está atrelada. |
account.number | string | Número da conta de pagamento. |
account.status | string | Situação da conta de pagamento, que pode ser “ACTIVE” ou “CLOSED”. |
account.reason | string | Motivo da situação da conta de pagamento, que pode ser “HOLDER_REQUEST” (solicitação do cliente) ou “COMMERCIAL_DISAGREEMENT” (desacordo comercial). |
account.createdAt | string | Data de criação da conta de pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
account.bank | object | Objeto que contém os dados do banco da conta de pagamento. |
account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
account.bank.code | string | Código do banco. |
account.bank.name | string | Nome do banco. |
account.category | string | Categoria da conta, que pode ser: “STANDARD_ACCOUNT” (conta padrão) e “PARTNER_ACCOUNT” (conta atrelada ao CNPJ do parceiro). |
account.holder | object | Objeto que contém os dados do titular da conta de pagamento à qual a pocket está atrelada. |
account.holder.document | object | Objeto que contém os dados do documento do titular da conta. |
account.holder.document.value | string | Número do documento. |
account.holder.document.type | string | Tipo do documento. |
account.holder.type | object | Tipo de titular da conta de pagamento, que pode ser CUSTOMER e BUSINESS. |
account.holder.name | string | Nome do titular da conta de pagamento. |
account.holder.status | string | Situação do titular da conta. |
account.holder.createdAt | string | Data 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
data
do eventoO 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 transferido. |
amount.currency | string | Sigla da moeda corrente do valor transferido. |
pocket | object | Objeto que contém os dados da conta pocket que recebeu o valor transferido. |
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). |
pocket.balances | object | Objeto que contém os dados do saldo da conta pocket. |
pocket.balances.total | object | Objeto que contém os dados do total do saldo da conta pocket. |
pocket.balances.total.value | number | Valor do saldo. |
pocket.balances.total.currency | number | Sigla da moeda corrente do saldo. |
pocket.account | object | Objeto que contém os dados da conta de pagamento (origem da transferência). |
pocket.account.branch | string | Número da agência. |
pocket.account.number | string | Número da conta. |
pocket.account.status | string | Situação da conta de pagamento, a qual pode ser “ACTIVE” (ativa) e “CLOSED” (fechada). |
pocket.account.balances | object | Objeto que contém os dados do saldo da conta de pagamento (origem da transferência). |
pocket.account.balances.total | object | Objeto que contém os dados do total do saldo. |
pocket.account.balances.total.value | number | Valor do saldo. |
pocket.account.balances.total.currency | string | Sigla da moeda corrente do saldo. |
type | string | Tipo da transação, que nesse caso será “SAVING”. |
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á “DONE”. |
createdAt | string | Data e hora da criação da transação no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
updatedAt | string | Data e hora da atualização da transação no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
description | string | Descriçã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
data
do eventoO 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. |
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). |
pocket.balances | object | Objeto que contém os dados do saldo da conta pocket. |
pocket.balances.total | object | Objeto que contém os dados do total do saldo. |
pocket.balances.total.value | number | Valor do saldo. |
pocket.balances.total.currency | number | Sigla da moeda corrente do saldo. |
pocket.account | object | Objeto que contém os dados da conta de pagamento à qual a pocket está atrelada. |
pocket.account.branch | string | Número da agência. |
pocket.account.number | string | Número da conta. |
pocket.account.status | string | Situação da conta de pagamento, a qual pode ser “ACTIVE” (ativa) e “CLOSED” (fechada). |
pocket.account.balances | object | Objeto que contém os dados do saldo da conta de pagamento. |
pocket.account.balances.total | object | Objeto que contém os dados do total do saldo. |
pocket.account.balances.total.value | number | Valor do saldo. |
pocket.account.balances.total.currency | string | Sigla da moeda corrente do saldo. |
pocket.account.bank | object | Objeto que contém os dados do banco da conta de pagamento. |
pocket.account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
pocket.account.bank.code | string | Código do banco. |
pocket.account.bank.name | string | Nome do banco. |
type | string | Tipo da transação, que nesse caso será “REDEEM”. |
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á “DONE”. |
createdAt | string | Data e hora da criação da transação no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
updatedAt | string | Data e hora da atualização da transação no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
description | string | Descriçã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_USER_WAS_CHANGED
Esse evento sinaliza que o usuário da conta pocket foi alterado.
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 |
---|---|---|
number | string | Número da conta pocket. |
label | string | Nome descritivo da conta pocket. |
suffix | string | Sufixo atribuído ao número da pocket. Exemplo: BRL. |
currency | string | Sigla da moeda corrente da pocket. |
type | string | Tipo da conta com a sigla da moeda. Exemplo: POCKET_BRL. |
status | string | Situação da conta pocket. |
reason | string | Motivo da situação da conta pocket. Nesse caso, sempre será HOLDER_REQUEST. |
category | string | Categoria da conta. |
useCase | string | Motivo 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). |
createdAt | string | Data de criação da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
updatedAt | string | Data de atualização da conta pocket, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
user | object | Objeto que contém os dados do novo usuário da conta pocket. |
user.name | string | Nome do usuário. |
user.document | object | Objeto que contém os dados do documento do usuário da conta pocket. |
user.document.value | string | Número do documento. |
user.document.type | string | Tipo de documento. |
user.birthDate | string | Data de nascimento do usuário. |
account | object | Objeto que contém os dados da conta de pagamento à qual a pocket está atrealada. |
account.branch | string | Número da agência da conta de pagamento à qual a conta pocket está atrelada. |
account.number | string | Número da conta de pagamento. |
account.status | string | Situação da conta de pagamento que, nesse caso, será “ACTIVE”. |
account.reason | string | Motivo da situação da conta de pagamento. |
account.createdAt | string | Data de criação da conta de pagamento, no formato yyyy-MM-dd'T'HH:mm:ss.SSS. |
account.bank | object | Objeto que contém os dados do banco da conta de pagamento. |
account.bank.ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
account.bank.code | string | Código do banco. |
account.bank.name | string | Nome do banco. |
account.category | string | Categoria da conta, que pode ser: “STANDARD_ACCOUNT” (conta padrão) e “PARTNER_ACCOUNT” (conta atrelada ao CNPJ do parceiro). |
account.holder | object | Objeto que contém os dados do titular da conta de pagamento à qual a pocket está atrelada. |
account.holder.document | object | Objeto que contém os dados do documento do titular da conta. |
account.holder.document.value | string | Número do documento. |
account.holder.document.type | string | Tipo do documento. |
account.holder.type | string | Tipo de titular da conta de pagamento, que pode ser “CUSTOMER” e “BUSINESS”. |
account.holder.name | string | Nome do titular da conta de pagamento. |
account.holder.status | string | Situação do titular da conta. |
account.holder.createdAt | string | Data 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"
}
Updated 2 days ago