Manual do Dev
InstitucionalBlogService DeskStatus Page

Contas (Account)

stable

Os eventos do contexto de contas (Account) disparam mensagens que comunicam ao destinatário sobre:

  • O aceite do acordo legal realizado pelo cliente;
  • A criação e o cancelamento do titular de uma conta;
  • A abertura e o encerramento de uma conta;
  • O bloqueio e o desbloqueio de uma conta;
  • 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:

🚧

Importante

Os eventos PAYMENT_ACCOUNT_WAS_LOCKED e PAYMENT_ACCOUNT_WAS_UNLOCKED já estão na versão 2.0.

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

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
AccountLEGAL_AGREEMENT_WAS_ACCEPTEDO acordo legal foi aceito pelo cliente.
AccountACCOUNT_HOLDER_WAS_CREATEDO titular da conta foi criado com sucesso após a conclusão do registro do cliente (pessoa física ou jurídica).
AccountACCOUNT_HOLDER_WAS_CANCELEDO vínculo com o titular da conta foi encerrado.
AccountACCOUNT_WAS_CREATEDA conta foi criada.
AccountACCOUNT_WAS_CLOSEDA conta foi encerrada tecnicamente.
AccountACCOUNT_WAS_LEGALLY_CLOSEDA conta foi encerrada legalmente. Neste caso, o Banco central foi informado do encerramento.
AccountPAYMENT_ACCOUNT_WAS_LOCKEDA conta foi bloqueada (v2).
AccountPAYMENT_ACCOUNT_WAS_UNLOCKEDA conta foi desbloqueada (v2).
AccountAMOUNT_WAS_BLOCKEDO valor foi bloqueado (bloqueio judicial).
AccountAMOUNT_WAS_UNBLOCKEDO valor foi desbloqueado (bloqueio judicial).

Fluxo dos eventos

Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem. Cliques nas imagens para ampliá-las:

Criação da conta

Bloqueio da conta

Bloqueio de saldo

Cancelamento da conta

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
LEGAL_AGREEMENT_WAS_ACCEPTEDidIdentificador único do aceite do acordo legal.
ACCOUNT_HOLDER_WAS_CREATEDIdentificador único do titular da conta.Código único gerado no momento da criação do titular da conta.
ACCOUNT_HOLDER_WAS_CANCELEDIdentificador único do titular da conta.Código único gerado no momento da criação do titular da conta.
ACCOUNT_WAS_CREATEDaccount.numberNúmero da conta do cliente.
ACCOUNT_WAS_CLOSEDaccount.numberNúmero da conta do cliente.
ACCOUNT_WAS_LEGALLY_CLOSEDaccount.numberNúmero da conta do cliente.
AMOUNT_WAS_BLOCKEDjudicialBlockIdIdentificador único do bloqueio judicial.
AMOUNT_WAS_UNBLOCKEDjudicialBlockIdIdentificador único do bloqueio judicial.

🚧

Importante

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

Dados dos eventos

LEGAL_AGREEMENT_WAS_ACCEPTED

Esse evento sinaliza que o acordo legal foi aceito pelo cliente.

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çãoNúmero máximo de caracteres
idstringIdentificador único do aceite do acordo legal.36
holderobjectObjeto que contém informações sobre o titular da conta.—
holder.documentobjectObjeto que contém informações sobre o documento do titular.—
holder.document.valuestringNúmero do documento.14
holder.document.typestringTipo do documento, que pode ser "CPF" ou "CNPJ".—
holder.accountobjectObjeto que contém informações sobre a conta do titular.—
holder.account.branchstringNúmero da agência.4
holder.account.numberstringNúmero da conta.13
holder.account.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.—
holder.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.8
holder.account.bank.codestringCódigo do banco.3
holder.account.bank.namestringNome do banco.—
typestringTipo do acordo aceito, que, por padrão, será "TERMS_AND_CONDITIONS_OF_USE" (termos e condições de uso).—
acceptedAtstringData e hora em que o acordo foi aceito, no formato ISO-8601 .—

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": "8f55f89c-7d00-4171-ad30-7ccfbe96c3f7",
    "companyKey": "COMPANY_KEY",
    "idempotencyKey": "a5250f9c-378d-471a-86af-f78ba7ecdbcf",
    "context": "Account",
    "name": "LEGAL_AGREEMENT_WAS_ACCEPTED",
    "version": "1.0",
    "timestamp": "2023-07-06T17:55:10.169697Z",
    "correlationId": "333d0c27-8301-4fe5-b3b0-f3d8627e6f5e",
  	"metadata": null,
    "data": {
        "id": "aae3ada7-9c4a-4184-b46e-1ab8d8009a4b",
        "holder": {
            "document": {
                "value": "47742663023",
                "type": "CPF"
            },
            "account": {
                "number": "15164",
                "branch": "0001",
                "bank": {
                    "ispb": "13140088",
                    "code": "332",
                    "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                }
            },
        },
        "type": "TERMS_AND_CONDITIONS_OF_USE",
        "acceptedAt": "2023-07-06T17:55:10.169697Z"
    }
}

