Create New Schedule

The schedule needs two things: the list of payments and the card data for the card to be charged. This first step is creating the schedule followed by adding the card data and the list of payments.

Card data and the list of payments can be added to a schedule either at the time the schedule is created or after it is created. Adding card data after the schedule is created is done through a Process Payment request  (SUBTYPE=PP) or Attach Card request  (SUBTYPE=AC), or using Web-redirect.

Creating the Schedule

Required
Request Field
Description
N
SUBTYPE
CS for create schedule
N
SCHEDID
Always unique; if omitted or blank, it will be assigned by the gateway
N
INVOICE
Invoice number on registration platform for reporting
DESC
Descriptive text for reporting
PYMTS
List of payment to add to the schedule (can be added later)

Adding Card Data to a Schedule

These fields are only included if a card is to be attached during creation otherwise a card may be attached later with PP or AC requests. 

Required
Request Field
Description
N
CARD + EXP,
TRACK, or
TOKEN
For card data, must choose one
N
CUSTNAME
Required when card data is included
N
CUSTEMAIL
Required when card data is included

Adding Payments (PYMTS) to a Schedule

The PYMTS field is built by appending the payments each one consisting of the following fields surrounded by [ ]  :

Required
PYMTS Field
Description
N
DATE
Processing date in YYYYMMDD format (-30 to +365 days)
N
AMT
Dollar amount with decimal (eg: $25 is "25.00")
Note: Missing decimal will be assumed, so "125" becomes "1.25"
N
REFNUM
Unique value; if omitted or blank, it will be assigned by the gateway
DESC
Description to be added to the payment transaction

Response to Schedule Created

Response Field
Description
CODE
0000 is approved; anything else is an error code and the schedule was not created
TEXT
SCHED CREATED or the error description
SCHEDULEDATA
The Schedule Data block is appended to the response if the schedule was created.
Example: Creating schedule of two payments of $100 with card data and the gateway assigning the unique identifiers

Request:
TERMID=TESTTERM&PASS=mypass&TYPE=L&SUBTYPE=CS&SCHEDID=&INVOICE=1234567890&CARD=4003000123456781&EXP=1228&CUSTNAME=JOHNSMITH&CUSTEMAIL=johnsmith@email.com&PYMTS=[DATE=20200921&AMT=100.00][DATE=20201022&AMT=80.00]
Response:
CODE=0000&TEXT=SCHEDCREATED&SCHEDID=123e4567‑e89b‑12d3‑a456‑426655440000&PYMTS=DATE=20200921&AMT=100.00&REFNUM=6e66c812‑e620‑4750‑aef2‑8840006bb9de&RESULT=W&NOTIFY=N&CARDMASK=****6781]DATE=20201021&AMT=80.00&REFNUM=c176637b‑18c8‑4ad0‑9140‑8c9de456bac5&RESULT=W&NOTIFY=N&CARDMASK=]&INVOICE=123456789&CARDMASK=****6781&CARDHASH=AFD6B61A6955A3B11B2ACEB4193EA981&CUSTNAME=JOHNSMITH&CUSTEMAIL=johnsmith@email.com&STATUS=R