Request Fields

Fields by Transaction Type

TERMID must always be the first field specified in the request message. The other fields can be included in any order.

Required
Request Field
Description
N
TERMID
8 characters; alphanumeric; Must always be the first field
N
PASS
Up to 16 characters; alphanumeric
N
TYPE
Must be S for Sale
N
AMT
Numeric; no dollar sign or decimal (e.g. "100" is one dollar)
N
CARD, TOKEN or TRACK
For CARD: 9-25 digits; numeric
For TOKEN: 16-19 characters; alphanumeric
For TRACK: accepts all ASCII characters except backslashes
N
EXP
4 digits; numeric; MMYY format without forward slash

*if used CARD for card data

CVV2
Up to 4 digits; numeric

N

CUSTEMAIL
Up to 40 characters; can use @ . $ ! + - _ #

*if used CARD for card data

REF
Between 10 and 40 characters; alphanumeric; can use -; Must be unique within the current batch

*highly recommended

CUSTNAME
Up to 40 characters; alphanumeric; can use spaces - ' .

INV
Up to 30 characters; can use punctuation, spaces and + - _ / #
DESC
Between 5 and 10 digits; numeric
ECHO
Up to 60 characters; alphanumeric
KEY
64 hex characters
OPERID
3 characters; alphanumeric; Defaults to 001 if unspecified or auto-settle
USERFEE
Numeric; no dollar sign or decimal (e.g. "100" is one dollar)
Required
Request Field
Description
N
TERMID
8 characters; alphanumeric; Must always be the first field
N
PASS
Up to 16 characters; alphanumeric
N
TYPE
Must be R for Return
N
AMT
Numeric; no dollar sign or decimal (e.g. "100" is one dollar)
N
CARD, TOKEN or TRACK
For CARD: 9-25 digits; numeric
For TOKEN: 16-19 characters; alphanumeric
For TRACK: accepts all ASCII characters except backslashes
N
EXP
4 digits; numeric; MMYY format without forward slash

*if used CARD for card data

CVV2
Up to 4 digits; numeric

N

CUSTEMAIL
Up to 40 characters; can use @ . $ ! + - _ #

REF
Between 10 and 40 characters; alphanumeric; can use -; Must be unique within the current batch
CUSTNAME
Up to 40 characters; alphanumeric; can use spaces - ' .
INV
Up to 30 characters; can use punctuation, spaces and + - _ / #
DESC
Between 5 and 10 digits; numeric
ECHO
Up to 60 characters; alphanumeric
KEY
64 hex characters
OPERID
3 characters; alphanumeric; Defaults to 001 if unspecified or auto-settle
Required
Request Field
Description
N
TERMID
8 characters; alphanumeric; Must always be the first field
N
PASS
Up to 16 characters; alphanumeric
N
TYPE
Must be P for Pre-Authorization
N
AMT
Numeric; no dollar sign or decimal (e.g. "100" is one dollar)
N
CARD, TOKEN or TRACK
For CARD: 9-25 digits; numeric
For TOKEN: 16-19 characters; alphanumeric
For TRACK: accepts all ASCII characters except backslashes
N *if used CARD for card data
EXP
4 digits; numeric; MMYY format without forward slash
N *if used CARD for card data
CVV2
Up to 4 digits; numeric
N
CUSTEMAIL
Up to 40 characters; can use @ . $ ! + - _ #
N
REF
Between 10 and 40 characters; alphanumeric; can use -; Must be unique within the current batch

CUSTNAME
Up to 40 characters; alphanumeric; can use spaces - ' .
INV
Between 5 and 10 digits; numeric
DESC
Up to 30 characters; can use punctuation, spaces and + - _ / #
ECHO
Up to 60 characters; alphanumeric
KEY
64 hex characters
OPERID
3 characters; alphanumeric; Defaults to 001 if unspecified or auto-settle
Required
Request Field
Description
N
TERMID
8 characters; alphanumeric; Must always be the first field
N
PASS
Up to 16 characters; alphanumeric
N
TYPE
Must be A for Auth only
N
AMT
Numeric; no dollar sign or decimal (e.g. "100" is one dollar)
N
CARD, TOKEN or TRACK
For CARD: 9-25 digits; numeric
For TOKEN: 16-19 characters; alphanumeric
For TRACK: accepts all ASCII characters except backslashes
N *if used CARD for card data
EXP
4 digits; numeric; MMYY format without forward slash
N *if used CARD for card data
CVV2
Up to 4 digits; numeric
N
CUSTEMAIL
Up to 40 characters; can use @ . $ ! + - _ #
N
REF
Between 10 and 40 characters; alphanumeric; can use -; Must be unique within the current batch

