0% found this document useful (0 votes)
2 views

Request Variables for Authorize and AuthorizeAPI Methods

The document outlines the required and optional variables for the Authorize and AuthorizeAPI methods, detailing each variable's name, description, type, and required status. Key variables include SerialNumber, DeveloperSerialNumber, SJName, and TransactionAmount, among others, with specific formatting and length requirements. It also provides examples for clarity on how to format the data correctly for processing transactions.
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
2 views

Request Variables for Authorize and AuthorizeAPI Methods

The document outlines the required and optional variables for the Authorize and AuthorizeAPI methods, detailing each variable's name, description, type, and required status. Key variables include SerialNumber, DeveloperSerialNumber, SJName, and TransactionAmount, among others, with specific formatting and length requirements. It also provides examples for clarity on how to format the data correctly for processing transactions.
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 9

Request Variables for Authorize and AuthorizeAPI Methods

Variable Name Variable Required / Variable Min / Level Example


Description Optional Type Max
Length
SerialNumber HTML Serial Required Numeric 12/12 1 000111222333
Number.

Skipjack-
assigned unique
HTML serial
number.
DeveloperSerialNu Developer Serial Conditional Alpha- 12/12 1 ABC123456789
mber Number Numeric

Developer Serial
Number
Assigned to the
Skipjack Account.

This variable is
conditional as
determined by
whether or not
this option is set
as mandatory in
the Merchant
Services
Interface.
SJName Customer's Required Alpha- 1/40 1 John Doe
Name Numeric

Cardholder’s
Billing Name.
Email Customer's Required Valid e- 1/40 1 [email protected]
Billing Email mail m
Address Characte
rs
StreetAddress Customer's Required Alpha- 1/40 1 1 Skipjack Way
Billing Street Numeric
Address and
comma
(',') and
period
('.')
StreetAddress2 Additional Billing Optional Alpha- 0/40 1 Apartment 1
Address Numeric
Information comma
(',') and
period
('.')
StreetAddress3 Additional Billing Optional Alpha- 0/40 1 Lower Level
Address Numeric
Information and
comma
(',') and
period
('.')
StreetAddress4 Additional Billing Optional Alpha- 0/40 1 Side Door
Address Numeric
Information and
comma
(',') and
period
('.')
City Customer's Required Alpha- 1/40 1 Cincinnati
Billing City Numeric

All Spaces within


a City will be
removed
State Customer's Required Alpha- 1/40 1 OH
Billing State or Numeric
Province
ZipCode Customer's Required Alpha- 1/10 1 12345 or
Billing Zip or Numeric 123456789
Postal Code and '-'
Country Customer's Optional* Alpha- 0/40 1 USA, Canada,
Billing Country. Numeric UK, 840 (for USA
Level III)
Must be the
corresponding
country number
for Level III
qualification. See
“Error!
Reference
source not
found.”.

Note: For
those using
Paymentech
Salem as
Processor
the Country
variable is
Required.
Phone Customer's Optional Numeric 1/12 1 8005551212 or
Phone Number and dash 800-555-1212
('-')
Fax Customer's Fax Optional Numeric 1/12 1 8005551212 or
Number and dash 800-555-1212
('-')
ShipToName The Ship To Optional Alpha- 1/40 1 Jane Doe
Name Numeric
ShipToStreetAddre Customer's Optional Alpha- 1/40 1 1 Skipjack Way
ss Billing Street Numeric
Address and
comma
(',') and
period
('.')
ShipToStreetAddre Additional Billing Optional Alpha- 0/40 1 Apartment 1
ss2 Address Numeric
Information and
comma
(',') and
period
('.')
ShipToStreetAddre Additional Billing Optional Alpha- 0/40 1 Lower Level
ss3 Address Numeric
Information and
comma
(',') and
period
('.')
ShipToStreetAddre Additional Billing Optional Alpha- 0/40 1 Side Door
ss4 Address Numeric
Information and
comma
(',') and
period
('.')
ShipToCity Customer's Optional Alpha- 1/40 1 Cincinnati
Billing City Numeric
ShipToState Customer's Optional Alpha- 1/40 3 OH
Billing State or Numeric
Province
ShipToZipCode Customer's Optional Alpha- 1/10 3 12345 or
Billing Zip or Numeric 123456789
Postal Code and dash
('-')
ShipToCountry Customer's Optional Alpha- 0/40 3 USA, Canada,
Billing Country Numeric UK, 840
ShipToPhone Phone Number Required Numeric 1/12 1 8005551212 or
for Customer at and dash 800-555-1212
Shipping ('-')
Destination
ShipToFax Customer’s Fax Optional Numeric 1/12 1 8005551212 or
Number and dash 800-555-1212
('-')
OrderNumber Order Number Required Alpha- 1/20* 1 ABC123 or 123
Numeric
The order
identifier (ID)
assigned by the
Merchant’s
Application when
the order is
placed to identify
the transaction
uniquely.

