| Field Name | |
|---|---|
| Main Fields | |
| cmd | |
| Description | This should always be set to '_donate'. |
| 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 |
| Donation Amount Fields | |
| currency | |
| Description | The currency of the donation (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 donation. This is not required if allow_amount is set to 1 |
| Required? | Yes |
| Length Limit | N/A |
| item_name | |
| Description | Who/what the donation is for. |
| Required? | Yes |
| Length Limit | 128 |
| item_number | |
| Description | This is a passthru variable for your own use. [not visible to donator] |
| Required? | No |
| Length Limit | 128 |
| invoice | |
| Description | This is a passthru variable for your own use. [not visible to donator] |
| 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 |
| allow_amount | |
| Description | 1 = Allow donator to adjust donation amount (default). 0 = Don't allow donator to adjust donation amount. |
| 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 |
| on1 | |
| Description | 1st option name. This lets you pass through a donator option like a donation reward. |
| Required? | No (unless ov1 set) |
| Length Limit | 128 |
| ov1 | |
| Description | 1st option value. This would be the donator's selection such as hat, shirt, stickers. |
| Required? | No |
| Length Limit | 128 |
| on2 | |
| Description | 2nd option name. This lets you pass through a donator option like a donation reward. |
| Required? | No (unless ov2 set) |
| Length Limit | 128 |
| ov2 | |
| Description | 2nd option value. This would be the donator's selection such as hat, shirt, stickers. |
| Required? | No |
| Length Limit | 128 |
| Shipping Fields | |
| want_shipping | |
| Description | 0 = Don't want donator's shipping information (default). 1 = Want donator's shipping information. |
| Required? | No |
| Length Limit | 1 |
| shippingf | |
| Description | Cost of shipping (ie. a physical donation reward). |
| 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 donator does complete checkout. |
| Required? | No |
| Length Limit | 255 |
| cancel_url | |
| Description | Sets a URL to go to if the donator decides to not complete checkout. |
| Required? | No |
| Length Limit | 255 |
| allow_extra | |
| Description | If set to 1 will have a field where the donator can leave you a note or extra information such as shipping address, size, or color. |
| Required? | No |
| Length Limit | 1 |
| 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 |
| Donator Information These fields can be used to pre-populate forms with any information you already know about your donator. | |
| first_name | |
| Description | Donator's first name. |
| Required? | No |
| Length Limit | 32 |
| last_name | |
| Description | Donator's last name. |
| Required? | No |
| Length Limit | 32 |
| Description | Donator'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 donation buttons. | |
| Field Name | Description | Required? | Length Limit |
|---|---|---|---|
| Main Fields | |||
| cmd | This should always be set to '_donate'. | 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 |
| Donation Amount Fields | |||
| currency | The currency of the donation (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 donation. This is not required if allow_amount is set to 1 | Yes | N/A |
| item_name | Who/what the donation is for. | Yes | 128 |
| item_number | This is a passthru variable for your own use. [not visible to donator] | No | 128 |
| invoice | This is a passthru variable for your own use. [not visible to donator] | No | 128 |
| custom | This is a 2nd passthru variable for your own use. [not visible to buyer] | No | 128 |
| allow_amount | 1 = Allow donator to adjust donation amount (default). 0 = Don't allow donator to adjust donation amount. | 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 |
| on1 | 1st option name. This lets you pass through a donator option like a donation reward. | No (unless ov1 set) | 128 |
| ov1 | 1st option value. This would be the donator's selection such as hat, shirt, stickers. | No | 128 |
| on2 | 2nd option name. This lets you pass through a donator option like a donation reward. | No (unless ov2 set) | 128 |
| ov2 | 2nd option value. This would be the donator's selection such as hat, shirt, stickers. | No | 128 |
| Shipping Fields | |||
| want_shipping | 0 = Don't want donator's shipping information (default). 1 = Want donator's shipping information. | No | 1 |
| shippingf | Cost of shipping (ie. a physical donation reward). | 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 donator does complete checkout. | No | 255 |
| cancel_url | Sets a URL to go to if the donator decides to not complete checkout. | No | 255 |
| allow_extra | If set to 1 will have a field where the donator 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 |
| Donator Information These fields can be used to pre-populate forms with any information you already know about your donator. | |||
| first_name | Donator's first name. | No | 32 |
| last_name | Donator's last name. | No | 32 |
| Donator'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 donation buttons. | |||
