Contas

stable

Neste contexto, os eventos se referem ao bloqueio total ou parcial de valores de uma conta, por ordem judicial.

Dados do evento

AMOUNT_WAS_BLOCKED

Este evento sinaliza que um valor foi bloqueado por ordem judicial.

Campos retornados

Nome	Tipo	Descrição
aggregateId	string	Valor correspondente ao authenticationCode que, neste caso, é o código de autenticação da operação de bloqueio.
type	string	Tipo de evento, que pode ser INFO, TRANSACTION, ACTION OU BACKOFFICE.
category	string	Neste contexto, esse campo informará o valor “AccountEvents”.
documentNumber	string	Número do documento do titular da conta na qual o valor foi bloqueado.
bankBranch	string	Número da agência bancária.
bankAccount	string	Número da conta.
amount	number	Valor bloqueado.
name	string	Nome do evento.
timestamp	string	Data e a hora em que o evento ocorreu.
status	string	Indica o status do evento. Neste evento, será sempre ACTIVE.
index	string	Índice do evento pra facilitar uma busca por um grupo de eventos. Exemplo: feed-2023-8, feed-2023-7.
data	object	Objeto que contém os dados referentes ao bloqueio.
data.BlockedValue	object	Objeto que contém os dados referentes ao valor bloqueado.
data.BlockedValue.Currency	string	Moeda do valor bloqueado.
data.BlockedValue.Value	number	Valor bloqueado.
data.CreatedAt	string	Data e a hora em que o evento ocorreu.
data.Details	object	Objeto que contém detalhes referentes ao bloqueio judicial.
data.Details.JudicialOrderAmount	object	Objeto que contém os dados referentes ao valor determinado a ser bloqueado por ordem judicial.
data.Details.JudicialOrderAmount.Currency	string	Moeda do valor bloqueado.
data.Details.JudicialOrderAmount.Value	number	Valor bloqueado por ordem judicial.
data.Details.LawsuitNumber	string	Número que identifica a ordem judicial.
data.Holder	object	Objeto que contém os dados do titular da conta.
data.Holder.Account	object	Objeto que contém os dados da conta na qual o valor foi bloqueado.
data.Holder.Account.Balances	object	Objeto que contém os dados do saldo da conta.
data.Holder.Account.Balances.Available	object	Objeto que contém os dados do saldo disponível da conta.
data.Holder.Account.Balances.Available.Currency	string	Moeda do saldo disponível.
data.Holder.Account.Balances.Available.Value	number	Valor do saldo disponível.
data.Holder.Account.Balances.Blocked	object	Objeto que contém os dados do saldo bloqueado da conta.
data.Holder.Account.Balances.Blocked.Currency	string	Moeda do saldo bloqueado.
data.Holder.Account.Balances.Blocked.Value	number	Valor do saldo bloqueado.
data.Holder.Account.Balances.Hold	object	Valor em processamento. Esse campo sempre retornará nulo.
data.Holder.Account.Balances.Total	object	Valor total do saldo. Esse campo sempre retornará nulo.
data.Holder.Account.Bank	object	Objeto que contém os dados bancários da conta na qual o valor foi bloqueado.
data.Holder.Account.Bank.Code	string	Código do banco.
data.Holder.Account.Bank.Ispb	string	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
data.Holder.Account.Bank.Name	string	Nome do banco.
data.Holder.Account.Branch	string	Número da agência bancária.
data.Holder.Account.Number	string	Número da conta.
data.Holder.Account.Pockets	string	Número da conta pocket. Esse campo sempre retornará nulo.
data.Holder.Account.Status	string	Situação da conta, a qual pode ser ACTIVE ou CLOSED.
data.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.
data.Holder.Document	object	Objeto que contém os dados do documento do titular da conta na qual o valor foi bloqueado.
data.Holder.Document.Type	string	Tipo de documento, que pode ser CPF ou CNPJ.
data.Holder.Document.Value	string	Número do documento.
data.Holder.Name	string	Nome do titular da conta. Esse campo sempre retornará nulo.
data.Holder.Status	string	Situação do titular da conta. Esse campo sempre retornará nulo.
data.Holder.Type	string	Tipo de titular, o qual pode ser “Customer” ou “Business”.
data.JudicialBlockId	string	Código de autenticação da operação de bloqueio.
data.Status	string	Indica se o bloqueio é total (FullyBlocked) ou parcial (PartiallyBlocked).

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