OrderNumber
should be
uniquely
generated by the
application to
prevent
duplicates.
(Duplicates order
numbers are
repeated Order
Numbers that
occur in a 24
hour period)

Note: For those


using
Paymentech
Salem as the
Payment
Processor the
Order Number
can be a
maximum of 22
alphanumeric
characters and
must be unique
per Settlement
Batch,
otherwise a
Decline will be
returned.

See also
“Unique
Order
Numbers”
OrderDescription Paymentech Soft Optional Alpha- See 4/22 DDS*123456789
Indicator numeric descrip 012345678
Merchant and and a tion*
Item Description single
asterisk
This variable “*”
must be in the
format of
X*Y
where X is the
Company
Identifier and Y
is the Item
Identifier.

Three formatting
options are
permitted:

3 characters*18
characters

7 characters*14
characters

12 characters*9
characters.

X+Y= 21
characters plus
an asterisk (*) for
a total of 22
characters.
AccountNumber Customer’s Required Numeric 13/18 1 41111111111111
Credit Card 1
Number

Note: Spaces
are not
permitted.
Month Customer’s Required Numeric 1/2 1 9 or 09
Credit Card
Expiration Month
Year Customer’s Required Numeric 2/4 1 09 or 2009
Credit Card
Expiration Year
CVV2 Card Verification Optional Numeric 3/4 1 123 or 1234
Value

Note: CVV
validation may
not be
supported by
the credit card
issuing bank.

See also “Card


Verification
Values (CVV)
and interpreting
CVV Return
Codes” section .
TransactionAmount The purchase Required Numeric 3/(does 1 1.00 or 1000.00
amount to be and not
authorized on the period ( include
Customer's credit ".") Decima
card. l)

Use the XX.XX or


XXXX format for
this value.

All amounts must


contain only two
digits to the right
of the decimal.

A negative
TransactionAmou
nt can be used to
perform a Blind
Credit if the Blind
Credit feature is
enabled in the
Merchant
Services
Interface.
Comment Any comment Optional Alpha- 0/255 1 This is a
about the Numeric comment
transaction.

Note: All
characters in
excess of the
maximum
length of 255
characters will
be truncated.
TrackData TrackData Optional See See 1 See “Using
Notes descrip Trackdata Details
Track 1, Track 1 t-ion in Transactions”
and 2, or Track 2 for examples.
Magstripe data
on back of credit
card.

See also “Using


Trackdata Details
in Transactions.”
userdefined Any defined Optional Alpha- 0/255 1 color = blue
variable name Numeric

Up to 30 user-
defined fields are
permitted per
transaction.

The name of the


user defined
fields can only be
40 characters
long.
CustomerTax Customer sales Optional Numeric 3/12 2 10.10
tax amount and
period
See also (".")
“Orderstring
Variables”
section.
CustomerCode Customer Code Optional Alpha- 0/17 2 B1999888777
Numeric
PurchaseOrderNu Purchase Order Optional Alpha- 0/25 2 A123456777
mber Number Numeric
InvoiceNumber Invoice Number Optional Alpha- 0/40 1 A123456100200
Numeric
ShippingAmount Shipping charges Optional Numeric 3/12 3 3.25
(Amount.) and
period
All amounts must (".")
contain two digits
to the right of the
decimal.

If 1.0 is passed,
10 cents ($ 0.10)
will be charged.
UniqueVatInvoiceN VAT Invoice Optional Alpha- 0/15 3 000000000
umber Reference Numeric
Number
VatTaxAmount VAT Tax Amount Optional Numeric 0/12 3 0.00
or Alternate Tax and
Amount period
(".")
VatTaxRate VAT Tax Rate Optional Numeric 0/4 3 0.0
CustomerVatNumb Customer VAT Optional Alpha- 0/13 3
er Registration ID Numeric
DutyAmount Duty Amount Optional Numeric 0/12 3 1.23
SummaryCommodi Summary Optional Alpha- 0/4 3 5085
tyCode Commodity Code numeric

If the Processor
is Global then all
Alpha Characters
should be passed
as uppercase.
NationalTax National Tax Optional Numeric 0/12 3 1.05
Amount and
period
(".")
DiscountAmount Discount Amount Optional Numeric 0/12 3 1.04
and
period
(".")
OrderString Level 1 Line Item Required Alpha- 15/200 1 ItemNumber~ite
Details. Numeric, 0 mDescription~ite
'||' and '~' mCost~Quantity~
See also N~||
“Orderstring
Variables”
section.
orderstring_lvl3 Level 3 Data Line Optional Alpha- 53/200 3 ItemNumber~ite
Item Detail for Numeric, 0 mDescription~ite
Purchase Cards. '||' and '~' mCost~Quantity~
N~UnitofMeasure
~itemdiscount~ex
tendedamount~c
ommoditycode~v
attaxamount~vatt
axrate~alternatet
axamount~taxrat
e~taxtype~taxam
ount~||

You might also like