Estrutura

Cada evento possui a seguinte estrutura:

Nome	Tipo	Descrição
context	string	Contexto em que o evento foi criado. Os possíveis contextos estão listados abaixo.
event	string	Nome que identifica a operação realizada. Os possíveis evetnso estão listados abaixo.
establishment	string	Identificador único do estabelecimento na Parcelamos Tudo.
timestamp	string	Data e a hora em que o evento ocorreu, no formato ISO 8601.
version	string	Versão do evento.
data	object	Entidade relacionada ao evento informado.

🚧
Importante
Recomendamos que os parceiros observem a versão do evento a ser utilizado.

{
  "context": "payment-link",
  "event": "payment-link.created",
  "establishment": "b9f6aaeb-f233-4a45-8ccc-b63e5b64ec01",
  "timestamp": "2024-05-13T12:00:53.394Z",
  "version": "1",
  "data": {
    "property": "a"
  }
}

Contextos

Nome	Descrição
checkout	Agrupa todos os eventos relacionados a pedidos de checkout.
payment-link	Agrupa todos os eventos relacionados a links de pagamento.
order	Agrupa todos os eventos relacionados a pedidos de gateway de pagamento.
transaction	Agrupa todos os eventos relacionados a parcelas de pagamento.
plan	Agrupa todos os eventos relacionados a planos de recorrência.
subscription	Agrupa todos os eventos relacionados a assinaturas de recorrência.
invoice	Agrupa todos os eventos relacionados a faturas de recorrência.