Shopping Cart Buttons
The buttons are implmented as standard HTML POST forms. The fields available are documented below.
|cmd||This should always be set to '_cart_add'.||Yes||N/A|
|reset||This tells the server to delete any cached cart data for the user.
Unless you can make sure reset is only set for the first item you add to the cart in general you don't want to set it.
|merchant||Your merchant ID (you can find this on the My Account page).||Yes||N/A|
|cart_name||The name of your shopping cart.||Yes||128|
|currency||The currency of the items in the cart (BTC, LTC, USD, EUR, etc.).
Values supported: Any crypto or fiat currency on the Supported Coins page.
Note we in no way process any fiat currencies, they are simply convenience values so you don't have to convert to BTC or another coin yourself.
|invoice||This is a passthru variable for your own use. [not visible to buyer]||No||128|
|custom||This is a 2nd passthru variable for your own use. [not visible to buyer]||No||128|
|want_shipping||1 = Want buyer's shipping information (default).
0 = Don't want buyer's shipping information.
|cart_shippingf||A fixed shipping cost to charge (in addition to any shipping charged on a per-item basis).||No||N/A|
|cart_taxf||A tax cost to charge (in addition to any tax charged on a per-item basis).||No||N/A|
|allow_quantity||0 = Don't allow buyer to adjust quantity (default).
1 = Allow buyer to adjust quantity.
|allow_amount||0 = Don't allow buyer to adjust item price (default).
1 = Allow buyer to adjust item price.
|allow_currency||0 = Don't allow buyer to adjust source currency (default).
1 = Allow buyer to adjust source currency. (requires allow_amount = 1 and minamountf = 0 or not set)
|allow_currencies||Currency codes separated with a comma of coins you will accept. This is used to further restrict the coin selection from your list of enabled coins; for example if you are doing your own exchange rates and want to limit checkout to a user selected currency.
|allow_ship_countries||ISO 3166 2 digit country codes separated with a comma of countries you will ship to. The will deny transactions if the shipping address is not in one of these countries.
|Item/Payment Description Fields|
|amountf||The amount (in the currency chosen) of the item.||Yes||N/A|
|item_name||The name of the item to add to the cart.||Yes||128|
|item_number||This is a passthru variable for your own use. [visible to buyer]||No||128|
|quantity||Lets you set a quantity of items. The purchase price will be quantity*amount from above.
Note: Must be 1 or higher, decimals are supported and will be rounded to 8 digits.
|minamountf||Sets a minimum amountf (mainly for when allow_amount = 1). Does not work with allow_currency = 1||No||N/A|
|on1||1st option name. This lets you pass through a buyer option like size or color.||No
(unless ov1 set)
|ov1||1st option value. This would be the buyer's selection such as small, large, red, white.||No||128|
|on2||2nd option name. This lets you pass through a buyer option like size or color.||No
(unless ov2 set)
|ov2||2nd option value. This would be the buyer's selection such as small, large, red, white.||No||128|
|shippingf||Cost of shipping the item.
Shipping cost is shippingf*quantity (unless shipping2 is set)
|shipping2f||Cost of shipping each additional item.
Shipping cost is shippingf+((quantity-1)*shipping2f)
|taxf||Any tax to charge.||No||N/A|
|ipn_url||Sets an IPN URL.
If not set or blank defaults to the IPN URL in your settings.
|return_url||Sets a URL to go to after adding an item to the cart instead of going to the cart/checkout page.||No||255|
|success_url||Sets a URL to go to if the buyer completes checkout.||No||255|
|cancel_url||Sets a URL to go to continue shopping at your store.||No||255|
|allow_extra||If set to 1 will have a field where the buyer can leave you a note or extra information such as shipping address, size, or color.||No||1|
|lang||Automatically set the checkout language to this language code. For a list of supported codes check this page.||No||16|
|cstyle||Sets a coin selection style for the checkout page. (default: grid1)||No||32|
These fields can be used to pre-populate forms with any information you already know about your buyer.
|first_name||Buyer's first name.||No||32|
|last_name||Buyer's last name.||No||32|
|Buyer's email address.||No||128|
|address1||Street / address line 1||No||128|
|address2||Street / address line 2||No||128|
|state||State / Province||No||64|
|zip||Zip / Postal Code||No||32|
|country||Country of Residence
This uses 2 digit ISO 3166 country codes.
|Feel free to check out our example buttons.|