| Field Name | |
|---|---|
| Main Fields | |
| cmd | |
| Description | This should always be set to '_pay'. |
| Required? | Yes |
| Length Limit | N/A |
| reset | |
| Description | This tells the server to delete any cached button data for the user. Set the value to 1 |
| Required? | Yes |
| Length Limit | 1 |
| merchant | |
| Description | Your merchant ID (you can find this on the My Account page). |
| Required? | Yes |
| Length Limit | N/A |
| Item/Payment Description Fields | |
| currency | |
| Description | The currency of the payment (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. |
| Required? | Yes |
| Length Limit | 3 |
| amountf | |
| Description | The amount (in the currency chosen) of the payment. |
| Required? | Yes |
| Length Limit | N/A |
| item_name | |
| Description | The name of the item being purchased. |
| Required? | Yes |
| Length Limit | 128 |
| item_number | |
| Description | This is a passthru variable for your own use. [visible to buyer] |
| Required? | No |
| Length Limit | 128 |
| invoice | |
| Description | This is a passthru variable for your own use. [not visible to buyer] |
| Required? | No |
| Length Limit | 128 |
| custom | |
| Description | This is a 2nd passthru variable for your own use. [not visible to buyer] |
| Required? | No |
| Length Limit | 128 |
| quantity | |
| Description | Lets you set a quantity of items. The purchase price will be quantity*amount from above. Note: Must be 1 or higher, decimals are not supported. |
| Required? | No |
| Length Limit | N/A |
| allow_quantity | |
| Description | 0 = Don't allow buyer to adjust quantity (default). 1 = Allow buyer to adjust quantity. |
| Required? | No |
| Length Limit | 1 |
| max_quantity | |
| Description | Sets a maximum quantity the buyer can select. 0 = No maximum (default). |
| Required? | No |
| Length Limit | N/A |
| allow_amount | |
| Description | 0 = Don't allow buyer to adjust item price (default). 1 = Allow buyer to adjust item price. |
| Required? | No |
| Length Limit | 1 |
| allow_currency | |
| Description | 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) |
| Required? | No |
| Length Limit | 1 |
| allow_currencies | |
| Description | 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. Example: BTC,LTC |
| Required? | No |
| Length Limit | 255 |
| minamountf | |
| Description | Sets a minimum amountf (mainly for when allow_amount = 1). Does not work with allow_currency = 1 |
| Required? | No |
| Length Limit | N/A |
| on1 | |
| Description | 1st option name. This lets you pass through a buyer option like size or color. |
| Required? | No (unless ov1 set) |
| Length Limit | 128 |
| ov1 | |
| Description | 1st option value. This would be the buyer's selection such as small, large, red, white. |
| Required? | No |
| Length Limit | 128 |
| on2 | |
| Description | 2nd option name. This lets you pass through a buyer option like size or color. |
| Required? | No (unless ov2 set) |
| Length Limit | 128 |
| ov2 | |
| Description | 2nd option value. This would be the buyer's selection such as small, large, red, white. |
| Required? | No |
| Length Limit | 128 |
| Shipping Fields | |
| want_shipping | |
| Description | 1 = Want buyer's shipping information (default). 0 = Don't want buyer's shipping information. |
| Required? | No |
| Length Limit | 1 |
| shippingf | |
| Description | Cost of shipping the item. Shipping cost is shippingf*quantity (unless shipping2 is set) |
| Required? | No |
| Length Limit | N/A |
| shipping2f | |
| Description | Cost of shipping each additional item. Shipping cost is shippingf+((quantity-1)*shipping2f) |
| Required? | No |
| Length Limit | N/A |
| taxf | |
| Description | Any tax to charge. |
| Required? | No |
| Length Limit | N/A |
| allow_ship_countries | |
| Description | 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. Example: US,CA,GB |
| Required? | No |
| Length Limit | 255 |
| Miscellaneous Fields | |
| ipn_url | |
| Description | Sets an IPN URL. If not set or blank defaults to the IPN URL in your settings. |
| Required? | No |
| Length Limit | 255 |
| success_url | |
| Description | Sets a URL to go to if the buyer does complete checkout. |
| Required? | No |
| Length Limit | 255 |
| cancel_url | |
| Description | Sets a URL to go to if the buyer decides to not complete checkout. |
| Required? | No |
| Length Limit | 255 |
| enable_company | |
| Description | 1 = Enable field for buyer to enter their company name. 0 = Don't want buyer's company name. (default) |
| Required? | No |
| Length Limit | 1 |
| allow_extra | |
| Description | 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. If set to 2 it will make the note required and move it above the coin selection. |
| Required? | No |
| Length Limit | 1 |
| extra_desc | |
| Description | If set will change the name of the "Note to Seller" field to whatever you set. |
| Required? | No |
| Length Limit | 64 |
| lang | |
| Description | Automatically set the checkout language to this language code. For a list of supported codes check this page. |
| Required? | No |
| Length Limit | 16 |
| cstyle | |
| Description | Sets a coin selection style for the checkout page. (default: grid1) |
| Required? | No |
| Length Limit | 32 |
| Buyer Information These fields can be used to pre-populate forms with any information you already know about your buyer. | |
| first_name | |
| Description | Buyer's first name. |
| Required? | No |
| Length Limit | 32 |
| last_name | |
| Description | Buyer's last name. |
| Required? | No |
| Length Limit | 32 |
| company | |
| Description | Buyer's company name. |
| Required? | No |
| Length Limit | 128 |
| Description | Buyer's email address. |
| Required? | No |
| Length Limit | 128 |
| address1 | |
| Description | Street / address line 1 |
| Required? | No |
| Length Limit | 128 |
| address2 | |
| Description | Street / address line 2 |
| Required? | No |
| Length Limit | 128 |
| city | |
| Description | City |
| Required? | No |
| Length Limit | 64 |
| state | |
| Description | State / Province |
| Required? | No |
| Length Limit | 64 |
| zip | |
| Description | Zip / Postal Code |
| Required? | No |
| Length Limit | 32 |
| country | |
| Description | Country of Residence This uses 2 digit ISO 3166 country codes. |
| Required? | No |
| Length Limit | 2 |
| phone | |
| Description | Phone Number |
| Required? | No |
| Length Limit | 32 |
| Feel free to check out our example buttons. | |
| Field Name | Description | Required? | Length Limit |
|---|---|---|---|
| Main Fields | |||
| cmd | This should always be set to '_pay'. | Yes | N/A |
| reset | This tells the server to delete any cached button data for the user. Set the value to 1 | Yes | 1 |
| merchant | Your merchant ID (you can find this on the My Account page). | Yes | N/A |
| Item/Payment Description Fields | |||
| currency | The currency of the payment (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. | Yes | 3 |
| amountf | The amount (in the currency chosen) of the payment. | Yes | N/A |
| item_name | The name of the item being purchased. | Yes | 128 |
| item_number | This is a passthru variable for your own use. [visible to buyer] | No | 128 |
| 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 |
| 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 not supported. | No | N/A |
| allow_quantity | 0 = Don't allow buyer to adjust quantity (default). 1 = Allow buyer to adjust quantity. | No | 1 |
| max_quantity | Sets a maximum quantity the buyer can select. 0 = No maximum (default). | No | N/A |
| allow_amount | 0 = Don't allow buyer to adjust item price (default). 1 = Allow buyer to adjust item price. | No | 1 |
| 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) | No | 1 |
| 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. Example: BTC,LTC | No | 255 |
| 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) | 128 |
| 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) | 128 |
| ov2 | 2nd option value. This would be the buyer's selection such as small, large, red, white. | No | 128 |
| Shipping Fields | |||
| want_shipping | 1 = Want buyer's shipping information (default). 0 = Don't want buyer's shipping information. | No | 1 |
| shippingf | Cost of shipping the item. Shipping cost is shippingf*quantity (unless shipping2 is set) | No | N/A |
| shipping2f | Cost of shipping each additional item. Shipping cost is shippingf+((quantity-1)*shipping2f) | No | N/A |
| taxf | Any tax to charge. | No | N/A |
| 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. Example: US,CA,GB | No | 255 |
| Miscellaneous Fields | |||
| ipn_url | Sets an IPN URL. If not set or blank defaults to the IPN URL in your settings. | No | 255 |
| success_url | Sets a URL to go to if the buyer does complete checkout. | No | 255 |
| cancel_url | Sets a URL to go to if the buyer decides to not complete checkout. | No | 255 |
| enable_company | 1 = Enable field for buyer to enter their company name. 0 = Don't want buyer's company name. (default) | No | 1 |
| 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. If set to 2 it will make the note required and move it above the coin selection. | No | 1 |
| extra_desc | If set will change the name of the "Note to Seller" field to whatever you set. | No | 64 |
| 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 |
| Buyer Information 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 |
| company | Buyer's company name. | No | 128 |
| Buyer's email address. | No | 128 | |
| address1 | Street / address line 1 | No | 128 |
| address2 | Street / address line 2 | No | 128 |
| city | City | No | 64 |
| state | State / Province | No | 64 |
| zip | Zip / Postal Code | No | 32 |
| country | Country of Residence This uses 2 digit ISO 3166 country codes. | No | 2 |
| phone | Phone Number | No | 32 |
| Feel free to check out our example buttons. | |||
