2CO has our own proprietary set of parameters that you can use if your cart supports them.
Multi-page Payment Routine:
https://www.2checkout.com/2co/buyer/purchase
Supports all payment methods. Supports tangible and intangible products/services.
Single Page Payment Routine:
https://www.2checkout.com/checkout/spurchase
Only supports credit card payments and intangible products/services.
Required Parameters:
sid - Your 2Checkout vendor account number.
total - The total amount to be billed, in decimal form, without a currency symbol. (8 characters, decimal, 2 characters: Example: 99999999.99)
cart_order_id - A unique order id from your program. (128 characters max)
Product Identification Parameters:
Suppliers using this parameter set must pass in parameters to identify what is being sold during the purchase. These parameters will also benefit suppliers as when used correctly the product information will be displayed to customers on the purchase pages and will be listed on the suppliers 2Checkout.com sale detail page.
id_type - Due to changes in with the Product Identification parameters this parameter should be passed in once during the purchase and will need to have its value set to 1.
c_prod - The ID of the product that is being purchased. The quantity of product being purchased can passed with this parameter by placing a comma after the ID and then the quantity in numeric format.
c_name - The value of this parameter should contain the name of the product to be created. (128 characters max)
c_description - The value of this parameter should contain a short description of the product to be sold. (255 characters max)
c_price - The price of your product. Please note that in order to prevent a discrepancy between the total parameter and the sum of the product identification c_price parameters which may confuse the customer, the product price will not be displayed on the purchase page. (8 characters, decimal, 2 characters: Example: 99999999.99)
You can use these identification parameters to pass in multiple products as well. To do so you will need to append a digit to each parameter. For example, c_prod_1, c_name_1, c_description_1, c_price_1 will describe the first product, then to describe the second product you would use a 2 so the parameters will read c_prod_2, c_name_2 and so on.
Additional Parameters:
demo - Y to enable demo mode. Do not pass for live sales. Can also be controlled within the account.
lang - “sp” for Spanish purchase routine pages, defaults to English if this is absent, but “en” may be used for English as well.
merchant_order_id - Specify your order number with this parameter. It will also be included in the confirmation emails to yourself and the customer. (50 characters max)
pay_method - CC for Credit Card, CK for check, PPI for PayPal, PPL for PayPal Pay Later, or FXS for FXSource. This will set the default selection on the payment method step during the checkout process.
skip_landing - If set to 1 it will skip the order review page of the purchase routine.
x_Receipt_Link_URL - Used to specify an approved URL on-the-fly, but is limited to the same domain that is used for your 2Checkout account, otherwise it will fail. This parameter will over-ride any URL set on the Look and Feel page. (no limit)
To pre populate the billing information page you may pass in:
card_holder_name - Card holder’s name (128 characters max)
The card holder’s name can also be populated using the first_name, middle_initial, and last_name parameters. IMPORTANT: If you use these three parameters, the data will be combined into and returned as card_holder_name to your Approved URL script.
street_address - Card holder’s street address(64 characters max)
street_address2 - The second line for the street address, typically suburb or apartment number information (64 characters max)
city - Card holder’s city (64 characters max)
state - Card holder’s state (64 characters max)
zip - Card holder’s zip (16 characters max)
country - Card holder’s country (64 characters max)
email - Card holder’s email (64 characters max)
phone - Card holder’s phone (16 characters max)
phone_extension - Card holder’s phone extension (9 characters max)
To pre populate the shipping information page you may pass in:
ship_name
ship_street_address
ship_street_address2
ship_city
ship_state
ship_zip
ship_country
Please note that shipping information will only be collected for items that are defined as tangible in our system. Shipping is also only charged for tangible items. We will ask for shipping information if you pass in any of the shipping parameters, regardless of whether the item is tangible or not. This does not mean we will apply shipping charges to the sale, but their information will be collected.
The billing information page will also be populated with the information from the shipping page if the shipping information is collected on that sale and the billing information is not passed in.
Custom Parameters:
You may pass in any additional parameters that you may need and they will be returned to you at the end of the sale. The only restrictions on custom parameters are that they can not share the name of ANY parameter that our system uses, even from the other sets. Please note that you WILL need a return script set up on the Look and Feel page to receive any of these parameters back as they are not included in the confirmation emails.
You can receive back all of the parameters that were passed in as well as the following parameters:
order_number - 2Checkout.com order number
cart_order_id - Your cart ID number passed in.
credit_card_processed - Y if successful (Approved), K if waiting for approval (Pending)
key - the MD5 hash used to verify that the sale came from one of our servers
Consult the documentation that came with your cart or contact the cart manufacturer for assistance with setting this up or to determine what URL you should enter on the Look and Feel page for your cart to receive the product information.
Recurring billing can not be done with this parameter set. You must use the Plug-N-Play parameter set and have the products defined within the 2CO database for recurring billing.
Important: You can not mix the three parameter sets. This will cause problems during payment or may prevent the payment pages from working at all.
Important Note: When you are testing parameters, please be certain to clear the cookies in your browser between tests to ensure the changes you have made are applied. For more information on clearing the cookies please click here.
Related Article: Country Codes
6 Comments »
+0
-0
How are first_name, middle_initial, and last_name parameters combined into card_holder_name? Are they just concatenated or are they separated with space, underscore or any other character?
Thank you.
+0
-0
The parameters are combined with a space. For example:
first_name=”first”
middle_initial=”m”
last_name=”last”
These 3 parameters would be combined into:
card_holder_name=”first m last”
+0
-0
credit_card_processed - Y if successful (Approved), K if waiting for approval (Pending)
1) What about other return states?
like canceled by user or error?
2) If it’s pending, how do I query the state until I get a final result, that I can display on my web site?
+0
-0
This parameter will always equal Y unless an online check was used. In that case the parameter would equal K. We will only send the customer back to your site if the credit card can be successfully authorized. If the card is declined the customer will stay on the 2Checkout page and see the error and have the option to attempt to authorize another credit card. If the customer cancels the transaction and closes the browser then no parameter will be posted back to your site.
If you wish to be notified of the status of a sale, for example the pending online check moving to a deposited status you can use our INS system. Documentation on the INS system can be found here. The message that deals with the status of an invoice changing will be the message you will want to use if your interested in being notified of the pending echeck moving to deposited.
+0
-0
And how do I find out, which amount was paid?
It is possible on the payment site to remove items or the whole payment. So this may or may not be identical to the amount I sent in?
+0
-0
The total amount paid will be passed back to you as the “total” parameter. Keep in mind with this parameter set the total is based only off this parameter so your customers will not have the option to remove or edit the quantity of items on the 2Checkout page. Unless your customer manually edits the HTML POST or GET parameters this amount will always match what you sent in.
If you’re concerned someone may edit the total, in attempts to get your product without paying full price for it, you can implement the MD5 hash on your site. More information on this here. This hash is calculated using the total so if you store the total on your site before passing the customer to our purchase pages, you can calculate the hash and compare it with what we calculated. If they do not match then your system will know that the customer edited the total.