| Form
Post & Input Field Detail |
Q: I'm setting up different styles of order forms and need to
know the URL to POST the form.
STANDARD Form Post: https://secure.paymentclearing.com/cgi-bin/rc/ord.cgi
SPLITFORM Post: https://secure.paymentclearing.com/cgi-bin/mas/split.cgi
BUYNOW Post: https://secure.paymentclearing.com/cgi-bin/mas/buynow.cgi
Q: I'm setting up an order form on my site and I'm wondering
if you have a listing of field names that are required and
a list of those that are optional.
A: The required fields depend on the types of payments you will be accepting.
Please refer to the field definitions and examples below.
|
| - with field length
limits if applicable ( )
These basic fields are always required:
|
| vendor_id |
Your ID. (Assigned when you registered.)
Example:
<input type="hidden" name="vendor_id" value="12345"> |
| home_page |
Your home page URL.
Example:
<input type="hidden" name="home_page" value="http://www.yoursite.com"> |
| ret_addr |
The full URL to which customers are directed after order completion.
(This is a page or CGI on your server.)
Examples:
<input type="hidden" name="ret_addr" value="http://www.yoursite.com/thankyou.html">
<input type="hidden" name="ret_addr" value="http://www.yoursite.com/cgi-bin/return.cgi"> |
| *_desc |
Description of item #*.
Examples:
<input type="hidden" name="1_desc" value="T-Shirt">
<input type="hidden" name="2_desc" value="Baseball Hat"> |
| *_cost |
Cost of item #*.
Examples:
<input type="hidden" name="1_cost" value="19.95">
<input type="hidden" name="2_cost" value="14.95">
<input type="hidden" name="3_cost" value="-10.00"> (Reduces the overall
total by $10.00.)
|
| *_qty |
Quantity of item #*.
Examples:
<input name="1_qty" value="1">
<SELECT NAME="2_qty">
<OPTION>
<OPTION>1
<OPTION>2
<OPTION>3
<OPTION>4
<OPTION>5
<OPTION>6
<OPTION>7
<OPTION>8
<OPTION>9
<OPTION>10
</select> |
| *_anything |
Any other attribute of the item being ordered. These attributes are optional.
Include as many as you'd like.
Examples:
<input name="1_size" value="Large">
<input name="1_color" value="White"> |
* indicates item number; 1_desc, 2_desc, 3_desc,
etc.
Note: A field separator of underscore (1_desc) or dash (1-desc)
may be used.
In addition, if your system doesn't allow field names beginning with a
number, you may use item_1_desc, item_2_desc, etc. Only one naming convention
per order form may be used. |
If you will be using either the Split Form or BuyNow format, these fields are
required:
| showaddr |
The value of this field must be '1' when using the BuyNow format. Do
not use this field if you are using a SplitForm.
Example:
<input type="hidden" name="showaddr" value="1"> |
| showcvv |
The value of this field must be '1' if you would like to allow the customer
to enter the CVV number printed on their credit card.
Example:
<input type="hidden" name="showcvv" value="1">
Follow this link for details. |
| mername |
The name of your business. This will appear on the order form on the
secure server.
Example:
<input type="hidden" name="mername" value="Acme Clothing"> |
| acceptcards |
Value must be '1' if you are accepting credit cards.
Example:
<input type="hidden" name="acceptcards" value="1"> |
| acceptchecks |
Value must be '1' if you are accepting checks.
Example:
<input type="hidden" name="acceptchecks" value="1"> |
| accepteft |
Value must be '1' if you will be accepting EFT transactions.
Example:
<input type="hidden" name="accepteft" value="0"> |
| altaddr |
Value must be '1' if you would like to allow customers to enter an alternate
shipping address. Valid for credit card transactions only.
Example:
<input type="hidden" name="altaddr" value="1"> |
| nonum |
Removes the check number field from the BuyNow or SplitForm. (This field
is removed automatically if you are accepting EFT payments.)
Example:
<input type="hidden" name="nonum" value="1"> |
The fields listed below are optional for any of the order form formats, but can be used to add functionality to your system. (Click on a link for more information.)
| preauth |
Perform an authorization ONLY on the customer's credit card. Must be
followed-up later with a post-authorization from the Transaction Listing.
Example:
<input name="preauth"> |
| ret_mode |
Allows the merchant to by-pass the "Continue" page
on the server after a successful order.
Examples:
<input type="hidden" name="ret_mode" value="post">
<input type="hidden" name="ret_mode" value="redirect">
Follow this link.
|
| check_num |
Customer's check number.
Example:
<input name="check_num"> |
| check_memo |
Customer's check memo. Can be input by the customer or included as a
specific hidden value by the merchant. The check memo will be printed on
the customer's check.
Example:
<input name="check_memo"> |
| passback |
A value defined by the merchant that
will be passed back to the merchant after order completion. This function
enables merchants to keep user sessions
open, which enables real-time delivery of software, information, etc. (One
or more values can be passed.) Please note that each passback field must
contain a value. If the field contains no value, you will receive a "nonexistent
passback parameter" error.
Example:
Follow this link.
|
| lookup |
Enables Merchant to request specific information about a customer from
the processing server. See the example order forms for complete information.
Example:
Follow this link.
|
email_text
(through email_text10) |
You may include up to ten separate text fields that will be appended
together, separated with a line space, and included in the body of the
confirmation email sent to the customer and merchant.
Example:
<input type="hidden" name="email_text" value="Thank you for shopping with
us today.">
<input type="hidden" name="email_text2" value="Please shop with us again!">
Follow this link for details.
|
If you have your own secure server and will be using the standard order form, these fields are required.
first_name
(50) |
Customer's first name.
Example:
<input name="first_name" size=30> |
last_name
(50) |
Customer's last name.
Example:
<input name="last_name" size=30> |
address
(100) |
Customer's address.
Example:
<input name="address" size=30> |
city
(25) |
Customer's city.
Example:
<input name="city" size=30> |
state
(25) |
Customer's state.
Example:
<input name="state" size=3> |
zip
(12) |
Customer's ZIP or postal code.
Example:
<input name="zip" size=10> |
country
(45) |
Customer's country. (If
you will be accepting US checks only, you can make this a hidden field
type with
a value of "US".)
Example:
<input name="country" size=30> |
phone
(25) |
Customer's phone number.
Example:
<input name="phone" size=15> |
email
(255) |
Customer's email address.
Example:
<input name="email" size=15> |
| ccnum |
Credit card number. (If you are
accepting credit cards.)
Example:
<input name="ccnum" size=20> |
| ccswipe |
Credit card swipe data. (If you
are using swiped credit card data.)
Example:
<textarea name="ccswipe" rows=2 cols=40>
Example Swipe Data:
%B5454545454545454^LASTNAME/ FIRSTNAME ^01023040000000567000000? ;5454545454545454=01023040000005678000? |
| ccmo |
Credit card expiration month. (If you are accepting credit
cards.)
Example:
<select NAME="ccmo">
<option>
<option value='January'>01
<option value='February'>02
<option value='March'>03
<option value='April'>04
<option value='May'>05
<option value='June'>06
<option value='July'>07
<option value='August'>08
<option value='September'>09
<option value='October'>10
<option value='November'>11
<option value='December'>12
</select> |
| ccyr |
Credit card expiration year. (If you are accepting credit
cards.)
Example:
<select NAME="ccyr">
<option>2005
<option>2006
<option>2007
<option>2008
<option>2009
<option>2010
</select> |
| aba |
Customer's 9-digit bank identification number. (If you are accepting checks or EFT.)
Example:
<input name="aba" size=10 maxlength=9> |
| account |
Customer's checking account number.
(If you are accepting checks or EFT.)
Example:
<input name="account" size=15> |
The fields listed below are optional and are used to obtain a shipping address:
sfname
(50) |
Ship-To First Name
Example:
<input name="sfname" SIZE=15>
|
slname
(50) |
Ship-To Last Name
Example:
<input name="slname" SIZE=15> |
saddr
(100) |
Ship-To Address
Example:
<input name="saddr" SIZE=15> |
scity
(25) |
Ship-To City
Example:
<input name="scity" SIZE=15> |
sstate
(25) |
Ship-To State
Example:
<input name="sstate" SIZE=15> |
szip
(12) |
Ship-To Zip Code
Example:
<input name="szip" SIZE=15> |
sctry
(45) |
Ship-To Country
Example:
<input name="sctry" SIZE=15> |
|
