Often a payment should be processed at the same time the schedule is created. This can be done either through a direct call to the host or by using a web-redirect which also collects and attaches card data from the customer as part of the process.
Host-Based Method
The payment is attempted using either the card data already attached to the schedule or by specifying new card data which will then become attached to the schedule.
If the payment is declined then the schedule will be placed in the E (card error) STATUS and further action is needed (see below).
This action will provide a response message and will also trigger a callback notification the same way as if it had been processed by the scheduler. If the NOTIFY status of the returned schedule data is N keep in mind that the callback may have been delayed compared to the actual processing of the payment.
Any payments with a STATUS of W or D can be sent for processing regardless of date. This means that declined payments can be attempted again. Each time a declined payment is processed another entry is added to the payment list with a STATUS of X and blank REFNUM.
Process Scheduled Payment
This request may also be used to process a payment immediately rather than waiting for the scheduled date.
SUBTYPEPP for process paymentSCHEDIDREFNUMREFNUM of the payment in the scheduleProcess Scheduled Payment with New Card Data
These fields are only included if a new card is to be attached prior to processing the payment, otherwise the existing attached card will be used.
CARD + EXP, TRACK, or TOKENCUSTNAMECUSTEMAILResponse to Processing Payment with new card data attached
CODE0000 is approved; anything else is an error codeTEXTATTACHED or the error descriptionAUTHTOKENSCHEDULEDATAExample: Processing a payment using existing card data
Request:
TERMID=TESTTERM&PASS=mypass&TYPE=L&SUBTYPE=PP&SCHEDID=123e4567-e89b-12d3-a456-426655440000&REFNUM=6e66c812-e620-4750-aef2-8840006bb9deResponse:
CODE=0000&TEXT=APPROVED&SCHEDID=123e4567‑e89b‑12d3‑a456‑426655440000&PYMTS=DATE=20200921&AMT=100.00&REFNUM=6e66c812‑e620‑4750‑aef2‑8840006bb9de&RESULT=A&NOTIFY=Y&CARDMASK=****6781&RESPONSE=APPROVED]DATE=20201021&AMT=100.00&REFNUM=c176637b‑18c8‑4ad0‑9140‑8c9de456bac5&RESULT=W&NOTIFY=N]&INVOICE=123456789&CARDMASK=****6781&CARDHASH=AFD6B61A6955A3B11B2ACEB4193EA981&CARDNAME=JOHNSMITH&STATUS=RWeb-Redirect Method
When a payment is processed using web-redirect the card data attached to the schedule is always updated since if there was no requirement for new card data entry then there would not be any need for a redirect to the payment page.
The schedule of payments is included on the payment page and the current payment amount is prominently displayed to the customer.
Using web-redirect to process a scheduled payment is as simple as adding the appropriate.