What are the parameters for 2CO’s Plug and Play cart?

Below are the parameters supported by the Plug and Play Cart. These parameters can only be used if you have added your products to the 2CO database. You are using the Plug and Play cart if you are passing in the three parameters listed under the Required section below. If you would like to test your integration of these parameters, try using our developers.2Checkout area.

Multi-page Payment Routine:
https://www.2checkout.com/checkout/purchase
Supports all payment methods. Supports tangible and intangible products/services.

Single Page Payment Routine:
https://www.2checkout.com/checkout/spurchase
Credit card-only payment routine only available for intangible products/services.

Required Parameters:
sid – Your 2Checkout vendor account number. (64 characters max)
product_id – The 2CO ID for the product or service in your 2Checkout account.
quantity – The quantity of the product. (99 max value)

Additional Parameters:
demo – Y to enable demo mode, do not pass this in for live sales
fixed – Y to remove the Continue Shopping button and lock the quantity fields
lang – Chinese – zh, Danish – da, Dutch – nl, French – fr, German – gr, Greek – el, Italian – it, Japanese – jp, Norwegian – no, Portuguese – pt, Slovenian – sl, Spanish – es_ib, Spanish – es_la, Swedish – sv, defaults to English if this is absent, but en may be used for English as well.
return_url – Used to control where the Continue Shopping button will send the customer when clicked. (255 characters max)
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, AL for Acculynk PIN-debit, PPI for PayPal, or PPL for PayPal Pay Later. 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. If there are options on the products it will cause an error and redirect the customer back to the order review page.
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. (no limit):

  • This parameter will over-ride any URL set on the Look and Feel page.
  • If Direct Return is disabled: If only one product is ordered, it will over-ride the return URLs on the product as well. If more than one product is ordered, then this parameter will control where the “Click Here to Notify [Your Company]” button on the final page takes the customer, but the return URLs on the products will be listed as links below the button, next to the description of the product.
  • If Direct Return is enabled : If one product is ordered, this parameter will NOT over-ride the return URLs on the products. If more than one product is ordered, then this parameter will over-ride the product return URLs. Also keep in mind that many third party shopping carts recommend that Direct Return be disabled to work properly.

To 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 address (64 characters max)
phone – Card holder’s phone number (16 characters max)
phone_extension – Card holder’s phone extension (9 characters max)

To 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.

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.

Passing Multiple Plug and Play Products:
You may also pass multiple plug and play products in one form. To do this add a corresponding digit to the quantity and product_id parameters to group them for each product. For example, if we wanted to pass two products into the system we would be passing in first the sid parameter, then product_id1 and quantity1, and then product_id2 and quantity2.

Example:

<form action='https://www.2checkout.com/checkout/purchase' method='post'>
<input type='hidden' name='sid' value='123' >
<input type='hidden' name='quantity1' value='1' >
<input type='hidden' name='product_id1' value='1008' />
<input type='hidden' name='quantity2' value='1' >
<input type='hidden' name='product_id2' value='1014' >
<input type='hidden' name='quantity3' value='1' >
<input type='hidden' name='product_id3' value='1011' >
<input name="submit" type='submit' value='Buy from 2CO' >
</form>

You can receive back all of the parameters that were passed in as well as the following parameters:
order_number – 2Checkout.com order number
total – the total amount of the purchase
ship_method – the shipping method that was selected for this order (if applicable)
credit_card_processed – Y if successful (Approved).
merchant_product_id – your product ID for purchased item
key – the MD5 hash that can be used to verify that the sale came from one of our servers

Also note that this is the only parameter set that can be used for recurring billing with our service.

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

What are 2Checkout.com’s own parameters?

2CO has our own proprietary set of parameters that you can use if your cart supports them. If you would like to test your integration of these parameters, try using our developers.2Checkout area.

Multi-page Payment Routine:
https://www.2checkout.com/checkout/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 – Chinese – zh, Danish – da, Dutch – nl, French – fr, German – gr, Greek – el, Italian – it, Japanese – jp, Norwegian – no, Portuguese – pt, Slovenian – sl, Spanish – es_ib, Spanish – es_la, Swedish – sv, 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, AL for Acculynk PIN-debit, PPI for PayPal, or PPL for PayPal Pay Later. 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.

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).
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

