Voucher processing

This Standard Operating Procedure (SOP) describes the process for credit card processing against web orders or for B2B customer paying their account via IP1 web services. This is sub-process following Payment Method Selection.

Procedure

It is your responsibility to ensure that you understand this procedure before performing the following tasks.

Note

Deviations from this procedure should be covered by procedures written by your company. Before performing any tasks please ensure all the business rules are set-up accordingly. 

Process overview

This section documents the Headline Processes for the web user to process payment using voucher. It assumes:

  • A valid IP1 voucher has already been purchased & issued to the web user
  • Pre-requisite processes outlined in Payment Method Selection have already been done and the web user has selected voucher payment method.

Note: If the payment is by voucher and the value of the voucher is not sufficient, multiple vouchers can be used, any remaining balance can be paid by a credit card.

Ordering scenario

Refer to Payment using Voucher flowchart.

  1. User is presented with payment method options from viewCart.
  2. User selects Voucher payment option for this order
  3. Website retrieves payment requirements from retrievePaymentFields and presents user with payment entry form based on values returned.
    • Voucher payment requires entry of a valid Voucher Number and Voucher PIN.
    • After entry of these details, the website may optionally execute checkVoucher to check voucher is valid and show remaining balance available on this voucher.
    • Website could give user option to return to previous step and select a different payment method or voucher.
  4. Once voucher number & pin data has been collected, website executes makePayment with those details to finalise the order.
    • A return status of 0 indicates the payment was successfully processed. Website could display a ‘Thank you for your order’.
    • A return status of 2 indicates insufficient balance on voucher. The website should return to step 1 to determine allow user to select new payment method or additional vouchers for remaining balance.

Note that voucher payment is processed immediately for orders, whereas credit card payment for an order could be simple pre-authorised at entry time and then settled later as goods supply.

Payment of account scenario

  1. User selects outstanding invoice(s) to be paid.
  2. Website executes processInvoices
  3. Website presents web user with payment method options from processInvoices
  4. User selects Voucher payment option
  5. Website retrieves payment requirements from prepareAccountPayment and presents user with payment entry form based on values returned.
    • Voucher payment requires entry of a valid Voucher Number and Voucher PIN.
    • After entry of these details, the website may optionally execute checkVoucher to check voucher is valid and show remaining balance available on this voucher.
    • Website could give user option to return to previous step and select a different payment method or voucher.
  6. Once voucher number & pin data has been collected, website executes payInvoices with those details to finalise the account payment.
    • A return status of 0 indicates the payment was successfully processed. Website could display a ‘Thank you for your payment’.
    • A return status of 2 indicates insufficient balance on voucher. The website should return to step 2 to determine invoice balance remaining and allow user to select new payment method.