Field Descriptions

Request Fields

Field
Name
Description
ACK
Acknowledge
Tells the gateway to finalize the transaction
ACTION
Action Type
The type of request message being sent.

For Web-Redirect, it will be either:StartSession,GetResult, or Ack.

AMT
Amount
The amount of money for which the transaction is being performed.

Any currency symbols must be removed, but the decimal point must be included.

For example: “$4.00” becomes “4.00”

CUSTEMAIL
Customer Email Address
The email address of the customer for reporting purposes.

This is also a searchable field.

Organizations often use the customer’s email address to locate a transaction so it is highly recommended to include this field for all transactions.

DESC
Description
Descriptive text that is added to the transaction.

This is displayed on the payment page.

It is a searchable field in reporting.

E.g.: U13 girls or Fall Tryouts

INV
Invoice Number
The invoice number assigned to the transaction that is displayed in reporting as well as to the customer on the payment page.

Acts as a “tag” on the transaction and doesn’t need to be unique.

The intended way to use this field is to group transactions together such as Sale and Refund, or a declined Sale and later approved Sale. By keeping the invoice number the same, you will be able to view the entire transaction history of the registration.

LANG
Language
The language of the payment page with the option of English or French.

Defaults to English.

PASS
Password
For added security, eachTERMID requires a password for its use.

ThePASSis required for all transactions.

ThePASSwill be provided during the time of setup.

REFNUM
Reference Number
The reference number you want to attach to the transaction.

It must be unique.

If omitted or blank, it will be assigned by the gateway.

It is fully and partially searchable on reporting.

Example: Using format such as “TRYOUT*********” with the stars representing unique numeric values would enable searching “TRYOUT” to view all “TRYOUT” transactions.

REQUESTID
Request ID
The Request ID is generated by the registration platform and sent to the gateway.

It is a message between your registration platform and the gateway and works to prevent duplicate sessions.

It does not show up in any reporting.

More informationThe REQUESTID is the first link in the chain of transaction integrity.

You are giving SportsPay something that you know is unique (REQUESTID) in trade for something that will uniquely identify the result (SECUREID).

This ensures that there will only ever be one SECUREID created on the gateway each time your system wants to start a payment session.

Without REQUESTID it would be possible for the gateway to issue a second SECUREID if somehow there was a duplicate StartSession call.

In conclusion, for each REQUESTID you can be sure that there will only ever be one payment result (Approved, Declined, etc.) and that result will never change.

TERMID
Terminal ID
The Terminal ID is a unique 8 character long, alphanumeric code assigned by SportsPay that is used to identify the source of the transaction.

Each organization that is issued a merchant account with SportsPay will have a TERMID associated with it.

An organization may have multiple TERMID associated with it depending on the setup. Think of a retail store that has multiple cashiers with each one needing a pinpad. Each pinpad would have its own terminal ID so when the transaction is processed, the pinpad and the retail store are easily identifiable.

The TERMID must always be the first field of the transaction

TYPE
Transaction Type
The type of transaction message being sent.
For Web-Redirect Processing, it will always be W
USERFEE
Customer Pay Processing Fee
The Customer Pay processing fee to apply to the transaction. This is used for merchants who have opted into Customer Pay where the customer pays all processing fees at the time of checkout.

Response Fields

Field
Name
Description
CARDTYPE
Card Type
The type of card used for the transaction in single letter format
CODE
Response Code
This is the 4-digit response code from the transaction
0000constitutes a successful transaction, and any other 4-digit code constitutes a failure
DATE,TIME
Date and Time
The gateway time for the transaction
DUR
Duration
The amount of time the gateway required to rpocess the requeset
SECUREID
Secure ID
The session identifier that is returned by StartSession and used in GetResult and Ack
TEXT
Response Text
Message indicating the result of the request: SUCCESS, CAPTURED, REVERSED
TOKEN
Tokenized Card Data
Tokenized version of the card data. This value may be safely stored and used to perform future transactions
URL
Redirect URL
A URL-Encoded string of the full URL for redirecting the customer’s browser
s

Ampersands (&) in the URL will be encoded to %38 and must be decoded back to the ampersand (&)