What Authorize.net parameters does 2CO support?

Below you will find a listing of the supported Authorize.net-compatible parameters and what information each parameter should contain. This parameter set is used by third party carts and custom designed scripts. Please note that 2Checkout must know what is being sold in every sale. There are parameters available that allow for dynamic product creation. These will be discussed as well, and must be used if you are using this parameter set, but they are not Authorize.Net specific. If you would like to test your integration of these parameters, try using our developers.2Checkout area.

Multi-page Payment Routine:
https://www.2checkout.com/checkout/purchase
Supports all payment methods. Supports tangible and intangible products/services.

Single Page Payment Routine:
https://www.2checkout.com/checkout/spurchase
Credit card-only payment routine only available for intangible products/services.

Required Parameters:
x_login – Your numerical 2checkout vendor account number.
x_amount – The total amount to be billed, without a currency symbol, and only two decimal places if used (8 characters, decimal, 2 characters: Example: 99999999.99)
x_invoice_num – A unique order id from your system. (64 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 this in for live sales. Can also be controlled within the account.
lang – Chinese – zh, Danish – da, Dutch – nl, French – fr, German – gr, Greek – el, Italian – it, Japanese – jp, Norwegian – no, Portuguese – pt, Slovenian – sl, Spanish – es_ib, Spanish – es_la, Swedish – sv, 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, AL for Acculynk PIN-debit, PPI for PayPal, or PPL for PayPal Pay Later. 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 populate the billing information page you may pass in:
x_First_Name – buyers first name (64 characters max)
x_Last_Name – buyers last name (64 characters max)
x_Phone – buyers phone number (16 characters max)
x_Email - buyers email address (64 characters max)
x_Address – buyers address (64 characters max)
x_City – buyers city (64 characters max)
x_State – buyers state (64 characters max)
x_Zip – buyers zip code (16 characters max)
x_Country – buyers country (64 characters max)

To populate the shipping information page you may pass in:
x_Ship_To_First_Name
x_Ship_To_Last_Name
x_Ship_To_Address
x_Ship_To_City
x_Ship_To_Country
x_Ship_To_State
x_Ship_To_Zip

Please note that since this parameter set is for third party shopping carts, we do not collect shipping information for these types of orders. This is because your cart is responsible for calculating the shipping and it is passed in as part of the x_amount parameter.

It is also important to note that when using the Authorize.Net set of parameters, 2CO only requires the three listed under the required section. We will therefore not passback strictly Authorize.Net style parameters for everything unless they are passed in to us. This is not often a problem as most carts do this anyways. For example, x_First_Name and x_Last_Name will prepopulate the billing name, but 2CO uses card_holder_name for this. card_holder_name will then be returned unless x_First_Name and x_Last_Name are passed into 2Checkout.

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.

Return Parameters:
You can receive back all of the parameters that were passed in as well as the following parameters:
x_2checked – Y if card was successfully processed.
x_MD5_Hash – The MD5 hash that can be used to verify that the sale came from a 2CO server.
x_trans_id – the 2CO order number for the order.

Using this parameter set, we are not receiving any product information. As you can see, you are only passing in a total amount to us. Usually, the cart will have some means of using the x_invoice_num to determine what was purchased after the sale. A return URL will need to be set up on the Look and Feel page for the cart to correctly determine this.

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

Can I specify the return URL ‘on the fly’?

Yes, this is possible. You may pass in a parameter called x_receipt_link_url to control where the customer is returned to on a per-sale basis. Keep in mind that this parameter will over-ride any return URL set on the Look and Feel page of your account, but it will not over-ride any return URLs that are set up on the product itself if there are any. Using this method, you could create a special button or link that would return the customer to a different page on your site than is set up on the Look and Feel page. This is useful for ‘promotional’ type sites as you can avoid having to make any configuration changes to your actual account.

If you are using buttons on your site to sell your goods through 2Checkout, you would add a single line to the button such as this:

<input type=”hidden” name=”x_receipt_link_url” value=”http://www.your-site.com/return.php”>

This must go between the opening and closing FORM tag that you see when you view your existing code.

If you are using links to sell your goods through 2Checkout, then you would add this parameter to your links to specify the return url, such as this:

&x_receipt_link_url=http://www.your-site.com/return.php

Notice that in both of the above examples, the FULL path is used for the value of this.

Important Note: For security reasons, the domain on your account and the domain that hosts the pass back page must match exactly for this to work correctly. For example, if you have http://www.your-site.com specified on your account, you could pass back to http://www.your-site.com/pages/pass.php but not to http://www.your-other-site.com/pages/pass.php.

Why do I get an HTTP Error 500 (Internal Server Error) on Passback?

An HTTP Error 500 (Internal Server Error) indicates that there is a problem inside of your script or the servers configuration. This error is most likely caused by a typo in the code or an invalid or illegal use of a function within the script. For the pass back to function correctly, then your script must be correctly set up.

HTTP errors are not generated specifically by 2Checkout. They are a part of the HTTP protocol and are common amongst all web servers. It is therefore beyond the realm of 2Checkout’s support to provide you with specific instructions for making these changes as every server is set up differently and 2CO does not provide server administration services as part of our support plan.

For assistance with debugging your scripts, we suggest that you contact your server’s administrator, webmaster, or hosting provider’s technical support staff. Due to the nature of this particular error, you may also be able to receive assistance from other suppliers of ours. The 500 error message is often due to a coding error in the script, so some of our other suppliers in our tech support forum may be able to help you find the mistake.

We have observed that this error is experienced in certain web browsers more than in others, in particular within Internet Explorer. If your return page or script does not output at least 530 characters, this can potentially cause a MIME header error. Mozilla based browsers such as Firefox seem to be able to handle these pages and will display either the real error or the small output when Internet Explorer has problems. Since this issue is an issue with the browser software itself, there is little 2Checkout can do to control this. If you are receiving this error, please try to increase the output that your return page generates to more than 530 characters or try a different web browser to see if you observe different results. Note that this is not a solution for all HTTP 500 error messages, but it is meant to be a useful step in debugging your script and has been reported as a successful step by some of our other suppliers.

Why do I get an HTTP Error 404 (File Not Found) on Passback?

An HTTP 404 File Not Found error indicates that the URL specified as for your script is incorrect. For the pass back to function, 2CO must be able to locate and access the script and post the variables to it.

HTTP errors are not generated specifically by 2Checkout. They are a part of the HTTP protocol and are common amongst all web servers. It is therefore beyond the realm of 2Checkouts support to provide you with specific instructions for making these changes as every server is set up differently and 2CO does not provide server administration services as part of our support plan.

To correct this issue, follow these steps:

  1. Login to your account.
  2. Under the ‘Helpful Links’ section, click on ‘Settings’ near the ‘Look and
    Feel’ section.
  3. Check the URL that is currently entered there and correct any mistakes that
    it may contain.
  4. Click ‘Save Changes’.

Why do I get an HTTP Error 403 (Forbidden) on Passback?

An HTTP 403 Forbidden error indicates that due the set up of your script and/or server, the viewer does not have permission to view this page. For the pass back to function, 2CO must be able to access the script and post the variables to it.

HTTP errors are not generated specifically by 2Checkout. They are a part of the HTTP protocol and are common amongst all web servers. It is therefore beyond the realm of 2Checkouts support to provide you with specific instructions for making these changes as every server is set up differently and 2CO does not provide server administration services as part of our support plan.

To test and see if your file is working correctly:

  1. Open your web browser.
  2. Type in the full URL to your script or return page (including the http://www. part) and press enter.
  3. If you receive the message again, the problem is in your script and/or on your server. Note that the exact wording of the error message may vary slightly depending on your browser and your server. But if you see something about ‘forbidden’ or ‘error 403′ then the information above pertains to your situation.

Do you offer payment forms in Spanish?

2Checkout offers both of our purchase routine in both Latin and European Spanish as well as 13 other languages.

To access the Spanish versions of our purchase routine your customer can either select their preferred language at the top of the purchase routine page or you may pass“lang=es_la” for Latin Spanish or “lang=es_ib” for European Spanish with the sale parameters. (The previous Spanish parameter “lang=sp” will still direct to the Latin Spanish routine for the time being.)

Example purchase link using the “lang” parameter:

https://www.2checkout.com/checkout/purchase?sid=XXXXXX&quantity=1&product_id=4&lang=es_la

Example purchase button using the “lang” parameter:

<form action='https://www.2checkout.com/checkout/purchase' method='post'><input type='hidden' name='sid' value='XXXXXX'><input type='hidden' name='product_id' value='1'><input type='hidden' name='quantity' value='1'>
<input type='hidden' name='demo' value='Y'>
<input type='hidden' name='lang' value='es_la'>
<input type='submit' name='Buy from 2CO'>
</form>

Please note that you must insert your own Seller ID number to use the above examples. They will not work as is.

Related articles:
Do you offer any languages other than English?
TUTORIAL: Creating 2Checkout Purchase Links

Can I have Credit Card logos on my Site or Cart?

If you are going to use a picture of a credit card or a credit card company logo on your web site, it must be clearly and immediately adjacent to the phrase “2Checkout.com is an authorized retailer for (your business name.)” Per Credit Card Association Rules, unless your company has a direct business relationship with the credit card company and is authorized to display the credit card or the logo, the image must be removed from your web site.

Credit card association rules state that only a merchant account holder may display credit card logos on their websites. 2CO does not provide you with a merchant account. You can continue to display these logos, as long as immediately above, beside, or below the logos, there is a clear statement that 2CO is your authorized retailer.

Alternatively, you can display the logos shown here. Right click on the image of your choice below and choose “Save Picture as…” to save as a file on your computer.

2Checkout.com

2Checkout.com

2Checkout.com

Please also see 2CO Certified for “2CO Certified Seller” buttons.

Can I have more than one passback URL?

It is possible to use multiple pass back URLs, or return URLs, with our system. If you are using our free Plug and Play shopping cart, then you simply need to add the URLs to the products themselves to achieve this. You may specify the Approved and Pending* URLs on each individual product that you have created in our system. These URLs will over-ride any URL set on the Site Managment page. We will then use this URL to return the customer to when it is purchased.

Having multiple return URLs can conflict with the Direct Return feature that we have available. This feature will make the customer skip the ‘Sale Processed’ and go directly from the Billing Information page of the checkout process to your return URL. We can only return the customer to one page at a time, so when multiple products are purchased that have different return URLs, the Direct Return feature is disabled for that sale. The customer will then be presented with a list of the products or services they purchased along with their respective return URLs to click. There is a parameter available to lock our cart into only allowing the purchase of one product at a time, and this parameters name is ‘fixed’. You may pass this in with the value of a capital ‘Y’ to lock the quantity fields. More information on Direct Return and the parameters that we accept can be found elsewhere in the Knowledge Base. Please do a search for ‘Direct Return’ or ‘parameters’ if you would like to read this information.

If you are using a third party or customer cart or script, then multiple return URLs may still be used, but the implementation of this would have to be on your end as the product information in the 2CO database is not used. If you are not passing in product_id parameters, then you are not using the Plug and Play cart of ours. To achieve multiple return URLs with a customer cart or third party cart, you may use the x_receipt_link_url parameter to control where the customer is returned to. The value of this parameter MUST match the domain that is listed on your 2Checkout.com account for security reasons. You would then need to design your cart or script to pass this parameter into our system along with the appropriate value for that sale.

*The Pending URL field is no longer used and may be left blank as 2Checkout no longer accepts e-checks as a payment method.

Page 50 of 65« First...«4849505152»...Last »

Recent Posts from the Community:

Get Payments

posted by: dspzaman

Referring URL

posted by: hipdev

SPP suggestion

posted by: brakkar

API Beta

posted by: cliff

session destroy

posted by: rojan
More from the community »

Spotlight Supplier

Spotlight Supplier

Feng Shui Products


Popular Tags