The gateway TERMID setup includes a URL on the platform where all notifications are sent. This allows the platform to react to scheduled activity by updating the customer’s account, maintaining a local copy of the schedules, react to declines, etc.
When the platform receives the notification, it should respond to the gateway with a HTTP status of 200 and a response in the body. The response is either OK if the notification is accepted or a short error message if the notification is not accepted.
Payment Processed Notification
Every time the gateway processes a scheduled payment, the details of what happened are sent to the platform as a notification message.
Notification Fields
Description
TERMIDThe Terminal ID that triggered the notification
TYPEN for notificationSUBTYPESP for scheduled paymentSCHEDIDSchedule ID of the payment
INVOICETagged invoice number
REFNUMReference number of the payment
APPROVEDY for yes, N for noRESPONSEText response of the transaction
SCHEDULEDATAPlatform Response to Notification
Notification Fields
Description
OKThe notification is accepted
ERRORThe notification cannot be accepted by the platform (manual intervention required)
RETRYNotification not accepted but should be retried later
SCHEDIDSchedule ID of the payment
INVOICETagged invoice number
REFNUMReference number of the payment
APPROVEDY for yes, N for noRESPONSEText response of the transaction
Example
Request:
TERMID=TESTTERM&TYPE=N&SUBTYPE=P&REFNUM=6e66c812‑e620‑4750‑aef2‑8840006bb9de&APPROVED=Y&SCHEDID=123e4567‑e89b‑12d3‑a456‑426655440000&PYMTS=[DATE=20200921&AMT=100.00&REFNUM=6e66c812‑e620‑4750‑aef2‑8840006bb9de&RESULT=A&NOTIFY=N&CARDMASK=****6781&RESPONSE=APPROVED][DATE=20201021&AMT=100.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=RResponse:
OK