Home

Customer Payment Plan Self Service

Customer payment plan self service return file

The return file contains updates made by customers to their payment plans through the self-service option in the customer portal. A record will be included in the report if the customer's updates trigger changes to any of the following fields:

  • Recurring Amount
  • Due Date (Next Instalment Date)
  • Frequency
  • Fees (when surcharge is enabled)

Column Name

Example/ Accepted Value

integration_link_id

A1234567_987654321

invoice_number

IN12345

correlation_id

8b7ad8ef-e3f6-4ee1-9f46-b850f6794862

reason

Reason for the changes to payment plan
NextInstalmentSkipped,
RecurringAmountOrFrequencyChanged
PaymentInstrumentChanged

previous_active_instalment_id

c4ff9f6f-c5a4-443b-a86b-21c7738f19c9

new_active_instalment_id

c4ff9f6f-c5a4-443b-a86b-21c7738f19c9

previous_due_date

2023-09-04T20:43:31.772+10

new_due_date

2023-09-28T20:43:31.772+10

previous_recurring_amount

150

new_recurring_amount

120

previous_frequency

Fortnightly,
Monthly,
Weekly

new_frequency

Fortnightly,
Monthly,
Weekly

previous_fee_amount

15

new_fee_amount

12

updated_on

2023-09-04T20:43:31.772+10