Pay Advantage 12.1.0

Payment Request API – DateExpired Removal

Overview

The DateExpired field has been removed from Payment Request responses and webhook payloads.

This field duplicated DateExpires: it contained the same value once a Payment Request had expired and was null otherwise, so it provided no additional information.

API Changes

DateExpired has been removed from:

• POST /v3/payment_requests
• GET /v3/payment_requests
• GET /v3/payment_requests/{code}
• payment_request webhook payloads

What to Use Instead

• Use DateExpires to determine the Payment Request expiry date.
• Use Status == "expired" to determine whether a Payment Request has expired.
• For webhook integrations, use the payment_request.expired event to detect expiry.

Backward Compatibility

DateExpired was deprecated and removed from the published OpenAPI specification in v11.10.

Clients generated from the OpenAPI specification since v11.10 are therefore unaffected.

This change only impacts:

• Hand-written clients that read DateExpired from the raw JSON.
• Older generated clients that still include the field in their schema.

Of these, only clients that enforce the response schema strictly need to be updated before upgrading.

Direct Debit Instalment Webhook Documentation

Overview

The Webhook Events documentation has been updated to provide a dedicated category for Direct Debit Instalment webhook events.

There are no changes to webhook behaviour, payloads or endpoints. The events already fire as described below.

Documentation Changes

The Webhook Events reference now includes a Direct Debit Instalments category containing the following events:

Each event returns a Direct Debit Instalment in the Data attribute, with the resource URL:

direct_debit_instalments/{code}

These events were previously documented under the Direct Debits category. They have been moved because the Direct Debits category states that its events return a Direct Debit, which does not apply to Direct Debit Instalment events.