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.

AMT

Amount

The amount of money for which the transaction is being performed. Does not include the USERFEE if merchant is using CustomerPay.

AUTH

Authorization Number

This field is used for Force Post transactions only. A Force Post transaction will allow you to deposit money which you already have authorization to charge. In order to do this, you will need to provide the original authorization number in this field.

CARD

Card Number

The card number for which the operation is being performed.

CUSTNAME

Customer Name

The name of the cardholder for reporting purposes.

CUSTEMAIL

Customer Email

The customers email address for reporting purposes.

CVV2

Card Verification Value 2 Data

This 3 or 4 character field is used to ensure the physical presence of a card in an environment where the cardholder is not present at the time of the purchase. The CVV2 value appears as additional characters following the credit card number which is printed within the signature panel on the back of the card. (For some cards this number is on the front.) This field is used for VISA CVV2, MasterCard CVC and American Express Card Identifier Code (CID or 4DBC).

DESC

Description

Descriptive text that is added to the transaction. It is a searchable field in reporting. E.g.: U13 girls or Fall Tryouts

EXP

Expiry Date

The expiry date of the card on which the operation is being performed.

INV

Invoice

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.

PASS

Password

For added security, each TERMID requires a password for its use. The PASS will be provided during the time of setup. The PASS is required for all transactions processed.

PLATFEE

Platform Fee

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

PLATCHRG

Platform Charge

The fee you are subtracting from the approved transaction amount, to be paid by the merchant. 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.

REF

Reference Number

A unique identifier for the transaction within the batch. Note: This is not the reference number which appears on the cardholder's statement.

TERMID

Terminal ID

The Terminal ID is a unique 8 character long, alphanumeric code 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. This field must be the first field of the transaction. Note: An organization may have multiple TERMID’s 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.

TOKEN

Tokenized Card Data

Tokenized card data on file from a previous transaction. A TOKEN is only valid for use with the same TERMID as the original transaction.

TYPE

Transaction Type

The kind of transaction you are performing. See Transaction Types for values. Note: In order to fully understand the different transaction types, it is helpful to understand the transaction clearing process – see The Credit Card Charging Process.

USERFEE

Customer Pay User 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. Refer to UserFee for more details.

AUTH

Authorization Number

For transactions which return authorization numbers (Sale, Pre-Authorization, Completion, Force Post, Auth Only), this is the authorization number. The authorization number is also returned in the TEXT field, so the AUTH field is provided mostly for convenience.

CODE

Response Code

This is the 4-digit response code from the transaction. All transaction responses contain a CODE field. "0000" constitutes a successful transaction, and any other 4-digit code constitutes a failure. This code should be used to check for authorization successes (0000), decline conditions (0001 - 1299), and error conditions (8000 - 9999).

DATE

Date

The date of the transaction

DUR

Duration

The duration of the transaction on the server. This can be compared to the duration on the client to establish the communication overhead.

HASH

Hash

A one-way hash of the card data. This can be safely stored and used as a cardholder identifier without risking exposure of the actual card number. (It cannot be used for transactions).

GATEREF

Gateway Reference

A system-wide unique identifier assigned to each approved transaction. Unlike other reference numbers, the Gateway Reference is globally unique across all terminals, batches, and time. It can be used to query transactions throughout the entire system.

TEXT

Text

This is the response text of the message and is included in the response for all transactions. The authorization number and amount are displayed here on an approval-type transaction. For errors and decline responses, this field contains the error message or decline message.

TIME

Time

The server clock for the transaction

TOKEN

Tokenized Card Data

Tokenized version of the card data. This value may be safely stored and used to perform future transactions.