Contas (Account)
stable
Os eventos relacionados a contas disparam mensagens que comunicam ao destinatário a abertura, o encerramento, o bloqueio e o desbloqueio de uma conta e sobre o processo de bloqueio/desbloqueio judicial de valores.
Para mais informações sobre quando essas mensagens são disparadas e sobre o seu conteúdo, consulte as páginas:
Dica
Os eventos referentes à contas podem estar em versões diferentes. Para identificar a versão do evento, confira o campo
version
no header do payload.
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 (context ) | Nome do evento (name ) | Descrição |
---|---|---|
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. |
Account | PAYMENT_ACCOUNT_WAS_UNLOCKED | A conta foi desbloqueada. |
Account | AMOUNT_WAS_BLOCKED | O valor foi bloqueado (Bloqueio judicial). |
Account | AMOUNT_WAS_UNBLOCKED | O valor foi desbloqueado (Bloqueio judicial). |
Fluxo dos eventos
O fluxograma a seguir descreve a sequência em que os eventos ocorrem. Clique na imagem para ampliá-la:

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 |
---|---|---|
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. |
PAYMENT_ACCOUNT_WAS_LOCKED | account.number | Número da conta do cliente. |
PAYMENT_ACCOUNT_WAS_UNLOCKED | 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. |
Dados dos eventos
ACCOUNT_WAS_CREATED
Este evento sinaliza que a conta 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 |
---|---|---|
document | object | Objeto que contém informações sobre o documento do titular da conta. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento, o qual pode ser "CPF" ou "CNPJ". |
type | string | Tipo de titular, o qual pode ser "Customer" ou "Business". |
name | string | Nome do titular. |
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, o qual 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 de 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": "COMPANY_KEY",
"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
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 |
---|---|---|
document | object | Objeto que contém informações sobre o documento do titular da conta. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento, o qual pode ser "CPF" ou "CNPJ". |
type | string | Tipo de titular, o qual pode ser "Customer" ou "Business". |
name | string | Nome do titular. |
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, o qual 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" e "BEHAVIOR_RISK". |
account.specialAccountType | string | Obsoleto. Considere o campo specialType . |
account.specialType | string | Indica se a conta pertence a um parceiro (PARTNER_ACCOUNT) ou de 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": "c260fa8-ee90-4981-8928-4c665eeae3b9",
"entityId": "66635780",
"companyKey": "COMPANY_KEY",
"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
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 |
---|---|---|
document | object | Objeto que contém informações sobre o documento do titular da conta. |
document.value | string | Número do documento. |
document.type | string | Tipo do documento, o qual pode ser "CPF" ou "CNPJ". |
type | string | Tipo de titular, o qual pode ser "Customer" ou "Business". |
name | string | Nome do titular. |
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, o qual 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" e "BEHAVIOR_RISK". |
account.specialAccountType | string | Obsoleto. Considere o campo specialType . |
account.specialType | string | Indica se a conta pertence a um parceiro (PARTNER_ACCOUNT) ou de 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": "af48363-efbb-4b2c-ae06-fedd2b5e641a",
"entityId": "55371710",
"companyKey": "COMPANY_KEY",
"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"
}
]
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 | Situação da conta, que nesse caso será "LOCKED". |
reason | string | Motivo do bloqueio da conta . |
branch | string | Número da agência bancária. |
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 os dados do documento do titular da conta. |
holder.document.value | string | Número do documento do titular da conta. |
holder.document.type | string | Tipo do documento, o qual pode ser "CPF" ou "CNPJ". |
holder.name | string | Nome do cliente titular da conta. |
holder.status | string | Situação do cliente titular da conta, o qual pode ser PENDING_APPROVAL, APPROVED, IN_ANALYSIS, REPROVED e BLOCKLISTED. |
holder.type | string | Tipo de titular, o qual 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 a causa do bloqueio e serve como guia para o orientar o cliente sobre o que fazer para desbloquear a conta (quando for o caso).
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": "ACESSO",
"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 | Situação da conta, que pode ser: "Active", "Closed" ou "Locked". |
branch | string | Número da agência bancária. |
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 os dados do documento do titular da conta. |
holder.document.value | string | Número do documento do titular da conta. |
holder.document.type | string | Tipo do documento, o qual pode ser "CPF" ou "CNPJ". |
holder.name | string | Nome do cliente titular da conta. |
holder.status | string | Situação do cliente titular da conta, o qual pode ser PENDING_APPROVAL, APPROVED, IN_ANALYSIS, REPROVED e BLOCKLISTED. |
holder.type | string | Tipo de titular, o qual 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": "ACESSO",
"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"
}
}
}
]
AMOUNT_WAS_BLOCKED
Este evento sinaliza que o valor foi bloqueado.
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 |
---|---|---|
judicialBlockId | string | Identificador único do bloqueio judicial. |
createdAt | string | Data em que ocorreu o bloqueio judicial. |
status | string | Situação do bloqueio judicial, a qual 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 | Sigla da moeda utilizada, de acordo com a ISO 4217. Exemplos: “BRL”, “USD” e “EUR”. |
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 | Sigla da moeda utilizada, de acordo com a ISO 4217. Exemplos: “BRL”, “USD” e “EUR”. |
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, o qual pode ser: “CPF” ou “CNPJ”. |
holder.type | string | Tipo de titular, o qual 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, o qual pode ser "CHECKING" para conta-corrente, "SALARY" para conta-salário, "SAVINGS" para conta-poupança e "PAYMENT" para conta de pagamento. |
holder.account.status | string | Situação da conta, a qual 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 | Sigla da moeda utilizada, de acordo com a ISO 4217. Exemplos: “BRL”, “USD” e “EUR”. |
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 | Sigla da moeda utilizada, de acordo com a ISO 4217. Exemplos: “BRL”, “USD” e “EUR”. |
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": "ACESSO",
"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
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 |
---|---|---|
judicialBlockId | string | Identificador único do bloqueio judicial. |
createdAt | string | Data em que ocorreu o bloqueio judicial. |
status | string | Situação do desbloqueio judicial, a qual 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 | Sigla da moeda utilizada, de acordo com a ISO 4217. Exemplos: “BRL”, “USD” e “EUR”. |
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 | Sigla da moeda utilizada, de acordo com a ISO 4217. Exemplos: “BRL”, “USD” e “EUR”. |
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, o qual pode ser “CPF” ou “CNPJ”. |
holder.type | string | Tipo de titular, o qual 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, o qual pode ser "CHECKING" para conta corrente, "SALARY" para conta salário, "SAVINGS" para conta poupança e "PAYMENT" para conta de pagamento. |
holder.account.status | string | Situação da conta, a qual 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 | Sigla da moeda utilizada, de acordo com a ISO 4217. Exemplos: “BRL”, “USD” e “EUR”. |
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 | Sigla da moeda utilizada, de acordo com a ISO 4217. Exemplos: “BRL”, “USD” e “EUR”. |
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": "ACESSO",
"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"
}
}
}
}
}
}
]
Updated 5 days ago