CUSTNAME
Up to 40 characters; alphanumeric; can use spaces - ' .
INV
Between 5 and 10 digits; numeric
DESC
Up to 30 characters; can use punctuation, spaces and + - _ / #
ECHO
Up to 60 characters; alphanumeric
KEY
64 hex characters
OPERID
3 characters; alphanumeric; Defaults to 001 if unspecified or auto-settle
Required
Request Field
Description
N
TERMID
8 characters; alphanumeric; Must always be the first field
N
PASS
Up to 16 characters; alphanumeric
N
TYPE
Must be V for Void

N

AMT
Numeric; no dollar sign or decimal (e.g. "100" is one dollar)
N
CARD, TOKEN or TRACK
For CARD: 9-25 digits; numeric OR you can use the number 0 in the CARD field along with 0000 in the EXP field
For TOKEN: 16-19 characters; alphanumeric
For TRACK: accepts all ASCII characters except backslashes

*if used CARD for card data

EXP
4 digits; numeric; MMYY format without forward slash OR you can use the numbers 0000 in the EXP field along with 0 in the CARD field

N

REF
Between 10 and 40 characters; alphanumeric; can use -; Must be unique within the current batch

CVV2
Up to 4 digits; numeric
CUSTEMAIL
Up to 40 characters; can use @ . $ ! + - _ #
CUSTNAME
Up to 40 characters; alphanumeric; can use spaces - ' .
INV
Up to 30 characters; can use punctuation, spaces and + - _ / #
DESC
Between 5 and 10 digits; numeric
ECHO
Up to 60 characters; alphanumeric
KEY
64 hex characters
OPERID
3 characters; alphanumeric; Defaults to 001 if unspecified or auto-settle
Required
Request Field
Description
N
TERMID
8 characters; alphanumeric; Must always be the first field
N
PASS
Up to 16 characters; alphanumeric
N
TYPE
Must be M for Return Void
N
CARD, TOKEN or TRACK
For CARD: 9-25 digits; numeric OR you can use the number 0 in the CARD field along with 0000 in the EXP field
For TOKEN: 16-19 characters; alphanumeric
For TRACK: accepts all ASCII characters except backslashes
N *if used CARD for card data
EXP
4 digits; numeric; MMYY format without forward slash OR you can use the numbers 0000 in the EXP field along with 0 in the CARD field
N
REF
The REF for the original Refund/Return that you are trying to Void

CVV2
Up to 40 characters; can use @ . $ ! + - _ #
CUSTEMAIL
Up to 40 characters; alphanumeric; can use spaces - ' .
CUSTNAME
Between 5 and 10 digits; numeric
INV
Up to 30 characters; can use punctuation, spaces and + - _ / #
DESC
Up to 60 characters; alphanumeric
ECHO
64 hex characters
KEY
3 characters; alphanumeric; Defaults to 001 if unspecified or auto-settle
OPERID
Required
Request Field
Description
N
TERMID
8 characters; alphanumeric; Must always be the first field
N
PASS
Up to 16 characters; alphanumeric
N
TYPE
Must be C for Completion
N
AMT
Numeric; no dollar sign or decimal (e.g. "100" is one dollar)
N
CARD, TOKEN or TRACK
For CARD: 9-25 digits; numeric OR you can use the number 0 in the CARD field along with 0000 in the EXP field
For TOKEN: 16-19 characters; alphanumeric
For TRACK: accepts all ASCII characters except backslashes
N *if used CARD for card data
EXP
4 digits; numeric; MMYY format without forward slash OR you can use the numbers 0000 in the EXP field along with 0 in the CARD field
N
REF
The REF used in the original Pre-Auth transaction.

