Conta Escrow Criada

Webhook disparado quando uma conta escrow é aberta com sucesso no sistema bancário.

Categoria: Conta Escrow
Evento: Conta Escrow Criada

Nome do Evento

ESCROW_ACCOUNT_CREATED

Disparado quando POST /escrow-accounts conclui a abertura da conta no sistema bancário. O data tem o formato de EscrowAccount — veja Conta Escrow para o detalhe completo dos campos de entrada.

Estrutura do Payload

{
  "eventType": "string",
  "entityId": "uuid",
  "occurredAt": "date-time",
  "data": {
    "id": "uuid",
    "partnerId": "uuid",
    "externalId": "uuid",
    "companyDocument": "string",
    "status": "string",
    "branch": "string",
    "branchDigit": "string",
    "account": "string",
    "accountDigit": "string",
    "bank": {
      "bankId": "uuid",
      "code": "string",
      "brazilianPaymentSystemId": "string"
    },
    "createdAt": "date-time",
    "updatedAt": "date-time"
  }
}

Tabela de Descrição dos Campos

CampoTipoDescrição
eventTypestringSempre "ESCROW_ACCOUNT_CREATED".
entityIduuidID interno (id) da conta escrow.
occurredAtdatetimeMomento em que a conta foi criada (UTC).
data.externalIduuidUUID externo da conta no sistema bancário (BizOs Account Services).
data.companyDocumentstringCNPJ da empresa titular.
data.statusstringStatus da conta no sistema bancário.
data.branch / data.branchDigitstringAgência e dígito verificador.
data.account / data.accountDigitstringConta e dígito verificador.
data.bankobjectDados do banco custodiante (bankId, code, brazilianPaymentSystemId).

Exemplo de Payload

Exemplo ilustrativo — construído a partir do schema EscrowAccount, não extraído literalmente do OpenAPI. Validar com o time antes de publicar.

{
  "eventType": "ESCROW_ACCOUNT_CREATED",
  "entityId": "2b6f9a1c-4d3e-4f5a-8b7c-9d0e1f2a3b4c",
  "occurredAt": "2026-08-06T16:00:00Z",
  "data": {
    "id": "2b6f9a1c-4d3e-4f5a-8b7c-9d0e1f2a3b4c",
    "partnerId": "a1b2c3d4-e5f6-47a8-89ab-0123456789ab",
    "externalId": "7d6c5b4a-3e2f-410a-9b8c-1d2e3f4a5b6c",
    "companyDocument": "12345678000199",
    "status": "ACTIVE",
    "branch": "0001",
    "branchDigit": "0",
    "account": "987654",
    "accountDigit": "3",
    "bank": {
      "bankId": "6a5b4c3d-2e1f-4a0b-9c8d-7e6f5a4b3c2d",
      "code": "341",
      "brazilianPaymentSystemId": "60701190"
    },
    "createdAt": "2026-08-06T16:00:00Z",
    "updatedAt": "2026-08-06T16:00:00Z"
  }
}

Did this page help you?