ACCOUNT_HOLDER_WAS_CREATED

Esse evento sinaliza que o titular da conta foi criado com sucesso após a conclusão do registro do cliente no processo de Onboarding.

📘

Nota

O registro do cliente é confirmado pelo evento CUSTOMER_WAS_APPROVED, em caso de pessoa física, e pelo evento BUSINESS_WAS_APPROVED, em caso de pessoa jurídica.

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çãoNúmero máximo de caracteres
licenseobjectObjeto que contém informações sobre a licença bancária utilizada pelo parceiro.—
license.uuidstringIdentificador único da licença.40
documentobjectObjeto que contém informações sobre o documento do cliente.—
document.valuestringNúmero do documento.14
document.typestringTipo do documento, que pode ser "CPF" ou "CNPJ".4
namestringNome do cliente.256
statusstringSituação do registro do cliente (status da análise KYC). Nesse caso, o status será sempre “APPROVED”.20
typestringTipo de cliente, que pode ser "Customer" ou "Business".15

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": "d8026b493fe04873775ef3d4fd9884bb6c6aea63", 
   "companyKey": "FLORESTA_ED", 
   "licenseUuid": "24ac71da-4309-4348-9cc0-a0c88f867993", 
   "idempotencyKey": "519fecda-84a8-45bb-8737-efdf3805053a", 
   "context": "Account", 
   "name": "ACCOUNT_HOLDER_WAS_CREATED", 
   "timestamp": "2024-03-05T13:32:36.6267395Z", 
   "correlationId": "4de50511-3aa7-44fa-b20b-4a844c90a9f5", 
   "data": { 
      "license": { 
         "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993" 
      }, 
      "document": { 
          "value": "47742663023", 
          "type": "CPF" 
      }, 
      "name": "Nísia Floresta", 
      "status": "APPROVED", 
      "type": "Customer" 
    } 
}

ACCOUNT_HOLDER_WAS_CANCELED

Esse evento sinaliza que o vínculo comercial com o cliente e todas as suas contas foram encerrados com sucesso por meio do processo de Offboarding.

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çãoNúmero máximo de caracteres
licenseobjectObjeto que contém informações sobre a licença bancária utilizada pelo parceiro.—
license.uuidstringIdentificador único da licença.40
documentobjectObjeto que contém informações sobre o documento do cliente.—
document.valuestringNúmero do documento.14
document.typestringTipo do documento, que pode ser "CPF" ou "CNPJ".4
typestringTipo de cliente, que pode ser "Customer" ou "Business".15
namestringNome do cliente.256
statusstringSituação do registro do cliente (status da análise KYC). Nesse caso, o status será sempre “CANCELED”.20
accountsarray of objectsLista de objetos que contém informações sobre a(s) conta(s). Observação: caso cliente não possua nenhuma conta aberta, este objeto retornará nulo.—
accounts.programIdstringIdentificador do programa de contas.40
accounts.branchstringNúmero da agência.4
accounts.numberstringNúmero da conta.15
accounts.typestringTipo da conta, que pode ser "Payment" (pagamento) ou "Checking" (corrente).20
accounts.statusstringSituação da conta, que pode ser "Active" ou "Closed".30
accounts.reasonstringMotivo da abertura ou fechamento da conta.32
accounts.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.—
accounts.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.15
accounts.bank.codestringCódigo do banco.5
accounts.bank.namestringNome do banco.255
accounts.specialTypestringTipo da conta.30
accounts.statusReasonstringMotivo da abertura ou fechamento da conta. Campo obsoleto, porém retorna neste evento.32
accounts.specialAccountTypestringTipo da conta. Campo obsoleto, porém retorna neste evento.30

