The StartSession message creates a new redirect session that will then be used to securely process the payment directly between the customer’s web browser and the InterPay™ gateway.
A session may also be used to obtain a card token without charging the customer’s card. In this case the redirect process is the same but without an amount.
A session can be used to add/update card data to an existing Payment Schedule and optionally process one of the payments at the same time (if it’s REFNUM
is provided). The redirect process is the same but with specific fields included in StartSession resulting in the schedule being attached to the session.
Create New Payment Session
TERMID
TYPE
W
for Web-RedirectPASS
TERMID
ACTION
StartSession
AMT
Must include the cents: “1.00” and not “1”
CUSTEMAIL
REQUESTID
LANG
E
for English or F
for French(Defaulted to English)
REFNUM
INV
DESC
Obtain Card Token
TERMID
TYPE
W
for Web-RedirectPASS
TERMID
ACTION
StartSession
AMT
0.00
CUSTEMAIL
REQUESTID
TOKEN
LANG
E
for English or F
for French(Defaulted to English)
INV
DESC
The optional values are the same as when Creating New Payment Session except REFNUM is ignored
Add/Update Card to Existing Payment Schedule
TERMID
TYPE
W
for Web-RedirectPASS
TERMID
ACTION
StartSession
SCHEDID
CUSTEMAIL
REFNUM
REFNUM
of the scheduled payment to process immediately (This would be omitted if only attaching/updating card without processing a payment immediately)LANG
E
for English or F
for French(Defaulted to English)
Example: Credit Card Transaction
Request:
TERMID=TESTTERM&TYPE=W&PASS=mypass&ACTION=StartSession&AMT=120.25&REQUESTID=12345678&CUSTEMAIL=custname@gmail.com
Response:
CODE=0000&TEXT=SUCCESS&SECUREID=i1t6tvowc908r1655ww3816tv5cw88l1wa8&URL=https://www.PaymentHost.com:1443/redirect/Redirect?SecureID=i1t6tvowc908r1655ww3816tv5cw88l1wa8%38SecureTYPE=GET&DATE=2016‑03‑28&TIME=17:58:08&DUR=0.146
Example: Tokenization
Request:
TERMID=TESTTERM&TYPE=W&PASS=mypass&ACTION=StartSession&AMT=0&REQUESTID=TOKEN&CUSTEMAIL=custname@gmail.com
Response:
CODE=0000&SECUREID=i1t6tvowc908r1655ww3816tv5cw88l1wa8&URL=https://www.PaymentHost.com:1443/redirect/Redirect?SecureID=i1t6tvowc908r1655ww3816tv5cw88l1wa8&DATE=2016-03-28&TIME=17:58:08&DUR=0.146