JSON

{
    "aggregateId": "AMOUNT_WAS_BLOCKED_4f29a5b2-ae04-418f-b716-6dccfdd6139d_638242294710437653",
    "type": "TRANSACTION",
    "category": "AccountEvents",
    "documentNumber": "47742663023",
    "bankBranch": "0001",
    "bankAccount": "15164",
    "amount": -1819.09,
    "name": "AMOUNT_WAS_BLOCKED",
    "timestamp": "2023-07-06T08:37:51.0437653Z",
    "status": "ACTIVE",
    "index": "feed-amount-was-blocked-2023-7",
    "data": {
        "BlockedValue": {
            "Currency": "BRL",
            "Value": 1819.09
        },
        "CreatedAt": "2023-07-06T08:37:50.5994105Z",
        "Details": {
            "JudicialOrderAmount": {
                "Currency": "BRL",
                "Value": 2170
            },
            "LawsuitNumber": "70055887920218220021"
        },
        "Holder": {
            "Account": {
                "Balances": {
                    "Available": {
                        "Currency": "BRL",
                        "Value": 0
                    },
                    "Blocked": {
                        "Currency": "BRL",
                        "Value": 1819.09
                    },
                    "Hold": null,
                    "Total": null
                },
                "Bank": {
                    "Code": "332",
                    "Ispb": "13140088",
                    "Name": "Acesso Soluções De Pagamento S.A."
                },
                "Branch": "0001",
                "Number": "15164",
                "Pockets": null,
                "Status": "Active",
                "Type": "Payment"
            },
            "Document": {
                "Type": "CPF",
                "Value": "47742663023"
            },
            "Name": null,
            "Status": null,
            "Type": "Customer"
        },
        "JudicialBlockId": "4f29a5b2-ae04-418f-b716-6dccfdd6139d",
        "Status": "PartiallyBlocked"
    }
}

AMOUNT_WAS_UNBLOCKED

Este evento sinaliza que um valor foi desbloqueado por ordem judicial.

Campos retornados