Payload do evento

Os payloads abaixo exemplificam a estrutura dos eventos que deverão ser recebidos pelo parceiro. Clique na seta para expandi-los:

Exemplo de payload 
{ 

   "entityId": "d8026b493fe04873775ef3d4fd9884bb6c6aea63", 
   "companyKey": "FLORESTA_ED", 
   "idempotencyKey": "e21ae7ff-b1b5-4f52-8723-118566e27168", 
   "context": "Account",
   "name": "ACCOUNT_HOLDER_WAS_CANCELED", 
   "timestamp": "2024-03-05T14:52:38.9873694Z", 
   "correlationId": "f2450fba-21a5-4af3-a064-d5414f6d6abe", 
   "data": { 
      "license": { 
         "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993" 
      }, 
      "document": { 
         "value": "47742663023", 
         "type": "CPF" 
      }, 
     "name": "Nísia Floresta", 
     "status": "CANCELED", 
     "type": "Customer",
     "accounts": [{ 
        "programId": "97b85afb-8c4f-4fcf-940c-054299aa6acc", 
        "branch": "0001", 
        "number": "1101894102", 
        "type": "Payment", 
        "status": "Closed", 
        "reason": "HOLDER_REQUEST", 
        "bank": { 
           "ispb": "13140088", 
           "code": "332", 
           "name": "Acesso Soluções De Pagamento S.A." 
        }, 
        "specialType": "STANDARD_ACCOUNT", 
        "statusReason": "HOLDER_REQUEST", 
        "specialAccountType": "PAYMENT_ACCOUNT" 
     }], 
   }, 
   "statusReason": "HOLDER_REQUEST" 
} 

{ 

   "entityId": "d8026b493fe04873775ef3d4fd9884bb6c6aea63", 
   "companyKey": "FLORESTA_ED", 
   "idempotencyKey": "e21ae7ff-b1b5-4f52-8723-118566e27168", 
   "context": "Account",
   "name": "ACCOUNT_HOLDER_WAS_CANCELED", 
   "timestamp": "2024-03-05T14:52:38.9873694Z", 
   "correlationId": "f2450fba-21a5-4af3-a064-d5414f6d6abe", 
   "data": { 
      "license": { 
         "uuid": "24ac71da-4309-4348-9cc0-a0c88f867993" 
      }, 
      "document": { 
         "value": "47742663023", 
         "type": "CPF" 
      }, 
     "name": "Nísia Floresta", 
     "status": "CANCELED", 
     "type": "Customer", 
     "accounts": null, 
        "specialType": null,
        "statusReason": null, 
        "specialAccountType": null
      
     },
   "statusReason": "HOLDER_REQUEST" 
   }

ACCOUNT_WAS_CREATED

