Start Session

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

Required
Request Field
Description
N
TERMID
8 character terminal ID assigned by SportsPay; must be the first field
N
TYPE
Will always be W for Web-Redirect
N
PASS
Password for the TERMID
N
ACTION
StartSession
N
AMT
The dollar amount to be charged to the customer.

Must include the cents: “1.00” and not “1”

N
CUSTEMAIL
E-mail address of the customer
N
REQUESTID
Unique value assigned to the payment session to avoid duplicate sessions (5-20 digits)
LANG
Language to display to the customer: E for English or F for French
(Defaulted to English)
REFNUM
Unique value; if omitted or blank, it will be assigned by the gateway
INV
Merchant’s invoice number to be tagged to the transaction for reporting (5-20 digits; alphanumeric only; no spaces). It does not need to be unique.
DESC
Description of the payment for reporting purposes

Obtain Card Token

Required
Request Field
Description
N
TERMID
8 character terminal ID assigned by SportsPay; must be the first field
N
TYPE
Will always be W for Web-Redirect
N
PASS
Password for the TERMID
N
ACTION
StartSession
N
AMT
The amount will always be 0.00
N
CUSTEMAIL
E-mail address of the customer
N
REQUESTID
Must be TOKEN
LANG
Language to display to the customer: E for English or F for French
(Defaulted to English)
INV
Merchant’s invoice number to be tagged to the transaction for reporting (5-20 digits; alphanumeric only; no spaces). It does not need to be unique.
DESC
Description of the payment for reporting purposes

The optional values are the same as when Creating New Payment Session except REFNUM is ignored

Add/Update Card to Existing Payment Schedule

Required
Request Field
Description
N
TERMID
8 character terminal ID assigned by SportsPay; must be the first field
N
TYPE
Will always be W for Web-Redirect
N
PASS
Password for the TERMID
N
ACTION
StartSession
N
SCHEDID
The schedule identifier
N
CUSTEMAIL
E-mail address of the customer
REFNUM
The REFNUM of the scheduled payment to process immediately (This would be omitted if only attaching/updating card without processing a payment immediately)
LANG
Language to display to the customer: 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