Nome	Tipo	Descrição
aggregateId	string	Valor correspondente ao authenticationCode que, neste caso, é o código de autenticação da operação de bloqueio.
type	string	Tipo de evento, que pode ser INFO, TRANSACTION, ACTION OU BACKOFFICE.
category	string	Neste contexto, esse campo informará o valor “AccountEvents”.
documentNumber	string	Número do documento do titular da conta na qual o valor foi bloqueado.
bankBranch	string	Número da agência bancária.
bankAccount	string	Número da conta.
amount	number	Valor desbloqueado.
index	string	Índice do evento pra facilitar uma busca por um grupo de eventos. Exemplo: feed-2023-8, feed-2023-7.
name	string	Nome do evento.
timestamp	string	Data e a hora em que o evento ocorreu.
data	object	Objeto que contém os dados referentes ao bloqueio.
data.UnblockedValue	object	Objeto que contém os dados referentes ao valor desbloqueado.
data.UnblockedValue.Value	string	Moeda do valor desbloqueado.
data.UnblockedValue.Currency	number	Valor desbloqueado.
data.JudicialBlockId	string	Código de autenticação da operação de bloqueio.
data.CreatedAt	string	Data e a hora em que o evento ocorreu.
data.Details	object	Objeto que contém detalhes referentes ao desbloqueio judicial.
data.Details.LawsuitNumber	string	Número que identifica a ordem judicial.
data.Details.JudicialOrderAmount	object	Objeto que contém os dados referentes ao valor desbloqueado por ordem judicial.
data.Details.JudicialOrderAmount.Currency	string	Moeda do valor bloqueado.
data.Details.JudicialOrderAmount.Value	number	Valor do saldo bloqueado.
data.Holder	object	Objeto que contém os dados do titular da conta.
data.Holder.Document	object	Objeto que contém os dados do documento do titular da conta na qual o valor foi bloqueado.
data.Holder.Document.Value	string	Número do documento.
data.Holder.Document.Type	string	Tipo de documento, que pode ser CPF ou CNPJ.
data.Holder.Type	string	Tipo de documento, que pode ser CPF ou CNPJ.
data.Holder.Name	string	Nome do titular da conta.
data.Holder.Status	string	Situação do titular da conta. Esse campo sempre retornará nulo.
data.Holder.Account	object	Objeto que contém os dados da conta na qual o valor foi desbloqueado.
data.Holder.Account.Branch	string	Número da agência bancária.
data.Holder.Account.Number	string	Número da conta.
data.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.
data.Holder.Account.Status	string	Situação da conta, a qual pode ser ACTIVE ou CLOSED.
data.Holder.Account.Bank	object	Objeto que contém os dados bancários da conta na qual o valor foi bloqueado.
data.Holder.Account.Bank.Ispb	string	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
data.Holder.Account.Bank.Code	string	Código do banco.
data.Holder.Account.Bank.Name	string	Nome do banco.
data.Holder.Account.Balances	object	Objeto que contém os dados do saldo da conta.
data.Holder.Account.Balances.Total	object	Valor total do saldo. Esse campo sempre retornará nulo.
data.Holder.Account.Balances.Available	object	Objeto que contém os dados do saldo disponível da conta.
data.Holder.Account.Balances.Available.Value	number	Valor do saldo disponível.
data.Holder.Account.Balances.Available.Currency	string	Moeda do saldo disponível.
data.Holder.Account.Balances.Hold	object	Valor em processamento. Esse campo sempre retornará nulo.
data.Holder.Account.Balances.Blocked	object	Objeto que contém os dados do saldo bloqueado da conta.
data.Holder.Account.Balances.Blocked.Value	number	Valor do saldo bloqueado.
data.Holder.Account.Balances.Blocked.Currency	string	Moeda do saldo bloqueado.
data.Holder.Account.Pockets	string	Número da conta pocket. Esse campo sempre retornará nulo.
status	string	Indica se o bloqueio é total (FullyBlocked) ou parcial (PartiallyBlocked).

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

JSON

{
        "aggregateId": "AMOUNT_WAS_UNBLOCKED_d0f5bf0c-d201-4d66-9409-1c83a9b1ed21_638237027635394433",
        "type": "TRANSACTION",
        "category": "AccountEvents",
        "documentNumber": "47742663023",
        "bankBranch": "0001",
        "bankAccount": "15164",
        "amount": 9686.0,
        "index": "feed-amount-was-unblocked-2023-6",
        "name": "AMOUNT_WAS_UNBLOCKED",
        "timestamp": "2023-06-30T06:19:23.5394431Z",
        "data": {
            "UnblockedValue": {
                "Value": 9686.0,
                "Currency": "BRL"
            },
            "JudicialBlockId": "d0f5bf0c-d201-4d66-9409-1c83a9b1ed21",
            "CreatedAt": "2023-06-23T07:11:52.41+00:00",
            "Status": "FullyUnblocked",
            "Details": {
                "LawsuitNumber": "70185725520218220002",
                "JudicialOrderAmount": {
                    "Value": 9686.0,
                    "Currency": "BRL"
                }
            },
            "Holder": {
                "Document": {
                    "Value": "47742663023",
                    "Type": "CPF"
                },
                "Type": "Customer",
                "Name": null,
                "Status": null,
                "Account": {
                    "Branch": "0001",
                    "Number": "15164",
                    "Type": "Payment",
                    "Status": "Active",
                    "Bank": {
                        "Ispb": "13140088",
                        "Code": "332",
                        "Name": "Acesso Soluções De Pagamento S.A."
                    },
                    "Balances": {
                        "Total": null,
                        "Available": {
                            "Value": 288019.41,
                            "Currency": "BRL"
                        },
                        "Hold": null,
                        "Blocked": {
                            "Value": 593675.05,
                            "Currency": "BRL"
                        }
                    },
                    "Pockets": null
                }
            }
        },
        "status": "ACTIVE"
    },