Este evento sinaliza que a conta 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
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento, que pode ser "CPF" ou "CNPJ".
typestringTipo de cliente, que pode ser "Customer" ou "Business".
namestringNome do cliente.
accountobjectObjeto que contém informações sobre a conta.
account.programIdstringIdentificador do programa de contas que determina o tipo de conta.
account.branchstringNúmero da agência.
account.numberstringNúmero da conta.
account.typestringTipo da conta, que pode ser "Payment" (de pagamento) ou "Checking" (corrente)
account.statusstringSituação da conta, que pode ser "Active" ou "Closed".
account.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.
account.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.codestringCódigo do banco.
account.namestringNome do banco.
account.specialAccountTypestringObsoleto. Considere o campo specialType.
account.specialTypestringIndica se a conta pertence a um parceiro (PARTNER_ACCOUNT) ou a 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

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
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento, que pode ser "CPF" ou "CNPJ".
typestringTipo de cliente, que pode ser "Customer" ou "Business".
namestringNome do cliente.
accountobjectObjeto que contém informações sobre a conta.
account.programIdstringIdentificador do programa de contas que determina o tipo de conta.
account.branchstringNúmero da agência.
account.numberstringNúmero da conta.
account.typestringTipo da conta, que pode ser "Payment" (de pagamento) ou "Checking" (corrente).
account.statusstringSituação da conta, que pode ser "Active" ou "Closed".
account.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.
account.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.codestringCódigo do banco.
account.namestringNome do banco.
statusReasonstringObsoleto. Considere o campo reason.
reasonstringMotivo pelo qual ocorreu o encerramento da conta, que pode ser "HOLDER_REQUEST" (solicitação do titular), "COMMERCIAL_DISAGREEMENT" (desacordo comercial), "CONFIRMED_FRAUD" (fraude confirmada) e "BEHAVIOR_RISK" (comportamento de risco).
account.specialAccountTypestringObsoleto. Considere o campo specialType.
account.specialTypestringIndica se a conta pertence a um parceiro (PARTNER_ACCOUNT) ou a um cliente parceiro (STANDARD_ACCOUNT). Observação: esse campo também pode retornar com o valor PAYMENT_ACCOUNT, em caso de encerramento de conta cuja criação tenha sido anterior a 15/02/2023.

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

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
documentobjectObjeto que contém informações sobre o documento do cliente.
document.valuestringNúmero do documento.
document.typestringTipo do documento, que pode ser "CPF" ou "CNPJ".
typestringTipo de cliente, que pode ser "Customer" ou "Business".
namestringNome do cliente.
accountobjectObjeto que contém informações sobre a conta.
account.programIdstringIdentificador do programa de contas que determina o tipo de conta.
account.branchstringNúmero da agência.
account.numberstringNúmero da conta.
account.typestringTipo da conta, que pode ser "Payment" (de pagamento) ou "Checking" (corrente)
account.statusstringSituação da conta, que pode ser "Active" ou "Closed",
account.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.
account.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
account.codestringCódigo do banco.
account.namestringNome do banco.
statusReasonstringObsoleto. Considere o campo reason.
reasonstringMotivo pelo qual ocorreu o encerramento da conta, que pode ser "HOLDER_REQUEST" (solicitação do titular), "COMMERCIAL_DISAGREEMENT" (desacordo comercial), "CONFIRMED_FRAUD" (fraude confirmada) e "BEHAVIOR_RISK" (comportamento de risco).
account.specialAccountTypestringObsoleto. Considere o campo specialType.
account.specialTypestringIndica se a conta pertence a um parceiro (PARTNER_ACCOUNT) ou a um cliente parceiro (STANDARD_ACCOUNT). Observação: esse campo também pode retornar com o valor PAYMENT_ACCOUNT, em caso de encerramento de conta cuja criação tenha sido anterior a 15/02/2023.

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

AMOUNT_WAS_BLOCKED

