Knowledge Base - 2Checkout - What parameters does 2Checkout support?

What parameters does 2Checkout support?


Below you will find a listing of the supported 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 specific.

Checkout URL:

Required Parameters:
x_login – Your numerical 2Checkout 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 maximum)

Product Identification Parameters:
Sites using this parameter set must pass in parameters to identify what is being sold during the purchase. These parameters will also be beneficial as when used correctly, the product information will be displayed to customers on the purchase pages and will be listed on the 2Checkout 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 the product being purchased can be 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 maximum)
c_description – The value of this parameter should contain a short description of the product to be sold. (255 characters maximum)
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.
currency_code – AED, ARS, AUD, BRL, CAD, CHF, DKK, EUR, GBP, HKD, ILS, INR, JPY, LTL, MXN, MYR, NOK, NZD, PHP, RON, RUB, SEK, SGD, TRY, USD, ZAR. Use to specify the currency for the sale.
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 maximum)
pay_method – CC for Credit Card, CK for check, PPI for PayPal. This will set the default selection on the payment method step during the checkout process.
purchase_step – Sets the purchase step that the buyer will land on when being directed to the checkout page. Possible values are ‘review-cart’, ‘shipping-information’, ‘shipping-method’, ‘billing-information’ and ‘payment-method’. Please Note: To skip a purchase step, all required fields must be pre-populated with the parameters that are passed in with the sale. If a required field is not pre-populated, the buyer will revert back to the step that needs to be completed.
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 Site Management page. (no limit)
coupon – Specify a 2Checkout created coupon code. If applicable, the coupon will be automatically applied to the sale.

To populate the billing information page you may pass in
x_First_Name – buyers first name (64 characters maximum)
x_Last_Name – buyers last name (64 characters maximum)
x_Phone – buyers phone number (16 characters maximum)
x_Email - buyers email address (64 characters maximum)
x_Address – buyers address (64 characters maximum)
x_City – buyers city (64 characters maximum)
x_State – buyers state (64 characters maximum)
x_Zip – buyers zip code (16 characters maximum)
x_Country – buyers country (64 characters maximum)

To populate the shipping information page you may pass in

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, 2Checkout only requires the three listed under the required section. We will therefore not pass back 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 2Checkout 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 cannot 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 Site Management 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 2Checkout server.
x_trans_id – the 2Checkout 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 Site Management 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 Site Management page for your cart to receive the product information.

Recurring billing cannot be done with this parameter set. You must use the Pass-Through-Products parameter set to dynamically pass in recurring line items. You can also use the Plug and Play parameter set and have the recurring products defined within your 2Checkout account.

Important: You cannot mix 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.

Was this article helpful?

Your feedback helps us improve our site.


Please tell us how we can make this article more useful.

Characters Remaining: 255