Payments

Payments events: 7 in all. See the shared envelope.

bank_statement.imported

A bank statement was imported and matched against payments.

Resource: bank_statement

Not supported by `events trigger` (use the normal API flow).

Example 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.

Resource: cashier

Not supported by `events trigger` (use the normal API flow).

Example 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.

Resource: cashier

Not supported by `events trigger` (use the normal API flow).

Example 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.

Resource: payment

Not supported by `events trigger` (use the normal API flow).

Example 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.

Resource: payment

Trigger via CLI: gotactl events trigger payment.received

Example 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.

Resource: payment

Not supported by `events trigger` (use the normal API flow).

Example 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).

Resource: payment

Not supported by `events trigger` (use the normal API flow).

Example 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
    }
  }
}

Receiving these events

Your webhook endpoint receives each of these events as a POST with the shared envelope described in the table below. Check the signature before acting on it, answer quickly with a 2xx code and do the work afterwards: a slow or failed answer is sent again. The same event can arrive more than once, so use its id to ignore repeats.

FieldTypeMeaning
idstringThe event identifier; the same on every delivery attempt.
typestringThe event name, for example invoice.issued.
api_versionstringThe API version the body is written in.
tenant_idstringThe utility (workspace) where the event happened.
created_atstring (RFC 3339)When the event was recorded.
request_idstringThe API request that caused the change, when there was one; links to the request log.
data.resource_typestringThe type of the resource that changed.
data.resource_idstringThat resource's identifier, to read it from the API.
data.attributesobjectFields specific to each event; may be absent. Read the resource from the API for its full state.
data.resource.sequenceintegerCounts the events about the same resource; ignore an event that is not newer than the last one you applied.

Other event categories