Este evento sinaliza que o valor foi bloqueado.

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
judicialBlockIdstringIdentificador único do bloqueio judicial.
createdAtstringData em que ocorreu o bloqueio judicial, no formato ISO 8601 - UTC.
statusstringSituação do bloqueio judicial, que pode ser “FullyBlocked” (bloqueio completo) ou “PartiallyBlocked” (bloqueio parcial).
blockedValueobjectObjeto que contém informações sobre o valor bloqueado.
blockedAmount.valuenumberValor bloqueado.
blockedValue.currencystringCódigo da moeda com base na ISO - 4217.
detailsobjectObjeto que contém informações sobre a ordem judicial.
details.lawsuitNumberstringNúmero do processo judicial.
details.judicialOrderAmountobjectObjeto que contém informações sobre o valor a ser bloqueado de acordo com a ordem judicial.
details.judicialOrderAmount.valuenumberValor determinado para ser bloqueado.
details.judicialOrderAmount.currencystringCódigo da moeda com base na ISO - 4217.
holderobjectObjeto que contém informações sobre o titular da conta que foi bloqueada.
holder.documentobjectObjeto que contém informações sobre o documento do titular.
holder.document.valuestringNúmero do documento.
holder.document.typestringTipo do documento, que pode ser "CPF" ou "CNPJ".
holder.typestringTipo de titular, que pode ser "Customer" ou "Business".
holder.accountobjectObjeto que contém informações sobre a conta do titular.
holder.account.branchstringNúmero da agência.
holder.account.numberstringNúmero da conta.
holder.account.typestringTipo de conta, que pode ser "CHECKING" para conta-corrente, "SALARY" para conta-salário, "SAVINGS" para conta-poupança e "PAYMENT" para conta de pagamento.
holder.account.statusstringSituação da conta, que pode ser “Active” ou “Closed”.
holder.account.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.
holder.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
holder.account.bank.codestringCódigo do banco.
holder.account.bank.namestringNome do banco.
holder.balancesobjectObjeto que contém informações sobre o saldo disponível e bloqueado da conta.
holder.balances.availableobjectObjeto que contém informações sobre o saldo disponível na conta após o bloqueio.
holder.balances.valuenumberValor disponível na conta.
holder.balances.currencystringCódigo da moeda com base na ISO - 4217.
holder.balances.blockedobjectObjeto que contém informações sobre o saldo bloqueado.
holder.balances.blocked.valuenumberSaldo total bloqueado.
holder.balances.blocked.currencystringCódigo da moeda com base na ISO - 4217.

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

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
judicialBlockIdstringIdentificador único do bloqueio judicial.
createdAtstringData em que ocorreu o bloqueio judicial, no formato ISO 8601 - UTC.
statusstringSituação do desbloqueio judicial, que pode ser “FullyUnblocked” (desbloqueio completo) ou “PartiallyUnblocked” (desbloqueio parcial).
unblockedValueobjectObjeto que contém informações sobre o valor desbloqueado.
unblockedValue.valuenumberValor desbloqueado.
unblockedValue.currencystringCódigo da moeda com base na ISO - 4217.
detailsobjectObjeto que contém informações sobre a ordem judicial.
details.lawsuitNumberstringNúmero do processo judicial.
details.judicialOrderAmountobjectObjeto que contém informações sobre o valor a ser bloqueado de acordo com a ordem judicial.
details.judicialOrderAmount.valuenumberValor determinado para ser bloqueado.
details.judicialOrderAmount.currencystringCódigo da moeda com base na ISO - 4217.
holderobjectObjeto que contém informações sobre o titular da conta que foi bloqueada.
holder.documentobjectObjeto que contém informações sobre o documento do titular.
holder.document.valuestringNúmero do documento.
holder.document.typestringTipo do documento, que pode ser "CPF" ou "CNPJ".
holder.typestringTipo de titular, que pode ser "Customer" ou "Business".
holder.accountobjectObjeto que contém informações sobre a conta do titular.
holder.account.branchstringNúmero da agência.
holder.account.numberstringNúmero da conta.
holder.account.typestringTipo de conta, que pode ser "CHECKING" para conta corrente, "SALARY" para conta salário, "SAVINGS" para conta poupança e "PAYMENT" para conta de pagamento.
holder.account.statusstringSituação da conta, que pode ser “Active” ou “Closed”.
holder.account.bankobjectObjeto que contém informações sobre o banco ao qual a conta pertence.
holder.account.bank.ispbstringISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
holder.account.bank.codestringCódigo do banco.
holder.account.bank.namestringNome do banco.
holder.balancesobjectObjeto que contém informações sobre o saldo disponível e bloqueado da conta.
holder.balances.availableobjectObjeto que contém informações sobre o saldo disponível na conta após o bloqueio.
holder.balances.valuenumberValor disponível na conta.
holder.balances.currencystringCódigo da moeda com base na ISO - 4217.
holder.balances.blockedobjectObjeto que contém informações sobre o saldo bloqueado.
holder.balances.blocked.valuenumberSaldo total bloqueado.
holder.balances.blocked.currencystringCódigo da moeda com base na ISO - 4217.

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 3 months ago

Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados