Arrangement files

Notification of arrangements set up direct with the client.

❗️

Please name your file as: YYYYMMDD-arrangement.csv e.g. 20210811-arrangement.csv

  • Arrangements set up direct with the client should be reported to Ophelos to remove the customer from receiving communications.
  • Failed or cancelled arrangements should be reported to Ophelos to add the customer back into receiving communications. To report a failed or cancelled arrangement then the row should contain account_number with is_cancelled = True

📘

Download the template here ↓

YYYYMMDD-arrangement.csv

Data format

HeaderRequiredData TypeFormat/ExampleDescription (if required)
account_numberYesstringabc12345client account reference number
amountYesdecimal40.12value of each payment instalment
frequencyYesstringMonthlyFrequency of payments. One of: Weekly, Biweekly, Monthly
first_payment_dateYesdateYYYY-MM-DD
e.g. 2021-12-31Date the first payment is due
payment_methodNostringCardPayment method used. One of: Card, Direct Debit,
is_cancelledNoboolTrueUsed only when reporting a failed or cancelled arrangement.