Add/Update/Remove Payment

Schedules can be modified by adding additional payments, changing the date or amount of a payment, or removing a payment.

Payments that have already been processed and approved (A result) cannot be updated or removed.

Removing all the remaining payments from a schedule will change its STATUS to C(complete).

Conversely, adding a payment to a completed schedule will change its STATUS to R (ready).

Attach Payment

Required
Request Field
Description
N
SUBTYPE
PA to attach payment
N
SCHEDID
Unique identifier
DATE
Processing date in YYYYMMDD format (-30 to +365 days)
AMT
Amount
REFNUM
Unique value; if omitted or blank, it will be assigned by the gateway

Update Payment

Required
Request Field
Description
N
SUBTYPE
PU to update payment
N
SCHEDID
Unique identifier
N
DATE
Processing date in YYYYMMDD format (-30 to +365 days)
AMT
Amount
REFNUM
The REFNUM of the payment in the schedule

Remove Payment

Required
Request Field
Description
N
SUBTYPE
PR to remove payment
N
SCHEDID
Unique identifier
N
REFNUM
The REFNUM of the payment in the schedule

Response to Adding/Updating/Removing Payment

Response Field
Description
CODE
0000 is approved; anything else is an error code
TEXT
OK or the error description
REFNUM
Assigned REFNUM for add payment only
SCHEDULEDATA
The Schedule Data block is appended to the response if the schedule was created.
p

DATE must be less than 30 days ago and not more than 1 year from today

Example: Attach payment

Request:
TERMID=TESTTERM&PASS=mypass&TYPE=L&SUBTYPE=PA&SCHEDID=123e4567‑e89b‑12d3‑a456‑426655440000&DATE=20201125&AMT=200.00&REFNUM=e0ac7b99-d94d-4b7a-b895‑621e82e62a1e
Response:
CODE=0000&TEXT=OK&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=100.00&REFNUM=c176637b‑18c8‑4ad0‑9140‑8c9de456bac5&RESULT=W&NOTIFY=N&CARDMASK=]DATE=20201125&AMT=200.00&REFNUM=e0ac7b99‑d94d‑4b7a‑b895‑621e82e62a1e&RESULT=W&NOTIFY=N&CARDMASK=]&INVOICE=123456789&CARDMASK=****6781&CARDHASH=AFD6B61A6955A3B11B2ACEB4193EA981&CUSTNAME=JOHNSMITH&CUSTEMAIL=johnsmith@email.com&STATUS=R