ACCOUNT

Account(s) associated with the transaction

Optional parameter used to pass account-level allocation details for a transaction. When included, this data appears in the Deposit Report, allowing merchants to reconcile deposits by internal accounting categories such as tax allocations, bank accounts, or other financial buckets.

Each entry includes:

• DESC – Description of the account category (for example: HST, Operating Account, Savings, etc.)
• AMT – Dollar amount attributed to that account category.

Notes:

• ACCOUNT entries are evaluated independently of the other optional PROGRAM and PLAYER entries that can also be used in the Deposit Report.
• The total of all ACCOUNT AMT values should equal the total transaction amount.
• If the total of all ACCOUNT AMT values is less than the transaction amount, the remaining balance is automatically assigned to an Unassigned ACCOUNT entry.
• Transactions may include ACCOUNT, PROGRAM, PLAYER, any combination of these, or none.

ACK

Acknowledge

Call that tells the gateway to finalize the transaction

ACTION

Action Type

The type of Web-Redirect request message being sent.

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”

• *If using CustomerPay, do not add the USERFEE to this amount. You will send two separate fields - one for USERFEE and one for AMT

CUSTEMAIL

Customer Email Address

The email address of the customer for reporting purposes. This is also a searchable field in our reporting.

CUSTNAME

Customer's Name

The name of the customer. This is also a searchable field in our reporting.,

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

FAILUREURL

Failure Return URL

The full URL where the customer will be redirected if the transaction is declined or encounters an error. This allows you to return the customer to a specific page (i.e. the registration form with an error message) so they can retry or choose another payment method. Must begin with "https://"

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, each TERMID requires a password for its use. The PASS is required for all transactions. The PASS will be provided during the time of setup.

PLATCHRG

Platform Charge

The fee you are subtracting from the approved transaction amount, to be paid by the merchant. Refer to Platform Billing.

PLATFEE

Platform Fee

The fee you are adding to the transaction, to be paid by the cardholder. Refer to Platform Billing.

PLATFORM

Platform Billing

When used with StartSession, the gateway automatically applies this value as either a Platform Fee (PLATFEE) or Platform Charge (PLATCHRG) based on the merchant’s pricing model.Refer to Platform Billing.

PLAYER

Player(s) associated with the Transaction

Optional parameter used to pass player- or participant-level detail for a transaction. When included, this data appears in the Deposit Report, allowing merchants to reconcile deposits by individual player.

Each entry includes:

• id – Player identifier (name or internal ID)
• AMT – Dollar amount attributed to the player.

Notes:

• PLAYER entries are evaluated independently of the other optional ACCOUNT and PROGRAM entries that can also be used in the Deposit Report.
• The total of all PLAYER AMT values should equal the total transaction amount.
• If the total of all PLAYER AMT values is less than the transaction amount, the remaining balance is automatically assigned to an Uncategorized PLAYER entry.
• Transactions may include PLAYER, ACCOUNT, PROGRAM, any combination of these, or none.

PROGRAM

Program(s) associated with the Transaction

Optional parameter used to pass program- or fee-level detail for a transaction. When included, this data appears in the Deposit Report, allowing merchants to reconcile deposits by program or fee type.

Each entry includes:

• Name – Program or fee description
• AMT – Dollar amount for the program.

Notes:

• PROGRAM entries are evaluated independently of the other optional ACCOUNT and PLAYER entries that can also be used in the Deposit Report.
• The total of all PROGRAM AMT values should equal the total transaction amount.
• If the total of all PROGRAM AMT values is less than the transaction amount, the remaining balance is automatically assigned to an Uncategorized PROGRAM entry.
• Transactions may include PROGRAM, ACCOUNT, PLAYER, any combination of these, or none.

REFNUM

Reference Number

The reference number you want to attach to the transaction. It must be unique within the batch. If omitted or blank, it will be assigned by the gateway. It is fully and partially searchable on reporting.

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.
The 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 impossible 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.

SUCCESSURL

Success Return URL

The full URL where the customer will be redirected after a successful transaction. This allows you to return the customer to a specific page (i.e. a registration confirmation page) after payment is completed. Must being with "https://"

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.
The TERMIDmust always be the first field of the transaction

TYPE

Transaction Type

The type of transaction message being sent.

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.

CARDEXP

Card Expiration

Expiration date of the card.

CARDHASH

Card Hash

Tokenized card hash used to identify the same card across transactions without exposing card data.

CARDMASK

Card Mask

PCI-safe masked card number used to identify the card in reports and responses.

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

Date

The date of the transaction

DUR

Duration

The amount of time the gateway required to process the request

GATEREF

Gateway Reference

A system-wide unique identifier assigned to each approved transaction and passed back in GetResult where ACK=Y or Ack. Unlike other reference numbers, the Gateway Reference is globally unique across all terminals, batches, and time. It can be used to query, trace, or cross-reference transactions throughout the entire system.

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

TIME

Time

The server clock at the time of the transaction

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.

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