CVV2
Up to 4 digits; numeric
CUSTEMAIL
Up to 40 characters; can use @ . $ ! + - _ #
CUSTNAME
Up to 40 characters; alphanumeric; can use spaces - ' .
INV
Between 5 and 10 digits; numeric
DESC
Up to 30 characters; can use punctuation, spaces and + - _ / #
ECHO
Up to 60 characters; alphanumeric
KEY
64 hex characters
OPERID
3 characters; alphanumeric; Defaults to 001 if unspecified or auto-settle
Required
Request Field
Description
N
TERMID
8 characters; alphanumeric; Must always be the first field
N
PASS
Up to 16 characters; alphanumeric
N
TYPE
Must be K for Tokenize

N

AMT
Numeric; no dollar sign or decimal (e.g. "100" is one dollar)
N
CARD
For CARD: 9-25 digits; numeric

EXP
4 digits; numeric; MMYY format without forward slash
REF
Between 10 and 40 characters; alphanumeric; can use -; Must be unique within the current batch
CVV2
Up to 4 digits; numeric
CUSTEMAIL
Up to 40 characters; can use @ . $ ! + - _ #
CUSTNAME
Up to 40 characters; alphanumeric; can use spaces - ' .
INV
Between 5 and 10 digits; numeric
DESC
Up to 30 characters; can use punctuation, spaces and + - _ / #
ECHO
Up to 60 characters; alphanumeric

Table of All Fields

For your convenience, the request fields are also listed in this table format.

Refer to last row in table to get transction type.

FIELD
TRANSACTION TYPE
TRANSACTION TYPE
LIMITS 1
VALUES
FIELD
Required 2
Optional 3

LIMITS 1
VALUES
TERMID
ALL

8 characters; alphanumeric 4

Assigned by SportsPayMust always be the first field
AMT
S F R A P C

7 digits; numeric 5

No dollar sign or decimal (e.g. "100" is one dollar)
AUTH
F
6 characters; alphanumeric

Assigned by InterPay™

CARD

S F R A P K 6

V C M

9-25 digits; numeric
For completions or voids without Card Numbers, the number 0 may be used
CUSTNAME
ALL

Up to 40 characters;

alphanumeric;

Can use spaces - ' .

CUSTEMAIL
ALL

Up to 40 characters;

Can use @ . $ ! + - _ #

CVV2

S R A P

Up to 4 digits;

numeric

DESC
ALL

Up to 30 characters;

Can use punctuation, spaces and + - _ / #

ECHO
ALL
Up to 60 characters
EXP

S F R A P K 6

V C M 7

4 digits; numeric

MMYY format without forward slash
Or, can use 0000 if Completion or Void and 0 used in CARD field 7

KEY
ALL
64 hex characters
OPERID
ALL
3 characters; alphanumeric

Defaults to 001 if unspecified or auto-settle

PASS

ALL 9

Up to 16 characters; alphanumeric;
REF

S V F R M A P C

Between 10 and 40 characters, alphanumeric; Can use -

Must be unique within the current batch
INV
ALL
Between 5 and 10 digits; numeric
TOKEN

S F R A P 6

V C M 7

16-19 characters; alphanumeric
TRACK
TRACK1
TRACK2

S F R A P 6

V C M 7

Variable 8

TYPE

(Refer to Table for Details)

1 byte

S - Sale

A - Auth Only

V - Void

P - Pre-Authorization

R - Return

M - Return Void

F - Force Post

C - Completion

K - Tokenize

B - Balance Request

D - Settlement

1 Backslashes (\) are not permitted in any transaction data.

2 This field is required for the transaction type(s) listed in that column.

3 This field is optional for the transaction type(s) listed in that column.

4 ‘Alphanumeric’ means all alphabetical characters (a-z and A-Z) and all digits (0-9). This does not include spaces or any other characters.

5 ‘Numeric’ means all numeric digits (0-9). This does not include spaces or any other character.

6 Exactly one of the following must be provided: TRACK1 or TRACK2 or TRACK or CARD and EXP or TOKEN

7 Completion or void transaction expiry dates may be provided as ‘0000’ if not stored, but only if card is not provided, or is provided as zeros. Any valid expiry date will be accepted, and for Completions the expiry date from the Pre-Authorization will be overlaid for deposit.

8 ‘Variable’ means that the data in the field is application-specific, but the field’s input checking will accept all ASCII characters except backslashes.

9 Can provide KEY instead of PASS.