paymentplan
Description
Paymentplan allows paying for an E-Commerce sale using a Payment Plan. To accommodate this new functionality the ProcessSale and VerifySale functions have been updated. Both functions now accept a <PaymentPlan> tag inside the <settlement> tag. If the <PaymentPlan> tag is present, the sale will be handled and paid for using a payment plan. In addition a new function has been added called GetPaymentPlan which is used to get the Payment Plan schedule for the sale. It takes the same parameters as VerifySale and ProcessSale, but GetPaymentPlan does not do any validation on the items in the sale.
Input fields
XML tag | Description |
<amount> | The amount is the total for the whole sale. If omitted, it is automatically calculated from the list of items in the sale. |
<deposit> | The amount that the client wants paid today. If omitted, the minimum deposit is calculated and used. |
<datetime> | The date_time is used as the date of purchase to calculate the payment plan schedule. If omitted, the current date is used |
<card_addr> | card_addr is used for avs credit card checking, if avs checks are enabled. |
<card_zip> | card_zip is used for avs credit card checking, if avs checks are enabled. |
<card_cvv2> | card_cvv2 is used for avs credit card checking, if avs checks are enabled. |
When VerifySale or GetPaymentPlan is called, these functions return the payment plan schedule back as a table to the caller. The table shows the dates and amount to be paid. The first entry with today's date is the minimum deposit required today. The Payment Plan schedule that is returned shows the plan payment dates, the amounts due on those dates and a brief description for each of the payments, e.g., "2 of 4 payments".
Example invocation:
<func>processsale</func>
<sale>
<settlement>
<PaymentPlan>
<datetime>11/6/2012</datetime>
<amount>816.32</amount>
<deposit>200.00</deposit>
</PaymentPlan>
</settlement>
See also