Payment Reminders Enhancement

Overview

Payment Requests now support an optional reminder fee.

If you have a Payment Request reminder fee configured on your rate plan and reminders are enabled, Pay Advantage will automatically send email and/or SMS reminders to your customers whose payment request remains unpaid and unexpired. Reminders are typically sent around days 3, 7, 14 and 28.

A reminder fee is charged only for reminders that are actually sent. If you have fee on-charging enabled, the reminder fee (inclusive of GST) is added to your customer's payment when they complete the payment.

API Changes

Two new fields added to existing public Payment Request endpoints (additive - nothing removed or renamed):

• SendPaymentRequestRequest.SendReminders (bool, optional) - enable/disable reminders; can only be disabled before day 3.
• PaymentRequestResponse.ReminderFee (decimal) - reminder fee on-charged at payment time (perReminderFee × reminders sent, inc GST); 0 when none sent.

For more details, see this article

DDR Instalment API & Webhook Enhancements

Overview

This release introduces a dedicated API resource for Direct Debit Request (DDR) instalments, providing stable identifiers, retrieval and update endpoints, and webhook events to support integration with individual instalments.

API Changes

New Direct Debit Instalment Endpoints

The following endpoints have been added:

• GET /direct_debit_instalments/{code} – Retrieve a single DDR instalment, including its linked payment, edit permissions and scheduling constraints.
• PATCH /direct_debit_instalments/{code} – Update the scheduled date and/or amount for a pending instalment. Setting the amount to 0 skips the instalment.
• GET /direct_debit_instalments/{code}/next – Retrieve subsequent instalments for the same Direct Debit Request.
• GET /direct_debit_instalments/{code}/previous – Retrieve previous instalments for the same Direct Debit Request.

Each instalment now exposes a stable GUID Code that can be used across the API and webhook events.

Response Enhancements

DDR instalment responses now include additional scheduling and editing information, including:

• OriginalAmount

• HasAmountChanged

• HasDateChanged

• CanEdit

• IsMissed

• IsUpfront

• EditRules

  • MinDate
  • MaxDate
  • MinAmount
  • MaxAmount

Webhook Events

The following webhook events are now available for DDR instalments:

• ddr.installment.created
• ddr.installment.updated
• ddr.installment.processed
• ddr.installment.skipped

Each webhook uses the instalment's GUID Code as its resource identifier.

Webhook Resource ID

Webhook ResourceID values now support 36-character GUIDs, allowing instalment identifiers to be included without truncation.

Backward Compatibility

These changes are additive and do not affect existing Direct Debit APIs or webhook subscriptions. Existing integrations continue to function without modification.