Recurring Payments - Plan
-------------------------
https://apps.adelante.co.uk/recurring-payments/services/Http/Plan.ashx?Function=XXX&Format=...

FUNCTION: ADD
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference - Customer will be created if it doesn't exist
- CustomerName: Customer Name
- EmailAddress: Customer Email Address
- NoEmail: Y/N - Customer Email Opt-Out
- Address: Customer Address
- Telephone: Customer Telephone
- Owner: Optional User Email Address
- PlanReference: Unique Plan Reference
- FundCode: Plan Fund Code
- Type: AdHoc, AutoTopUp, Continuous, Repayment
- ScheduleFrequency: Daily, Weekly, Monthly, Quarterly, Yearly
- ScheduleInterval: Interval Between Payments - e.g. '2' for every 2 days
- ScheduleDay: Day of Month - for Monthly/ Quarterly
- FirstPaymentDate: Date For First Payment
- EndDate: Plan End Date
- FirstPaymentAmount: First Payment Amount - if different from Recurring Amount
- RecurringAmount: Recurring Payment Amount IN PENNIES
- OnPaymentDeclined: Continue, ContinueCatchUp, RetryContinue, RetrySuspend, Suspend
- Price: Fund Code of Price (Instead of First Payment Amount / Recurring Amount)
- PlanAmount: Total Amount for a Repayment Plan
- CardToken: Card Token, obtained from tokenisation service; or 'MP....' (e.g. 'MP1234') to derive from MPOSID; or '-' to remove
- CardNo: Obfuscated Card Number XX/XXXX - required if using Card Token
- CardExpiry: Card Expiry Date MM/YY - required if using Card Token
- Status: Active (Default), Suspended, Complete, Cancelled, Pending
- IgnoreDuplicate: Ignore Duplicate Plan (Returns 'OK' If Plan Exists)
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: CARD LINK
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference
- PlanReference: Unique Plan Reference
- Expiry: Optional Link Expiry Date (Default 20 Minutes)
- ReturnURL: Optional Return URL
- CancelURL: Optional Cancel URL
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: DD LINK
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference
- PlanReference: Unique Plan Reference
- Expiry: Optional Link Expiry Date (Default 20 Minutes)
- ReturnURL: Optional Return URL
- CancelURL: Optional Cancel URL
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: DELETE
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference
- PlanReference: Unique Plan Reference
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: EDIT
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference
- PlanReference: Unique Plan Reference
- Status: Empty (No Change) or Active, Suspended, Complete, Cancelled, Pending
- NextPaymentDate: Empty (No Change) or Next Payment Date
- ScheduleFrequency:  Empty or Daily, Weekly, Monthly, Quarterly, Yearly
- ScheduleInterval: Empty or Interval
- ScheduleDay: Empty or Day for Monthly/ Quarterly
- FirstPaymentAmount: Empty or First Scheduled Payment Amount IN PENNIES
- RecurringAmount: Empty or Scheduled Payments Amount IN PENNIES
- Price: Fund Code of Price
- Notes: Appends To Plan Notes
- PlanAmount: Empty or Total Amount IN PENNIES
- InterimPaymentDate: Empty or Date for Interim Payment or `-` to Cancel
- RetryPaymentDate: Empty or Date for Retry Payment or `-` to Cancel
- RestartDate: Restart Date or `-` to Cancel
- RestartBalance: Restart Balance or `-` to Cancel
- Holiday: Empty or Date for Holiday or `-` to Cancel
- NewReference: Empty or New Plan Reference
- OnPaymentDeclined: Continue, ContinueCatchUp, RetryContinue, RetrySuspend, Suspend
- CardToken: Empty or Card Token, obtained from tokenisation service; or 'MP....' (e.g. 'MP1234') to derive from MPOSID
- CardNo: Obfuscated Card Number XX/XXXX - required if using Card Token
- CardExpiry: Card Expiry Date MM/YY - required if using Card Token
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: GET
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference
- PlanReference: Unique Plan Reference
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: PAY
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference
- PlanReference: Unique Plan Reference
- Amount: Amount
- PaymentReference: Optional Payment Reference (Default Is Plan Reference)
- Parent: Optional Parent Payment ID
- Notes: Optional Notes
- Queue: N [Default] = Instant; Y = Queued - Please Use For Bulk Payments
- Source: C [Default] = Card; A = Adjustment (Just Updates Plan Balance)
- CardToken: Optional (Tokenised) Card (If Empty/ Not Set, Default Card Used)
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: PAYMENT LINK
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference
- PlanReference: Unique Plan Reference
- Amount: Amount IN PENNIES
- Expiry: Optional Link Expiry Date (Default 20 Minutes)
- Notes: Optional Notes
- PaymentReference: Optional Payment Reference (Default Is Plan Reference)
- Parent: Optional Parent Payment ID
- Send: Optional - 'EMAIL' or 'SMS' to Send Link
- To: Send EMAIL or SMS To Number/ Email Address
- ReturnURL: Optional Return URL - Payment ID will be appended as ?PaymentID=XXXX
- CancelURL: Optional Cancel URL
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: PAYMENT LINK RESULT
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- Key: Payment Link Key
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: PAYMENTS
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference
- PlanReference: Unique Plan Reference
RETURNS
- Result: 'OK' or 'Error Message'

FUNCTION: REFUND
- Format: JSON, XML, QueryString
- User: Recurring Payments Service User Email Address
- Password: Recurring Payments Service User Password
- Account: Recurring Payments Account ID
- CustomerReference: Unique Customer Reference
- PlanReference: Unique Plan Reference
RETURNS
- Result: 'OK' or 'Error Message'
- Refunded: Total Refunded IN PENNIES
- Errors: Error Count