Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Evento hosted_flow.completed

Disparado para a organização da plataforma quando o seller termina de preencher o hosted flow e clica em concluir. Indica que o cadastro foi recebido — a aprovação financeira (sair de pending para active) chega depois via suborganization.updated. O payload carrega o hint da conta bancária cadastrada (banco, agência, últimos 4 dígitos do número) — ideal pra mostrar pro seller no admin da plataforma “sua conta termina em ****1234”.

​
Payload de Exemplo

{
  "type": "hosted_flow.completed",
  "id": "evt_3KLm9XPq",
  "timestamp": "2026-04-30T18:31:20.000Z",
  "data": {
    "hosted_flow_id": "hf_abc123",
    "platform_id": "plat_abc",
    "organization_id": "org_seller_new",
    "bank_account": {
      "holder_name": "Acme Importadora LTDA",
      "bank_code": "260",
      "bank_name": "Nu Pagamentos S.A.",
      "routing_number": "0001",
      "account_number_last4": "5678",
      "type": "checking"
    },
    "platform_reference": {
      "external_reference": "airbee_seller_456",
      "metadata": {
        "airbee_workspace_id": "ws_789"
      }
    }
  }
}

​
Campos do Payload

CampoTipoDescrição
typestring"hosted_flow.completed"
idstringID único do evento (evt_*).
timestampstringData/hora ISO 8601.
data.hosted_flow_idstringID do hosted flow concluído (hf_*).
data.platform_idstringID da plataforma.
data.organization_idstringID da sub-organização (org_*) — use isso pra correlacionar.
data.bank_accountobject | absentHint da conta bancária cadastrada. Presente quando o seller cadastrou conta no wizard.
data.bank_account.holder_namestringNome do titular cadastrado.
data.bank_account.bank_codestringCódigo FEBRABAN do banco (ex: "260").
data.bank_account.bank_namestring | nullNome do banco resolvido (quando disponível).
data.bank_account.routing_numberstringAgência.
data.bank_account.account_number_last4stringÚltimos 4 dígitos do número da conta.
data.bank_account.typestring"checking" (corrente) ou "savings" (poupança).
data.platform_referenceobjectEcho do external_reference + metadata que você passou na criação do flow. Presente apenas se você forneceu.
Importante: hosted_flow.completed significa “cadastro recebido”, não “aprovado”. Não libere recebimentos com base nele isoladamente — aguarde suborganization.updated com seller_activation_status: "active".

​
Uso Típico

switch (event.type) {
  case 'hosted_flow.completed': {
    const { hosted_flow_id, organization_id, bank_account } = event.data
    await db.subOrgs.upsert({
      id: organization_id,
      hosted_flow_id,
      bank_account_hint: bank_account, // mostrar no admin: "conta ****5678"
      activation_status: 'pending',
    })
    break
  }
}