AfP Payment Notice Cancelled

Event Type

afp_payment_notice_cancelled

Summary

Sent after a pending payment notice or pay-less notice is cancelled successfully. The cancelled notice remains available through its detail endpoint. Rejected or repeated state transitions do not send this event.

Access

Company and agency webhooks are supported. Agency delivery is limited to the associated agency and excludes MSP-to-client or receivable billing records. Draft AfPs do not send events. A follow-up read requires read:invoices and access to the record.

Delivery

Requidex sends a signed POST request with Content-Type: application/json to the configured webhook URL. Return a 2xx response after accepting the event for processing. Duplicate or out-of-order deliveries are possible; deduplicate by event ID.

See delivery headers, signature verification and retry handling for the shared contract. The webhook signing secret is separate from an API key used to fetch the record.

Payload Fields

Field	Type	Required	Description
id	string	Yes	Stable event ID, reused for delivery retries
type	string	Yes	afp_payment_notice_cancelled
createdAt	string	Yes	Event creation time in ISO 8601 UTC format
data	object	Yes	Resource reference; not a snapshot Show child attributes paymentNotice object — affected record Show child attributes id string — record ID for the detail endpoint
test	boolean	No	Present and true for test deliveries; the resource ID is test

Payload Example

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "afp_payment_notice_cancelled",
  "createdAt": "2026-10-30T12:00:00.000Z",
  "data": {
    "paymentNotice": {
      "id": "507f1f77bcf86cd799439011"
    }
  }
}

Read the Affected Record

Use data.paymentNotice.id with GET /afps/payment-notices/{id} to read the current record. The notice events contain the payment notice ID, not the parent AfP ID; the notice response includes its parent AfP reference and notice type.

The follow-up API request uses your API key and the endpoint’s scope and access rules. A webhook subscription does not grant additional API access. Test deliveries include test: true and use the resource ID test; do not fetch a business record for those deliveries.