Skip to main content

Evento organization.review.submitted

Disparado quando a organização conectada envia o formulário hospedado de atualização cadastral. Este evento confirma que os dados foram recebidos para análise. Ele não indica aprovação final nem mudança imediata no status financeiro da organização. Se a atualização também alterar dados públicos da organização, como o nome, a Chargefy envia organization.updated com previous_attributes.

Exemplo de payload

{
  "id": "evt_123",
  "object": "event",
  "created_at": "2026-06-24T12:08:00.000Z",
  "data": {
    "object": {
      "id": "sr_123",
      "object": "organization_review",
      "created_at": "2026-06-24T12:00:00.000Z",
      "deadline_at": "2026-07-24T12:00:00.000Z",
      "livemode": true,
      "metadata": {},
      "organization": "org_456",
      "requested_fields": ["revenue", "address"],
      "review_type": "periodic",
      "status": "submitted",
      "submission_mode": "full",
      "submitted_at": "2026-06-24T12:08:00.000Z",
      "updated_at": "2026-06-24T12:08:00.000Z",
      "url": null
    }
  },
  "livemode": true,
  "organization": "org_456",
  "request": {
    "id": null
  },
  "type": "organization.review.submitted"
}

Campos do payload

Payload

CampoTipoDescrição
idstringID único do evento (evt_*).
objectstringSempre "event".
created_atstringData/hora ISO 8601 da geração do evento.
livemodebooleanMesmo valor de data.object.livemode.
organizationstringID da organização conectada que enviou a atualização cadastral.
typestring"organization.review.submitted"

data.object

CampoTipoDescrição
idstringID da atualização cadastral.
objectstringSempre "organization_review".
created_atstringQuando a atualização cadastral foi criada.
deadline_atstring | nullPrazo recomendado para envio.
livemodebooleantrue em produção; false em ambiente de teste.
metadataobjectReservado para compatibilidade; hoje retorna {}.
organizationstringID da organização conectada vinculada à atualização.
requested_fieldsarrayCampos solicitados no processo. Interprete junto com submission_mode: em full, todos os campos exigidos pelo fluxo foram enviados; em partial, somente os campos listados foram enviados.
review_typestringTipo normalizado pela Chargefy: periodic, inconsistent ou unknown.
statusstring"submitted" neste evento.
submission_modestringModo de envio normalizado pela Chargefy: full, partial ou unknown.
submitted_atstring | nullQuando a organização enviou os dados.
updated_atstringÚltima modificação da atualização cadastral.
urlstring | nullSempre null neste evento. Se precisar de novo preenchimento depois de expirar, aguarde um novo link.
Depois de organization.review.submitted, continue acompanhando organization.updated para mudanças em dados públicos ou status financeiro da organização.

Uso típico

switch (event.type) {
  case "organization.review.submitted": {
    const review = event.data.object;
    await db.organizationReviews.update({
      id: review.id,
      organization: review.organization,
      status: review.status,
      submitted_at: review.submitted_at,
    });
    break;
  }
}