CyoGate Payment Gateway API: QuickClick Button Generator Variables

Variables
QuickClick

All Buttons

Name	Value: Description
action	show_cart: Displays the customer's shopping cart.
	process_cart: Adds one or more products to the customer's cart.
	process_variable: This processes a variable amount transaction. During the checkout process, the cardholder is given the ability to specify the amount. This is useful for donations.
	process_fixed: This processes a fixed amount, single item transaction. This is basically a "Buy Now" type transaction. The customer is not able to specify an amount during checkout.
username	Specifies a merchant username. Either this or a key_id is required. Using a key_id method is the preferred.
key_id	Specifies a development key id. Either this or username is required, this method is preferred.
hash	The hash field is used to pass a verification hash. By using a verification hash, you can ensure that no one will be able to pass an unauthorized price, SKU, shipping price, or tax information.
product_taxable_#	Controls whether the product will be affected by the tax rates configured in your QuickClick tax options. Set this to '0' or 'false' to ensure that a customer doesn't get charged taxes on a product/service. The default is true.'
order_description	Specifies a description for the product.
currency	Applies to USD and CAD currencies only. The currency is included with the hash, so it will need to be hashed outside of the button generator, or hashing will need to be turned off.
language	Specifies the language to be used for the cart and checkout webpages. Current valid values are 'en' for English and 'en' for Spanish.
url_finish	Specifies a page that the customer should be sent to after finishing their order. This page will receive several pieces of information concerning the completed order. If you have some programming knowledge, you can have your page process and store this information. The information can be useful for order fulfillment, amongst other things.
return_link	Used in place of url_finish in order to skip the QuickClick receipt page. Value should be the url to your own receipt/thank you page.
return_method	Used to skip the QuickClick receipt page. Value should equal "redirect"
profile	Specify the profile the button should use.
customer_receipt	Specifies whether to email the customer a receipt after their transaction is complete. If multiple customer email receipts exist, the name of the desired receipt can be passed as the value, otherwise 'true' should be passed.
merchant_receipt_email	Specifies a list of email addresses to send merchant receipts to. Our system will send merchant receipts to all of the specified recipients in addition to any users that are configured to receive transaction receipts in the Merchant Control Panel. If there are multiple recipients, separate them with a comma. You can also set this to 'false' if you do not want any merchant receipts to be send.
merchant_defined_field_#	A merchant defined field can be used to pass any type of information you'd like. For example, if you wish the user to specify their mother's maiden name, you could use a merchant defined field. This information shows up in reports and customer/merchant receipts. The # can be any number 1-20. Descriptions for the merchant defined fields can be set within the Merchant Control Panel's 'Gateway Options'.
shipping_same	Indicates whether the shipping information is the same as the billing information. The default setting is 1 (true). Set this to 0 to always ask the customer for separate shipping information. If you plan on passing other shipping_ parameters (i.e. shipping_first_name), ensure that you set this to 0. For additional options regarding the Shipping Address, examine the QuickClick Customer Information Options in your Merchant Control Panel.
first_name	The customer's first name.
last_name	The customer's last name.
address_1	The first part of the customer's street address.
address_2	The second part of the customer's street address.
city	The customer's city.
company	A company name.
postal_code	The customer's postal (zip) code.
state	If they're in the US, this should be the customer's 2 letter state code. Otherwise, this can be used to pass a province or region.
country	The customer's 2 letter country code.
phone	The customer's phone number.
fax	The customer's fax number.
website	The customer's website address.
email	The customer's email address.
shipping_first_name	The receiver's first name.
shipping_last_name	The receiver's last name.
shipping_address_1	The first part of the receiver's street address.
shipping_address_2	The second part of the receiver's street address.
shipping_city	The receiver's city.
shipping_company	A receiving company name.
shipping_postal_code	The receiver's postal (zip) code.
shipping_state	If they're in the US, this should be the receiver's 2 letter state code. Otherwise, this can be used to pass a province or region.
shipping_country	The receiver's 2 letter country code.
shipping_email	The receiver's email address.

Fixed/Donation Buttons Only

amount

Specifies the amount, in US dollars. This is used only for fixed and variable price buttons.

Shopping Cart Buttons Only

product_description_#

Specifies a description for the given product.

product_sku_#

Specifies a SKU for a given product to uniquely identify it.

product_quantity_#

Specifies the quantity for a given product number. If this parameter isn't passed, '1' is assumed.

product_amount_#

Specifies the amount, in US dollars, for the given product.

product_option_#_#

Product options can allow your customers to make some additional choices before adding a product to their cart. For example, if you're selling a T-Shirt, you may want to allow the customer to define a size (Small, Medium, or Large) before adding the product to their cart. Up to 3 product options can be defined for a single product. The first number field is the product option number, and the last number field is the product number. For product #1, the product option field names would follow this form:

product_option_1_1 (option #1, product #1)
product_option_2_1 (option #2, product #1)
product_option_3_1 (option #3, product #1)

Ultimately, any option values passed in are appended to the product description. This can be very useful when fulfilling orders. If your T-Shirt was defined to have a color option and a size option, the resulting description might look like this:

T-Shirt (Red) (Large) The value can be anything you want, and you can utilize any form elements to pass it in (i.e. text, a dropdown, or radio buttons). Also note that our Button Creator is able to generate buttons with product options.

product_option_values_#_#

The product_option_values field can be used for two main purposes:

Unless the product_option_values field is used, a customer would technically be able to pass any option values they want. For most merchants, this is not of great concern, but if this is a concern for you, the product_option_values field can be used to restrict which options can be passed in. Setting a product_option_values field to "Red|Green", for example, would only allow Red or Green to be passed in as options for a particular product. In this case, passing anything else would generate an error.
The product_option_values field can also be used to create an option that increases the price of an item. For example, a large T-Shirt may cost slightly more than a smaller T-Shirt. Setting a product_option_values field to "Small|Medium:1.00|Large:2.00" would ensure that medium shirts would be charged $1.00 more than the product's amount, large shirts would be charged $2.00 more than the product's amount, and that small shirts would not be charged extra at all.

The product_option_values field's naming convention is very similar to that of the product_option field.

The first number field is the product option number, and the last number field is the product number. For product #1, the product option field names would follow this form:

product_option_values_1_1 (option #1, product #1)
product_option_values_2_1 (option #2, product #1)
product_option_values_3_1 (option #3, product #1)

product_shipping_#

Specifies a set of shipping overrides for a particular product. This field allows you override shipping prices on a per-product and per-country basis. The shipping parameter overrides any settings configured in the Merchant Control Panel QuickClick Options.

Examples
fixed\|10.00	Charge $10.00 per item for shipping.
fixed\|10.00\|5.00	Charge $10.00 for the first item, and $5.00 for each additional item.
fixed\|10.00\|5.00\|country:CA\|15.00\|10.00	When shipped within Canada, charge $15.00 for the first item, and $10.00 for each additional item. When shipped elsewhere, charge $10.00 for the first item, and $5.00 for each additional item.

url_continue

Specifies a page that the customer should be sent to when they wish to continue shopping. This only applies to shopping cart buttons.

url_cancel

Specifies a page that the customer should be sent to after they cancel their order. This only applies to shopping cart buttons.

checkout

When set to true, the shopping cart page is skipped and the customer is sent immediately to the customer information screen or directly to checkout. This is useful if you need to pass SKUs, but still want a 'Buy Now' feel to the checkout process.

Apply for a Merchant Account Signup for the Payment Gateway