PT EN

Payments

Eventos de Payments: 7 no total. Ver o envelope comum.

bank_statement.imported

A bank statement was imported and matched against payments.

Recurso: bank_statement

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_hHiNHKZbfA7CmSY4hUKtuitWwYK",
  "type": "bank_statement.imported",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "bank_statement",
    "resource": {
      "type": "bank_statement",
      "sequence": 1
    }
  }
}

cashier.shift_closed

A cashier shift was closed and counted.

Recurso: cashier

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_Wgonx2PfPTp2Qq8gNrSQXMprQGx",
  "type": "cashier.shift_closed",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "cashier",
    "resource": {
      "type": "cashier",
      "sequence": 1
    }
  }
}

cashier.shift_opened

A cashier shift was opened.

Recurso: cashier

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_Wgonx2PfPTp2QqoAhBhc4g9oLEp",
  "type": "cashier.shift_opened",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "cashier",
    "resource": {
      "type": "cashier",
      "sequence": 1
    }
  }
}

payment.allocated

A payment was allocated to invoices.

Recurso: payment

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_QfhRhS7F6PdiLRRUTDpuxnJ2hHU",
  "type": "payment.allocated",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "payment",
    "resource_id": "pay_QfhRhS7jyh3N7wnBQwVRzv8WmoQ",
    "resource": {
      "type": "payment",
      "id": "pay_QfhRhS7jyh3N7wnBQwVRzv8WmoQ",
      "sequence": 1
    }
  }
}

payment.received

A payment was posted.

Recurso: payment

Disparar na CLI: gotactl events trigger payment.received

Exemplo de payload
{
  "id": "wev_QfhRhS7FkgowVaXpkxA27stNKYk",
  "type": "payment.received",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "payment",
    "resource_id": "pay_QfhRhS7jyh3N7wnfEocoCrbPfrh",
    "resource": {
      "type": "payment",
      "id": "pay_QfhRhS7jyh3N7wnfEocoCrbPfrh",
      "sequence": 1
    }
  }
}

payment.reversed

A payment was reversed and its allocations undone.

Recurso: payment

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_QfhRhS7Fkg9w7amSDDrthC9iYXX",
  "type": "payment.reversed",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "payment",
    "resource_id": "pay_QfhRhS7jyh3N7wnfE99NbmALiHT",
    "resource": {
      "type": "payment",
      "id": "pay_QfhRhS7jyh3N7wnfE99NbmALiHT",
      "sequence": 1
    }
  }
}

payment.status_changed

A payment changed status (posted, reconciled, reversed).

Recurso: payment

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_QfhRhS7FZjMQ4bDwzcqiusvnvXd",
  "type": "payment.status_changed",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "payment",
    "resource_id": "pay_QfhRhS7jyh3N7wnU2qHYEmGcget",
    "resource": {
      "type": "payment",
      "id": "pay_QfhRhS7jyh3N7wnU2qHYEmGcget",
      "sequence": 1
    }
  }
}

Receber estes eventos

O seu endpoint de webhook recebe cada um destes eventos num POST com o envelope comum, descrito na tabela abaixo. Verifique a assinatura antes de agir, responda depressa com um código 2xx e faça o trabalho depois: uma resposta lenta ou falhada é enviada outra vez. O mesmo evento pode chegar mais de uma vez, por isso use o seu id para ignorar repetições.

CampoTipoSignificado
idstringIdentificador do evento; o mesmo em todas as tentativas de entrega.
typestringO nome do evento, por exemplo invoice.issued.
api_versionstringA versão da API em que o corpo é escrito.
tenant_idstringA empresa (espaço de trabalho) onde o evento aconteceu.
created_atstring (RFC 3339)Quando o evento foi registado.
request_idstringO pedido à API que causou a mudança, quando houve um; liga ao registo de pedidos.
data.resource_typestringO tipo do recurso que mudou.
data.resource_idstringO identificador desse recurso, para o ler na API.
data.attributesobjectCampos próprios de cada evento; podem não existir. Leia o recurso na API para o estado completo.
data.resource.sequenceintegerConta os eventos do mesmo recurso; ignore um evento que não seja mais recente do que o último que aplicou.

Outras categorias de eventos