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.
TERMID
PASS
TYPE
S
for SaleAMT
CARD
, TOKEN
or TRACK
CARD
: 9-25 digits; numericFor
TOKEN
: 16-19 characters; alphanumericFor
TRACK
: accepts all ASCII characters except backslashesEXP
*if used CARD
for card data
CVV2
CUSTEMAIL
@
.
$
!
+
-
_
#
*if used CARD
for card data
REF
-
; Must be unique within the current batch*highly recommended
CUSTNAME
-
'
.
INV
+
-
_
/
#
DESC
ECHO
KEY
OPERID
001
if unspecified or auto-settleUSERFEE
TERMID
PASS
TYPE
R
for ReturnAMT
CARD
, TOKEN
or TRACK
CARD
: 9-25 digits; numericFor
TOKEN
: 16-19 characters; alphanumericFor
TRACK
: accepts all ASCII characters except backslashesEXP
*if used CARD
for card data
CVV2
CUSTEMAIL
@
.
$
!
+
-
_
#
REF
-
; Must be unique within the current batchCUSTNAME
-
'
.
INV
+
-
_
/
#
DESC
ECHO
KEY
OPERID
001
if unspecified or auto-settleTERMID
PASS
TYPE
P
for Pre-AuthorizationAMT
CARD
, TOKEN
or TRACK
CARD
: 9-25 digits; numericFor
TOKEN
: 16-19 characters; alphanumericFor
TRACK
: accepts all ASCII characters except backslashesCARD
for card dataEXP
CARD
for card dataCVV2
CUSTEMAIL
@
.
$
!
+
-
_
#
REF
-
; Must be unique within the current batchCUSTNAME
-
'
.
INV
DESC
+
-
_
/
#
ECHO
KEY
OPERID
001
if unspecified or auto-settleTERMID
PASS
TYPE
A
for Auth onlyAMT
CARD
, TOKEN
or TRACK
CARD
: 9-25 digits; numericFor
TOKEN
: 16-19 characters; alphanumericFor
TRACK
: accepts all ASCII characters except backslashesCARD
for card dataEXP
CARD
for card dataCVV2
CUSTEMAIL
@
.
$
!
+
-
_
#
REF
-
; Must be unique within the current batchCUSTNAME
-
'
.
INV
DESC
+
-
_
/
#
ECHO
KEY
OPERID
001
if unspecified or auto-settleTERMID
PASS
TYPE
V
for VoidAMT
CARD
, TOKEN
or TRACK
CARD
: 9-25 digits; numeric OR you can use the number 0
in the CARD
field along with 0000
in the EXP
fieldFor
TOKEN
: 16-19 characters; alphanumericFor
TRACK
: accepts all ASCII characters except backslashes*if used CARD
for card data
EXP
0000
in the EXP
field along with 0
in the CARD
fieldREF
-
; Must be unique within the current batchCVV2
CUSTEMAIL
@
.
$
!
+
-
_
#
CUSTNAME
-
'
.
INV
+
-
_
/
#
DESC
ECHO
KEY
OPERID
001
if unspecified or auto-settleTERMID
PASS
TYPE
M
for Return VoidCARD
, TOKEN
or TRACK
CARD
: 9-25 digits; numeric OR you can use the number 0
in the CARD
field along with 0000
in the EXP
fieldFor
TOKEN
: 16-19 characters; alphanumericFor
TRACK
: accepts all ASCII characters except backslashesCARD
for card dataEXP
0000
in the EXP
field along with 0
in the CARD
fieldREF
REF
for the original Refund/Return that you are trying to VoidCVV2
@
.
$
!
+
-
_
#
CUSTEMAIL
-
'
.
CUSTNAME
INV
+
-
_
/
#
DESC
ECHO
KEY
001
if unspecified or auto-settleOPERID
TERMID
PASS
TYPE
C
for CompletionAMT
CARD
, TOKEN
or TRACK
CARD
: 9-25 digits; numeric OR you can use the number 0
in the CARD
field along with 0000
in the EXP
fieldFor
TOKEN
: 16-19 characters; alphanumericFor
TRACK
: accepts all ASCII characters except backslashesCARD
for card dataEXP
0000
in the EXP
field along with 0
in the CARD
fieldREF
REF
used in the original Pre-Auth transaction.CVV2
CUSTEMAIL
@
.
$
!
+
-
_
#
CUSTNAME
-
'
.
INV
DESC
+
-
_
/
#
ECHO
KEY
OPERID
001
if unspecified or auto-settleTERMID
PASS
TYPE
K
for TokenizeAMT
CARD
CARD
: 9-25 digits; numericEXP
REF
-
; Must be unique within the current batchCVV2
CUSTEMAIL
@
.
$
!
+
-
_
#
CUSTNAME
-
'
.
INV
DESC
+
-
_
/
#
ECHO
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.
TERMID
8 characters; alphanumeric 4
AMT
S
F
R
A
P
C
7 digits; numeric 5
AUTH
F
Assigned by InterPay™
CARD
S
F
R
A
P
K
6
V
C
M
0
may be usedCUSTNAME
Up to 40 characters;
alphanumeric;
Can use spaces -
'
.
CUSTEMAIL
Up to 40 characters;
Can use @
.
$
!
+
-
_
#
CVV2
S
R
A
P
Up to 4 digits;
numeric
DESC
Up to 30 characters;
Can use punctuation, spaces and +
-
_
/
#
ECHO
EXP
S
F
R
A
P
K
6
V
C
M
7
MMYY format without forward slash
Or, can use 0000
if Completion or Void and 0
used in CARD
field 7
KEY
OPERID
Defaults to 001
if unspecified or auto-settle
PASS
ALL 9
REF
S
V
F
R
M
A
P
C
Between 10 and 40 characters, alphanumeric; Can use -
INV
TOKEN
S
F
R
A
P
6
V
C
M
7
TRACK
TRACK1
TRACK2
S
F
R
A
P
6
V
C
M
7
Variable 8
TYPE
(Refer to Table for Details)
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.