|
This
section describes the details of using the GOrealtime
Gateway in Full Pass mode. You should have already read
the Basics section before reading these instructions.
1.
Data Path
In
Full Pass Mode, the shopper enters your site, makes
purchase choices and is passed to the GOrealtime Gateway
when the total amount is known and the shopper is ready
to pay with their credit card. Your site passes every
necessary piece of information for the credit card transaction
to take place. The GOrealtime Gateway will immediately
process the transaction without having to ask your shopper
for additional information. To
see a diagram of this sequence of events,
point your mouse here.
2.
Variables
Here are the variables your site needs to pass to the
GOrealtime Gateway:
- EPP_ID
- required
- The
ID assigned to you when you were approved for
your GOrealtime Gateway account
- alphanumeric,
max length 10
- Amount
- required
- This
is the purchase amount in dollars and cents. Send
as a number with 2 decimal places (67.23 for example).
If you send a number without a decimal in it,
it will be assumed to be a whole dollar amount.
- real
number
- cardType
- required
- Pass
a number corresponding to a card type:
- for
a VISA, pass a 1
- for
a MasterCard, pass 2
- for
an American Express, pass 3
- for
a Discover card, pass 4
- integer
value between 1 and 4
- cardNumber
- required
- This
is the credit card number for the shopper's credit
card. Any spaces will be stripped out before processing.
- alphanumeric,
max length 30
- cardMonth
- required
- This
is a 2 digit number corresponding to the expiration
date of the shopper's credit card number. 01 is
January, 02 is Februrary, etc...
- integer
value of 2 digits
- cardYear
- required
- This
is a 4 digit number indicating the year of the
expiration date of the shopper's credit card.
- integer
value of 4 digits
- buyerName
- required
- This
is the name of the shopper as it appears on the
shopper's credit card
- alphanumeric,
max length 30
- buyerEmail
- required
- This
is the email of the shopper
- alphanumeric,
max length 35
- buyerAdd1
- required
- This
is the street address of the shopper's credit
card billing address
- alphanumeric,
max length 30
- buyerCity
- required
- The
city of the shopper's credit card billing address
- alphanumeric,
max length 30
- buyerST
- required
- The
2 character postal abbreviation for the state
of the shopper's credit card billing address
- alphanumeric,
length 2
- buyerZIP
- required
- The
5 digit postal zip code for the shopper's credit
card billing address
- numberic,
length 5
- STEP
- required
- pass
in the value "2". This special code indicates
you are using Full Pass Mode.
- integer,
single digit
- InvoiceNum
- optional
- An
invoice number for your own records. This number
is returned if you are set up to receive the transaction
results.
- alphanumeric,
max length 10
- ReturnURL
- optional
- A
URL to return to after the transaction is done.
You can also specify this when your GOrealtime
Gateway account is first set up and not have to
resupply it with each transaction.
- If
you do provide this variable, it should be in
one of two forms:
- <FORM
METHOD=POST action="http://www.shopsite.com/cgi-bin/finishsale.cgi">
- http://www.shopsite.com/approved.html
- alphanumeric,
max length 250
- ReturnURL_FALSE
- optional
- A
URL to return to after the transaction is done
if the transaction was declined
- If
you provide this variable, it should be in one
of two forms:
- <FORM
METHOD=POST action="http://www.shopsite.com/cgi-bin/declined.cgi">
- http://www.shopsite.com/declined.html
- alphanumeric,
max length 250
3.
Sample Form
<FORM
METHOD=POST action="https://secure.gorealtime.com /authorize.exe">
<INPUT TYPE="HIDDEN" NAME="Amount" VALUE="107.50">
<INPUT TYPE="HIDDEN" NAME="InvoiceNum" VALUE="ac444555">
<INPUT TYPE="HIDDEN" NAME="EPP_ID" VALUE="8013732645">
<INPUT TYPE="HIDDEN" NAME="STEP" VALUE="2">
<INPUT SIZE="5" NAME="buyerZIP">
<INPUT SIZE="2" NAME="buyerST">
<INPUT SIZE="30" NAME="buyerCity">
<INPUT SIZE="30" NAME="buyerAdd1">
<INPUT SIZE="30" NAME="buyerName">
<INPUT SIZE="35" NAME="buyeremail">
<INPUT SIZE="4" NAME="cardYear">
<INPUT SIZE="2" NAME="cardMonth">
<INPUT SIZE="20" NAME="cardNumber">
<INPUT SIZE="1" NAME="cardType">
<INPUT TYPE="submit" value="CHARGE">
</FORM>
4.
After the Sale
If
your return URL (as specified in the ReturnURL variable
or as specified when you set up your account) is:
<FORM
METHOD=POST action="http://www.shopsite.com/cgi-bin/finishsale.cgi">
The GOrealtime Gateway will pass back the following
variables. You can then have your cgi script take appropriate
action (such as shipping the product, etc).
- Result
- Indicates
whether the transaction was approved or not
- boolean
value ("TRUE" or "FALSE")
- InvoiceNum
- The
invoice number your optionally passed in at the
beginning of the transaction
- alphanumeric,
max length 10
- OrderNumber
- The
order number returned by a successful transaction.
You will need this order number to perform future
actions (like credits) against this transaction.
- alphanumeric,
max length 20
- Result_Amount
- The
amount the the transaction was approved for. This
should always be the same as the "Amount" variable
you supplied at the beginning of the transaction
- real
number
- "Terse
Mode"
- optional
- pass
the value "1". This is a special code to indicate
you are using Terse mode.
- <INPUT
TYPE="HIDDEN" NAME="TERSE" VALUE="1">
- Terse
mode is used when you don't want the shopper to
see the GOrealtime Gateway at all. This is primarily
used with shopping cart software. In Terse mode,
there are no status messages during the transaction.
When the transaction is complete, the GOrealtime
Gateway will return "TRANSACTION DECLINED [reason]"
or "'TRANSACTION APPROVED". Your software can
capture this response and present the shopper
with your own customized information.
|