To open our API reference in a new tab, click here.
","user_segment_ids":[]},{"id":32643580478353,"url":"https://devdigistore24.zendesk.com/api/v2/help_center/en-us/articles/32643580478353.json","html_url":"https://dev.digistore24.com/hc/en-us/articles/32643580478353-Affiliate-attribution-via-javascript","author_id":21104399012497,"comments_disabled":false,"draft":false,"promoted":false,"position":0,"vote_sum":16,"vote_count":40,"section_id":32544506908561,"created_at":"2025-02-13T12:18:45Z","updated_at":"2026-09-27T13:09:25Z","name":"Affiliate attribution via javascript","title":"Affiliate attribution via javascript","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2025-02-13T14:29:15Z","user_segment_id":null,"permission_group_id":12152305040273,"content_tag_ids":[],"label_names":[],"body":"Ususally it's enough to just add the tracking code to your salespage as found in the Digistore backoffice under: Settings - Promocode for Salespage
\nThe code is e.g.:
\n<script\n src=\"https://www.digistore24-scripts.com/service/digistore.js\"></script><script type=\"text/javascript\">digistorePromocode( { \"product_id\": 12345,\n \"adjust_domain\": true } );</script>
12345 is the id of your product.
\nThe js code modifies all regular A-HREF-Links and append the affiliate to the url.
\nExample:
\nSalespage url is: https://www.some-domain.com/salespage/
\nCheckout button on the sales page is:
\n<a href='https://www.checkout-ds24.com/product/12345'>Buy\n now</a>
The affiliate advertises: https://www.some-domain.com/salespage/?aff=some_affiliate_name
\nWhen a buyer follows the affiliate's link, then the js code above changes the checkout button url to: https://www.checkout-ds24.com/product/12345?aff=some_affiliate_name
\nThat's the regular workflow.
\nHowever, if you use a custom js button like:
\n<a\n onclick=\"windows.open('https://www.checkout-ds24.com/product/12345')\">Buy\n now</a>
Then our js cannot identify this button and cannot append the affiliate.
\nThe solution is to use our js function: digistoreAppendAffiliateToUrl( string url ) : string
This function appends the affiliate to an url.
\nIn this case use a button like:
\n<a onclick=\"windows.open( digistoreAppendAffiliateToUrl(\n 'https://www.checkout-ds24.com/product/12345') )\">Buy\n now</a>
If you publish an application you might want to enable users to generate an API key easily.
\nThe procedure is described here. For the creation the user of your app will be forwarded to the Digistore24 page - and afterwards back to your app. Data is transferred via GET parameters.
\nPreparation: Generate a developer API key
\nYou need the developer key to enable your users to generate themselves an API key interactively. The developer key is needed for steps 1 and 2 mentioned below.
\nExecute step 1 and 2 for every user account of your app that shall be connected with Digistore24.
\nCall up the API function requestApiKey(). Use the developer key for it.
\nPass these parameters:
\nThe API call will return:
\nThe user will be redirected to your website by Digistore24.
\nCall up the API function retrieveApiKey() with your developer key.
\nPass these parameter:
\nThe api call will return:
\nWe deliver a sample script together with the PHP class (the file examples/register.php) which demonstrates the creation of the API key.
\nSecurity
\nFurthermore, we recommend you to secure your app via SSL (i.e. the URL of your app begins with https://)
\nEnable the user to disconnect.
\nFor this please call up the function unregister() via API. The API key will be deleted on the server then. Furthermore, associated IPN connections will be deleted.
\nAfterwards please delete the API key of your app.
","user_segment_ids":[]},{"id":32480217565969,"url":"https://devdigistore24.zendesk.com/api/v2/help_center/en-us/articles/32480217565969.json","html_url":"https://dev.digistore24.com/hc/en-us/articles/32480217565969-Quick-Integration-Guide","author_id":30422410011025,"comments_disabled":false,"draft":false,"promoted":false,"position":0,"vote_sum":3,"vote_count":11,"section_id":32544282072977,"created_at":"2025-02-07T11:42:13Z","updated_at":"2026-09-13T11:44:24Z","name":"Quick Integration Guide","title":"Quick Integration Guide","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2025-06-30T12:22:36Z","user_segment_id":null,"permission_group_id":12152305040273,"content_tag_ids":[],"label_names":[],"body":"This guide is for software developers and system administrators, who want to connect a vendor’s billing system to Digistore24.
\nA buyer orders the product “Guide To Happiness”.
\nThen there will be:
\nBuyer
\nA buyer is the person in front of the computer screen, who buys your product.
\nOrder
\nIf a buyer buys one or more products using the same order form at the same time, this is one order.
\nAn order consists of one initial sale and up to three upsells. These are referred to as “order items”.
\nTransaction
\nA transaction is a payment, a refund or a chargeback.
\nAt Digistore24, we process one transaction for each order item.
\nExample: If a buyer buys an initial sale and the first upsell, then there are two transactions meaning two payments.
\nIPN Call
\nThis is the instant payment notification (IPN) we send to your server. For each transaction, there is one IPN-call. If a customer buys three products, there will be three IPN calls – one for each payment of each product.
\n\nNote\n\nMake sure the order events that you have specified in your script are selected here as well.
\n
Use this procedure to update your existing IPN setup in Digistore24 when parameters or logic change.
\nSave a copy of the current IPN script.
\nNote your existing Digistore24 IPN configurations, i.e. URL, IPN password, selected products and order events.
\nEdit the IPN script as desired.
\nSet a new SHA_PASSPHRASE.
\n\nNote\n\nMake sure the order events that you have specified in your script are selected here as well.
\n
","user_segment_ids":[]},{"id":32479630493585,"url":"https://devdigistore24.zendesk.com/api/v2/help_center/en-us/articles/32479630493585.json","html_url":"https://dev.digistore24.com/hc/en-us/articles/32479630493585-API-basics","author_id":21104399012497,"comments_disabled":false,"draft":false,"promoted":false,"position":0,"vote_sum":4,"vote_count":18,"section_id":32478845811473,"created_at":"2025-02-07T11:24:16Z","updated_at":"2026-09-11T12:52:04Z","name":"API basics","title":"API basics","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2025-08-28T08:42:30Z","user_segment_id":null,"permission_group_id":12152305040273,"content_tag_ids":[],"label_names":[],"body":"
The Digistore24 API allows external applications to access your Digistore24 account. This site is the technical documentation of the API and only interesting for software and application developers.
\nVia the Digistore24 API, your applications, data – e.g. a list of products and orders – can be read out. Depending on the access authority, data can be changed as well – e.g. orders can be cancelled. The access is possible via the API key of the user of your applications via HTTP.
\nYou need an API key to get access to the Digistore24 API. To generate an API key, please proceed as follows:
\nThe API key will be displayed. It is a long combination of letters and numbers as for example:
\n123-iKWIrTsUTbCyRFuotOdV8yO2xnfMI5b3rZhDCUAG
For every API key, you can select one of the following API permissions:
\nWe have prepared a PHP class and several examples for you - click here to download.
\nYou can find all functions you can call up via the Digistore24 API in the API reference.
\nThe PHP class is compatible with future versions of the Digistore24 API. I.e. even if the Digistore24 API will expand, you can still use your current version of the PHP class.
\nWe also provide a Javascript API connector - download it here.
\nEven this connector works with all functions of the API reference.
\n\nCaution\n\nAPI keys which are being used with the Javascript API can be reviewed easily. Please use only developer keys with the Javascript API.
\n
If you use the PHP class mentioned above, you can skip this section.
\nIn order to use the API without PHP class, please carry out HTTP calls to the following URL:
\nhttps://www.digistore24.com/api/call/FUNCTION
\nPlease replace FUNCTION: function name – cf. API reference
\nYou can transfer function arguments as GET or POST parameters.
\nSet these http headers for secure authentication:
\nThe following function call shall be carried out:
\nThen the URL can be:
\nhttps://www.digistore24.com/api/call/resendPurchaseConfirmationMail?purchase_id=X26QE8GN
\nThe server answers with a text document with the following exemplary content:
\n{
\"api_version\": \"1.234\",
\n \"current_time\": \"2014-03-14 17:30:08\",
\n \"result\": \"success\",
\"data\":\n {
\"modified\": \"Y\",
\n \"note\": \"The confirmation mail has been sent.\"
\n }
}
Here, the answer is a data set in the JSON format.
\nIf succeeded, you will get an object with the following fields:
\nIf unsuccessful, you will get an object with the following fields:
\nIf you transfer the function arguments as POST or GET parameter, you can choose:
\nSome functions (like createBuyUrl()) expect arrays as function arguments.
\nExample: You want to transfer the following array:
\nbuyer = array(
name => Udo,
\n email => uw@ds24mail.com
)
You transfer the data of the array as follows:
\n…&buyer[name]=Udo&buyer[email]=uw@ds24mail.com
or with numbered parameters
\n…&arg1[name]=Udo&arg1[email]=uw@ds24mail.com
Besides the accepted parameters arg1/arg2/… the following parameters can always be transfered:
\nWe will advance the API in the near future but we will keep the downward compatibility.
\nWe will undertake the following changes unheralded:
\nPlease design you app in a way that is compatible with these changes and no changes in the source code has to be made. Otherwise it might happen that you app will not run properly.
\nFollowing things will not change:
\nIf you run a platform, and your user are vendors on Digistore24, you can offer your users a customizable order form widget.
\nIt is integrated on the sales pages on your platform and enables direct orders to be placed from Digistore24.
\nThe order form widget is configurable via an API and can complete orders in one, two or three steps.
\nAs a test, you can manually create an order form widget on Digistore24.
\nIn the vendor view, select Account – Order forms – New order form widget.
\nYou can adjust all the settings of the order form editor via the Digistore24 API.
\nOn your platform, you provide an editor for the settings of the order form widget.
\nYou can create or update the widget using the API functions createOrderform() and updateOrderform(). The order form widget is integrated via iframe. If you have changed the settings, reload the iframe.
\nInclude this HTML code on your page. You use this code for the editor and for the productive version of your sales page.
\n<script\n src='https://www.digistore24.com/service/js/orderform_widget.js'></script><script>const\n DS24_ORIGIN='https://www.digistore24.com';</script>
<iframe\n id='ds24_payIFrame' style='overflow: hidden; width: 100%;\n height: 600px; border: none; background: transparent;'\n src='https://www.digistore24.com/product/PRODUCT_ID/ORDERFORM_ID'></iframe>
Replace the placeholders PRODUCT_ID and ORDERFORM_ID accordingly.
\nThe product and order form must belong to the same Digistore24 vendor.
\nWhile editing the order form, the user will often want to switch between tabs. To make this process easier, add the following JavaScript code in your editor:
\n<script>
\n window.addEventListener(\"ds24-msob-onload\", function( e ) {
\n ds24_setEditorMode();
} );
</script>
Your platform can provide graphics for the tabs, as well as the custom CSS code that allows you to customize the order form widget. These can then be created using the API functions createOrderform() or updateOrderform() on the widget (using the fields tab_image_1_url, tab_image_2_url and tab_image_3_url and custom_css, respectively).
\nImportant: The Digistore24 logo at the bottom of the order form must remain visible and unchanged. This is a requirement set by our payment provider.
\nTo create and maintain the order form on Digistore, use the following API functions:
\n\nOther useful functions are also possible:
\n\nIf you want Digistore24 to manage the images of your users:
\n\nYou can change the order form from your sales page or from the editor using the following JavaScript API.
\nThe multistep order box triggers the ds24-msob-onload event, after it has been fully loaded. When using the following functions, make sure, you use them after this event.
\n<script>
\n window.addEventListener(\"ds24-msob-onload\", function( e ) {
\n console.log( e.detail );
} );
</script>
Activates the editor mode. The user can then change the tabs without having to fill in the entry fields correctly.
\nThe editor mode can also be set via the GET parameter editor_mode=1, e.g.:
\n...
<iframe ...\n src='https://www.digistore24.com/product/PRODUCT_ID/ORDERFORM_ID?editor_mode=1'></iframe>
Reloads the iframe. Use this in your editor if changes to the order form have been saved and should now be displayed.
\nSets the current step number. For two-step order forms step_no is 1 or 2. For three-step order forms, it is 1, 2 or 3.
\nThe current step can also be selected via the GET parameter step.
\nAdds an event listener.
\nThe event listener is following function-type: function ( event_name, event_details )
\nSupported events:
\nFills in the form with the contacts. Address is an object with these fields (all are optional):
\nImportant: Changing the country reloads the iframe. To prevent this, the country can also be transferred as the GET parameter country, for example:
\n...
<iframe ...\n src='https://www.digistore24.com/product/PRODUCT_ID/ORDERFORM_ID?country=AT'></iframe>
The other fields (i_order_as, company, first_name, etc.) can also be transferred as GET parameters.
\nSelects a payment plan.
\nplan_index_or_id is either the ID of the payment plan (e.g. 123456) or the index of the payment plan beginning with 1. i.e. plan_index_or_id == 2 selects the second payment plan.
\nSets the quantity for a product.
\nproduct_index_or_id is either the ID of the product (e.g. 123456) or the index of the product beginning with 1. i.e. product_index_or_id == 2 selects the second product.
\nSets the currency.
\nAvailable currencies are returned via the API function listCurrencies().
\nImportant: Changing the currency reloads the iframe. To prevent this, the currency can also be transferred as the GET parameter currency, for example:
\n...
<iframe ...\n src='https://www.digistore24.com/product/PRODUCT_ID/ORDERFORM_ID?currency=USD'></iframe>
The purchase is made with the discount code provided (if it is valid for the purchase).
\nYou can also pass the voucher code as a GET parameter “voucher” to the iframe url.
\nSets the custom parameter, which is also passed to the order form via the GET custom parameter. The parameter is then looped through and passed as a custom field in the IPN message and at the Api call getPurchase() or listPurchases().
\n., comma ,, tilde ~, hyphen - and underscore _.You can also pass the voucher code as a GET parameter “custom” to the iframe url.
\nReturns the current step number: 1, 2 or 3.
\nReturns the total number of steps possible: 1, 2 or 3.
\nThis code selects the second step on the order form widget.
\n <script\n src='https://www.digistore24.com/service/js/orderform_widget.js'></script><script>const\n DS24_ORIGIN='https://www.digistore24.com';</script> <iframe\n id='ds24_payIFrame' style='overflow: hidden; width: 100%;\n height: 600px; border: none; background: transparent;'\n src='https://www.digistore24.com/product/1234/5689'></iframe>
<script\n type=\"text/javascript\">
\n window.onload = function() {
\n ds24_setStep(2);
};
</script>
The Digistore24 API uses its own special values for data types.
\nBoolean Values can be specified like this:
\n1, Y, yes, T, true\n0, N, no, F, false\nPoints of time can be stated like that:
\n2014-02-28 23:11:24now for now24h for the point of time in exactly 24 hours-24h for the point of time exactly before 24 hours-3d for the point of time exactly before 3 days-6h for the point of time exactly before 6 hours-10m for the point of time exactly before 10 minutes-30s for the point of time exactly before 30 seconds6M for the point of time in 6 months2Y for the point of time in 2 years2009-06-30T18:30:00+02:00 for the given date and time. Use any ISO 8601 formatted date, time and timezone. Digistore transforms date and time into the server timezone.Dates can be stated like that:
\nnow or \"today\" for today-3d for the date before 3 days-6h for the date before 6 hours-10m for the date before 10 minutes-30s for the date before 30 seconds6M for the date in 6 months2Y for the date in 2 years2009-06-30T18:30:00+02:00 for the given date. Use any ISO 8601 formatted date incl. time and timezone. Digistore transforms the date into the server timezone.An IPN-event is sent for each transaction and for some other conditions (such as a missed backbilling payment). The event name is sent as $_POST['event'].
\nThe names in the backoffice are sent via the parameter \"event_label\".
\nEach IPN call sends exactly one of these event notifications:
\n\nNote\n\nWhen copying any parameters, please pay attention to possible line breaks.
\n
| Event | \nName in backoffice | \nDescription | \n
|---|---|---|
| on_payment | \npayment | \nThe buyer makes a successful payment. | \n
| on_refund | \nrefund | \nThe support team of the vendor or Digistore24 has initiated a refund, which has been successfully processed. | \n
| on_chargeback | \nchargeback | \nThe credit card company processed a chargeback. | \n
| on_payment_missed | \nmissed recurring payment | \nFor a subscription or installment payment, a payment is missing (e.g. due to insufficient funds or expired payment method). Use this to temporarily suspend access to your product or membership until a successful payment is made. Important: Do not use this event for cancellations or refunds – use last_paid_day instead. You can find more details here. Please note that an on_payment event may occur if the buyer succeeds in payment after the on_payment_missed event. In that case, access should be granted again. After this event is triggered, Digistore24 will retry the charge multiple times and notify the customer via email. If all retries fail, the subscription will be automatically cancelled, and last_paid_day will be triggered. | \n
| payment_denial | \nrejected payment | \nThe payment was rejected. The IPN event is sent after the last payment attempt. By default, rejected payments are not selected in the IPN configuration. | \n
| on_rebill_cancelled | \nrebilling canceled | \nThis event is sent immediately when the support clicks the “stop rebilling” button in the order details. When the last paid billing period has ended, last_paid_day is sent. | \n
| on_rebill_resumed | \nrebilling resumed | \nThe buyer has requested to continue the rebilling payments. This event is sent, when the support clicks the “restart rebilling” button in the order details. | \n
| last_paid_day | \nend of paid period | \nThe last paid billing period has ended, usually due to a cancellation or refund. Use this event to permanently revoke access, as no further payments will be collected. It is typically sent early in the morning after the final access day. This event is also triggered automatically if all retry attempts after an on_payment_missed event fail. | \n
\n What is the difference between “last_paid_day” and “on_rebill_cancelled”? \n\n“On_rebill_cancelled” is sent, when the customers cancels a subscription or installment payment and the support operator stops the payments. “last_paid_day” event is sent, when the last paid billing period has ended.
\n
| Event | \nName in backoffice | \nDescription | \n
|---|---|---|
| connection_test | \nTest connection | \nOur server sends this event to test the connection to your server, e.g. if you hit the “Test connection” button in the vendor’s IPN settings section. The response should always be “OK”.\n If the test fails, check again the above points of this integration guide and if the server is reachable with the script. \n | \n
| on_affiliation | \nNew affiliate | \nWhen an affiliate wants to promote your product and the affiliation is accepted, then an IPN-Call with this event will be sent. | \n
| eticket | \nNew e-ticket | \nFor created e-tickets. This may also take place after the order has been placed, as the buyer may not enter the participant data until later. The IPN message for an e-ticket can also be sent twice if, for example, a name is entered or corrected later. Therefore, please use eticket_id to check whether the ticket is already in your database. | \n
| custom form | \nNew custom form | \nFor completed additional input fields. | \n
With each IPN request, we send this set of parameters.
\nThese parameters are included in the SHA512 signature.
\nThe SHA512 Signature itself is transferred as the parameter \"sha_sign\".
\n| Parametername | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| ipn_version | \nfloat | \nCurrent version of the IPN-interface. | \n1.2 | \n
| api_mode | \nstring(4) | \nIndicates live or test mode. Possible values: live, test | \nlive | \n
| order_id | \nstring(15) | \nUnique ID of the order. Multiple transactions of the same order have the same order-ID. | \n34DEFS45DE2 | \n
| order_date | \nstring(10) | \nDate of the order. | \n2013-03-31 | \n
| order_time | \nstring(8) | \nTime of the order | \n15:57:34 | \n
| order_type | \nstring(31) | \nType of order. Values are:\n regular - order via regular orderform \nupgrade - replaces of an existing order (see below) \nphone_order - order via DigiCalls \ncart - shopping cart order \nvat_change - created because of change of vat \n\n | \nregular | \n
| order_date_time | \nstring(19) | \nDate and time of the order. | \n2013-03-31 15:57:34 | \n
| transaction_date | \ndate | \nDate of the transaction (e.g. of the payment). It is often the same as order_date but may differ, e.g. for payment by e-check. | \n2013-03-31 | \n
| receipt_url | \nstring(127) | \nURL for the receiving page of the order of Digistore24. | \nhttps://www.digistore24.com/receipt/abc123/xyz789 | \n
| renew_url | \nstring(127) | \nURL to redo a payment if the payment was cancelled (or to change the payment data for rebilling). | \nhttps://www.digistore24.com/renew/abc123/xyz789 | \n
| add_url | \nstring(127) | \nURL to add or remove products from an order (when the main product’s or the addon’s quantity may be changed after the purchase. This is set up in the product editor). | \nhttps://www.digistore24.com/order/add/abc123/xyz789 | \n
| support_url | \nstring(127) | \nURL to access our buyer support system. This system answers frequently asked questions. It also allows the buyer to cancel rebilling payments and to request a refund. | \n\n |
| rebilling_stop_url | \nstring(127) | \nURL to stop the rebilling payments. It's empty if the purchase is not a rebilling purchase. | \n\n |
| request_refund_url | \nstring(127) | \nURL to request a refund. | \n\n |
| order_details_url | \nstring(127) | \nURL for order details. If you are not logged in at Digistore24, you will be asked to log in. | \n\n |
| customer_to_affiliate_url | \nstring(127) | \nIf you have enabled the “Customers to Affiliates”-program for the purchased main product, this links contains the invitation URL for the customer to become an affiliate. If they follow the URL, a Digistore24-account will be created. If the program is disabled/inactive, this parameter is missing. | \nhttps://www.digistore24.com/become_affiliate/abc123/xyz789 | \n
| customer_affiliate_name | \nstring(31) | \nIf the buyer has a Digistore24 account, this is the account name. This does not necessarily mean, that they have established affiliations with your products. | \nuser12345\n someusername \n | \n
| customer_affiliate_promo_url | \ntring(127) | \nThe new affiliate my use this url to promote the product he bought. | \nhttp://www.digistore.local/redir/54321/user12345/ | \n
| payment_id | \nstring(40) | \nUnique ID of the payment. Multiple payments of the same order have different payment-IDs. | \nPAYID-43-3999234 | \n
| merchant_id | \nint | \nUnique ID of a vendor. | \n39499382 | \n
| merchant_name | \nstring(31) | \nUnique Digistore24 name of the vendor. | \nJohnSmith | \n
| custom | \nstring(63) | \nCustom parameter the vendor has sent as GET-Parameter “custom” to the order form. | \nuser_300342 | \n
| country | \nstring(2) | \nCountry ISO-Code (two characters) of the buyer’s country. If the buyer does not enter a country (e.g. for digital products), the country is determined using the buyer's IP. | \nUS | \n
| is_gdpr_country | \nY/N | \nY = The user data fall under the EU gdrp (German: DSGVO)\n N = The user data do not fall under the gdrp. \n | \nY | \n
| affiliate_id | \nint | \nUnique ID of the affiliate. It is “0” if the sale was made without an affiliate. | \n339993 | \n
| affiliate_name | \nstring(31) | \nUnique Digistore24 name of the affiliate. It is empty if the sale was made without an affiliate. | \n\n |
| campaignkey | \nstring(23) | \nThe campaignkey of the affiliate (used as part of the promolink). | \nNewsletterXY | \n
| trackingkey | \nstring(47) | \nThe vendor’s trackingkey (used as GET-Parameter “ds24tr” as part of the promolink or orderform-URL) | \nSalespageXY | \n
| salesteam_name | \nstring(63) | \nName of the sales team who has created the purchase. | \nA-Team | \n
| salesteam_id | \nint | \nThe ID of the sales team. | \n12345 | \n
| transaction_id | \nint | \nThe transaction-ID. | \n3999938 | \n
| transaction_amount | \nfloat | \nThe amount of the transaction. | \n37.99 | \n
| transaction_currency | \nstring(3) | \nCurrency code. | \nUSD | \n
| transaction_processed_at | \ndate | \nDate of the transaction. | \n2012-03-23 18:21:47 | \n
| transaction_type | \nenum | \nPossible values: payment, refund, chargeback | \npayment | \n
| pay_sequence_no | \nint | \nFor single payments this value is 0. For instalments and subscription only: Number of payment, e.g. 1 for the first payment, 2 for the second and so on. | \n3 | \n
| currency | \nstring(3) | \nCurrency code. | \nUSD | \n
| amount_brutto | \nfloat | \nGross amount of the payment. | \n97.00 | \n
| amount_netto | \nfloat | \nNet/After-tax amount of the payment (i.e. the Gross amount minus the VAT-amount). | \n81.51 | \n
| amount_vat | \nfloat | \nAmount of the VAT. | \n15.49 | \n
| amount_provider | \nfloat | \nFee for Digistore24. | \n8.66 | \n
| amount_fee | \nfloat | \nIf applicable: chargeback fee. | \n0.00 | \n
| amount_payout | \nfloat | \nAmount shared between vendor, affiliate, Joint Venture partner and Cross Upsell partner (as far as applicable). | \n72.85 | \n
| amount_vendor | \nfloat | \nShare of the vendor. | \n51.00 | \n
| amount_affiliate | \nfloat | \nShare of the affiliate (if applicable). | \n21.85 | \n
| amount_partner | \nfloat | \nShare of Joint Venture/Cross Upsell partners (if applicable). | \n0.00 | \n
| amount_credited | \nfloat | \nIf the buyer performs an upgrade or downgrade of the order, changes the payment plan or removes items from an existing order, there may be a credit balance from the previous purchase. This is the amount of the credit balance for this payment. | \n0.00 | \n
| vat_rate | \nfloat | \nThe VAT-rate in percent. | \n19.00 | \n
| number_of_installments | \nint | \nTotal number of payments including the first payment. | \n3 | \n
| billing_type | \nPossible values: single_payment, subscription, installment | \nsingle_payment | \n\n |
| billing_status | \nstring(15) | \nPossible values: paying (only for rebilling; payments are active)aborted, unpaid, reminding, completed (only for single payment and instalments; the single payment is completed/all instalment payments are completed) | \ncompleted | \n
| is_cancelled_for | \ndate | \nIf given, the order is cancelled for this date. The product access should stop on this day. | \n\n |
| billing_stop_reason | \nstring(23) | \nOnly if a rebilling has stopped. Possible values: by_operator, by_buyer, by_refund, by_chargeback, by_payment_denial, by_payment_uncertain, pay_alias_invalid, upgraded, no_product, merchant_inactive, unknown | \nby_operator / | \n
| pay_method | \nstring(23) | \nPayment method, e.g. PayPal, ELV, credit card. | \nELV | \n
| tags | \nstring(47) | \nTags of purchase – separated by commas. | \ntag1,tag2,tag3 | \n
| tag1 | \nstring(47) | \nTag of first product | \ntag1,tag2 | \n
| tag2 | \nstring(47) | \nTag of second product | \ntag3 | \n
| ... | \n... | \n... | \n\n |
| product_id | \nint | \nUnique ID of the product. | \n3323323 | \n
| product_language | \nLanguage code of the product’s language. | \nen | \n\n |
| product_name | \nstring(63) | \nReadable name of the product. | \nFast wealth guide | \n
| product_delivery_type | \nenum | \nPossible values: digital, shipping | \ndigital | \n
| variant_id | \nstring(31) | \nThe ID of product variant the buyer has selected (only if variants have been added to the product). | \nblue | \n
| variant_name | \nstring(63) | \nThe name of the product variant the buyer has selected (only if variants have been added to the product). | \nblue coloured shirt | \n
| quantity | \nint | \nNumber of ordered products (with ID “product_id”). The most common one is “1”. | \n1 | \n
| product_id_2 | \nint | \nUnique ID of the second product of the purchase (if applicable). | \n\n |
| product_id_3 | \nint | \nUnique ID of the third product of the purchase (if applicable). | \n\n |
| \n product_txn_amount \nproduct_txn_netto_amount \nproduct_txn_vat_amount \nproduct_txn_shipping \n | \namount | \ngros/net/vat/shipping amount per product and transaction | \n27.33 | \n
| \n product_amount \nproduct_netto_amount \nproduct_vat_amount \nproduct_shipping_amount \n | \namount | \ndito for the purchase. Is the same as above for subscription and single payment. Differs for installments. | \n99.95 | \n
| Same for: product_id_4, product_id_5,\n product_name, product_name_2, ... \nproduct_delivery_type, \nvariant_id \nvariant_name \nquantity \nproduct_txn_amount \nproduct_txn_netto_amount \nproduct_txn_vat_amount \nproduct_txn_shipping \nproduct_amount \nproduct_netto_amount \nproduct_vat_amount \nproduct_shipping_amount \n | \n\n | \n | \n |
| buyer_id | \nint | \nThe ID of the buyer. | \n333222 | \n
| string(63) | \nThe email of the buyer. | \nclaus@domain-xyz.com | \n|
| language | \nstring(2) | \nLanguage code of the buyer’s language. | \nen | \n
| address_first_name | \nThe first name of the buyer. | \nClaus | \n\n |
| address_last_name | \nThe last name of the buyer. | \nMyer | \n\n |
| address_id | \nThe adress-ID of the buyer. | \n12345 | \n\n |
| address_street | \nStreet name and street number. Empty if no address is specified. | \nMainstr.123a | \n\n |
| address_street_name | \nStreet name only. | \nMainstr. | \n\n |
| address_street_number | \nStreet number only. | \n123a | \n\n |
| address_street2 | \nOnly Address suffix | \nsuite, building, etc. | \n\n |
| address_city | \nCity name. | \nBerlin | \n\n |
| address_state | \nOnly for countries, which have a state (like USA). E.g. for Germany, no state is given. | \n\n | \n |
| address_zipcode | \nThe address-zipcode. | \n12345 | \n\n |
| address_country | \n2-Letter ISO country code. Empty if no address is specified. | \nDE | \n\n |
| address_country_name | \nFull name of the country. Empty if no address is specified. | \nGermany | \n\n |
| address_company | \nEmpty if no company is specified. | \nSome Company Ltd. | \n\n |
| address_tax_id | \nThe VAT-ID of the buyer's company. Empty if no VAT-ID is specified. | \n\n | \n |
| address_phone_no | \nEmpty if no phone number is specified. | \n\n | \n |
| upgrade_key | \nstring(23) | \nUse this key together with the order id for upgrade links and the smart upgrade widget to fill the placeholders [ORDER_ID] and [UPGRADE_KEY] | \nABCDEFGHI1234567890 | \n
| custom_key | \nstring(23) | \nA random key, which is unique for the order. This key is transmitted to DigiMember and DigiBizz and may be used for automated user login. | \n1234-Naiy8ahSaiT | \n
| orderform_id | \nint | \nThe ID of order form used for the purchase. | \n654321 | \n
| payplan_id | \nint | \nThe ID of the selected payment plan. | \n123456 | \n
| refund_days | \nint | \nThe number of days within a refund is possible. 0= no refund is possible at all. 30 the buyer may refund within 30 days after purchase. | \n14 | \n
For \"billing_type\" subscription or installments, these extra values are transferred:
\n| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| first_amount | \nfloat | \nThe gross amount the buyer agreed to pay. | \n30.00 | \n
| first_vat_amount | \nfloat | \nThe VAT amount of first_amount. | \n4.79 | \n
| other_amounts | \nfloat | \nThe second and following gross amounts the buyer agreed to pay | \n30.00 | \n
| other_vat_amounts | \nfloat | \nFor the second and following VAT amounts. | \n4.79 | \n
| first_billing_interval | \ntime interval | \nThe period of time between the first and the second payment. | \n7_day | \n
| other_billing_intervals | \ntime interval | \nThe period of time between the second and the third payment (and subsequent payments). | \n1_month | \n
| next_payment_at | \ndate | \nDate of the next expected payment. | \n2016-03-30 | \n
| rebill_stop_noted_at | \ndate | \nDate on which the buyer's cancellation request was received. | \n2019-03-31 | \n
For upgrade purchases these additional fields are transferred:
\n| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| upgrade_type | \nstring(15) | \n“upgrade”=Change to more, expensive product, “downgrade”=Change to cheaper product, “special_offer”=Membership Offer, “switch_plan”=Tariff change, “package_change”=Package change | \n\n |
| upgraded_order_id | \nstring(15) | \nID of the “upgraded” order, i.e. the order ID the buyer has purchased the upgrade for. | \n1A2B3C4E | \n
| upgraded_order_date | \nstring(10) | \nDate of the upgraded order. | \n30.2013-03-31 | \n
| upgraded_order_time | \nstring(8) | \nTime of the upgraded order. | \n15:57:34 | \n
| upgraded_order_date_time | \nstring(19) | \nDate and time of the upgraded order. | \n2013-03-31 15:57:34 | \n
| upgraded_buyer_id | \nint | \nID of the buyer who placed the original order. This is usually the same as the current order, but may be different if the buyer has entered a different name. | \n1234 | \n
| upgraded_email | \nstring(63) | \n\n | user@domain.com | \n
| upgraded_address_first_name | \nstring(39) | \n\n | Claus | \n
| upgraded_address_last_name | \nstring(39) | \n\n | Meyer | \n
| upgraded_product_id | \nint | \n\n | 15332 | \n
| upgraded_product_name | \nstring(63) | \n\n | Instant Happiness | \n
| upgraded_product_id_2 | \nint | \n\n | 16331 | \n
| upgraded_product_name_2 | \nstring(63) | \n\n | Wealth – the Guide | \n
| upgraded_product_id_3 | \nint | \n\n | 12332 | \n
| upgraded_product_name_3 | \nstring(63) | \n\n | The Wealth Action Plan | \n
| and so on | \n\n | \n | \n |
| delivery_date | \ndate | \nThe date, when the new product should be delivered and access to the previous (upgraded) product should be stopped. If empty, access to the new product should be granted immediately. | \n(empty) or 2014-03-12 | \n
| upgraded_order_paid_until | \ndate | \nFor upgrade_type “switch_plan” only. The previous order is paid until this date. | \n2014-03-12 | \n
This section only applies, if Digistore24 delivers a license key together with your product. These data is only transferred for order events, not for other events like affiliation events.
\nIf no license key is delivered with your product, these parameters are omitted.
\n| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| license_id | \nint | \nUnique ID for the license. | \n12345678 | \n
| license_key | \nstring(255) | \nThe license key displayed to the customer. The format varies with the creation method.\n \n | \n26WBC-694J5-N7BBG-9LN4V-HBD9E-TVPEE-H38F9-D72CB | \n
| license_created | \ndate | \nThe date the license key was created. | \n2012-12-15 21:09:28 | \n
| license_key_type | \nenum | \nPossible values: list – the key was taken from a list of keys you have uploaded to Digistore24; random – Digistore24 has created the key randomly and unique; remote – Digistore24 has fetched the key from your server via http request | \nrandom | \n
| license_data_first_name license_data_last_name license_data_email license_data_product (for license key type list and random) | \nstring(each) | \nFor license key types “list” and “random”, Digistore24 sets the parameters to the values corresponding to the purchase. | \n\n |
| license_data_KEY1 license_data_KEY1_label license_data_KEY2 license_data_KEY2_label license_data_KEY3 license_data_KEY3_label …..(for license key type remote) | \nstring (each) | \nFor license key type “remote” your license server may deliver license data as key-value pairs. Example: Your name: Myers Your key: ooZai8oh Then Digistore24 adds license data in this way: license_data_XX1=Myers\n license_data_XX1_label=Your name; license_data_XX2=ooZai8oh; license_data_XX2_label=Your key XX1/XX2 are random keys. \n | \n\n |
\nLicense data and addon products\n\nIf there is more than one product part of a purchase, then for the second product a “_2” is added to the parameter name, e.g.: license_key_2 For the third addon product, a “_3” is added. And so on.
\n
| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| coupon_id | \nInt | \nID of the coupon. | \n12345 | \n
| coupon_code | \nstring(64) | \nThe code used to redeem the coupon. | \nDS11 22AA BB44 55CC DD66 | \n
| coupon_amount_total | \nfloat | \nThe amount of the coupon. | \n50.00 | \n
| coupon_amount_left | \nfloat | \nThe unused amount of the coupon. | \n17.33 | \n
| coupon_currency | \nstring(7) | \nThe currency code of the coupon. | \nEUR | \n
| coupon_code_2 | \nstring(64) | \nThe code of the second coupon of the purchase (if applicable). | \n\n |
| coupon_amount_total_2 | \nfloat | \n… | \n\n |
| coupon_amount_left_2 | \nfloat | \n… | \n\n |
| coupon_currency_2 | \nstring(7) | \n… | \n\n |
| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| coupon_id | \nInt | \nID of the coupon bought in this purchase. | \n12345 | \n
| coupon_code | \nstring(64) | \nThe code of the coupon bought in purchase. | \nDS11 22AA BB44 55CC DD66 | \n
| voucher_code | \nstring(64) | \nThe tracking voucher code of the coupon. | \ncoupon_12345 | \n
| used_coupon_code | \nString(64) | \nThe coupon code used for this purchase. | \nDS11 22AA BB44 55CC DD66 | \n
| used_coupon_id | \nInt | \nThe ID of the coupon used for this purchase. | \n1122 | \n
This section only applies, if Digistore24 delivers E-tickets together with your product. These data are only transferred for order events, not for other events like affiliation events.
\nPlease note that there is also a separate IPN notification for created and updated E-tickets. The IPN data described here are transferred for the order IPN notifications.
\nIf no E-ticket is delivered with your product, these parameters are omitted.
\nIf the user opens the URL in the web browser, he may be asked for his name (if no name is known for the E-ticket). Then the ticket will be saved on his/her computer.
\nPlease do NOT use instructions like “Right click the link and select save” because the user may not be able to enter his name.
\n| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| eticket_date | \ndate | \nDate of the event (of the 1st product of the order). | \n2015-12-27 | \n
| eticket_date_2 | \ndate | \nDate of the event (of the 2nd product of the order). | \n2015-12-27 | \n
| eticket_date_3 | \ndate | \nDate of the event (of the 3rd product of the order). | \n2015-12-27 | \n
| and so on | \n\n | \n | \n |
| eticket_hint | \nstring(127) | \nHint/time on the event (of the 1st product of the order). | \n7:00 am (Room 174) | \n
| eticket_hint_2 | \nstring(127) | \nHint/time on the event (of the 2nd product of the order). | \n7:00 am (Room 174) | \n
| eticket_hint_3 | \nstring(127) | \nHint/time on the event (of the 3rd product of the order). | \n7:00 am (Room 174) | \n
| and so on | \n\n | \n | \n |
| eticket_url | \nstring(255) | \nURL to download the E-ticket as an pdf-file (if it is created for the 1st product of the order). | \nhttps://www.digistore24.com/eticket/file009382586171.pdf | \n
| eticket_url_2 | \n…same for the 2nd product of the order. | \n\n | \n |
| eticket_url_3 | \n…same for the 3rd product of the order. | \n\n | \n |
| (and so on) | \n\n | \n | \n |
| eticket_url_B | \n2nd E-ticket of the 1st product. | \n\n | \n |
| eticket_url_C | \n3rd E-ticket of the 1st product. | \n\n | \n |
| eticket_url_D | \n4th E-ticket of the 1st product. | \n\n | \n |
| … | \n\n | \n | \n |
| eticket_url_Z | \n26th E-ticket of the 1st product. | \n\n | \n |
| eticket_url_ZA | \n27th E-ticket of the 1st product. | \n\n | \n |
| eticket_url_ZB | \n28th E-ticket of the 1st product. | \n\n | \n |
| … | \n\n | \n | \n |
| eticket_url_ZZ | \n52nd E-ticket of the 1st product. | \n\n | \n |
| eticket_url_ZZA | \n53rd E-ticket of the 1st product. | \n\n | \n |
| … | \n\n | \n | \n |
| eticket_url_ZZZ | \n78th E-ticket of the 1st product. | \n\n | \n |
| eticket_url_ZZZA | \n79th E-ticket of the 1st product. | \n\n | \n |
| (and so on) | \n\n | \n | \n |
| eticket_url_2_B | \n2nd E-ticket of the 2nd product. | \n\n | \n |
| eticket_url_3_B | \n2nd E-ticket of the 3nd product. | \n\n | \n |
| eticket_url_4_B | \n2nd E-ticket of the 4nd product. | \n\n | \n |
On the order form, the user can be asked for a newsletter subscription (see the settings in the product editor, Tab \"Order form\").
\n| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| newsletter_choice | \nstring(15) | \nnone = no newsletter optin-checkbox was shown. optin = the buyer checked the newsletter optin-checkbox.optout = the buyer did not check the newsletter optin-checkbox (but it was present on the order form). | \noptin | \n
| newsletter_choice_msg | \nstring(63) | \nThe selected option as readable text (in the language of the order). | \nNewsletter subscribed. | \n
| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| customer_affiliate_url | \nstring(127) | \nIf you have enabled the “Customers to Affiliates”-program for the purchased main product, this links contains the invitation URL for the customer to become an affiliate. If he follows the URL, a Digistore24 account will be created. | \nhttps://www.digistore24.com/become_affiliate/abc123/xyz789 | \n
| customer_affiliate_name | \nstring(31) | \nIf the buyer has a Digistore24-account, this is the account name. This does not necessarily mean, that he has established affiliations with your products. | \nuser12345 supermerchant claus | \n
| customer_affiliate_promo_url | \nstring(127) | \nThe promolink for the affiliate. | \n\n |
| Parameter name | \nDescription | \n
|---|---|
| ipn_config_id | \nThe ID of the IPN connection – as it occurs, for example, in the edit link (https://www.digistore24-app.com/vendor/settings/ipn/edit/ID) or is returned by ipnSetup() as ipn_config_id. | \n
| ipn_config_domain_id | \nIf the IPN connection was created via the Digistore API: The value passed as domain_id for ipnSetup(). | \n
| ipn_config_api_key_id | \nIf the IPN connection was created via the Digistore API: The numerical ID of the API key used. For the API key 12345-xxxxxxx, the ID would be 12345 | \n
| ipn_config_products_ids | \n“All” (if the connection applies to all products) or the list of product IDs separated with commas – without spaces e.g. 123,456,789 | \n
| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| ipn_version | \nfloat | \nCurrent version of the IPN-interface | \n1.2 | \n
| api_mode | \nstring(4) | \nIndicates test mode. Possible value is only “live“. | \nlive | \n
| string(63) | \nEmail-address of the new affiliate. | \nuser@domain.com | \n|
| affiliate_name | \nstring(31) | \nDigistore24-ID of the new affiliate. | \nmaxmarketer | \n
| affiliate_link | \nstring(127) | \nThe new affiliate’s promolink | \nhttps://promo.123.maxmarketer.digistore24.com | \n
| referring_affiliate_name | \nstring(31) | \nName of the referring affiliate (if any) | \nanothermarketer | \n
| language | \nstring(2) | \nThe new affiliate’s language | \nde | \n
| order_id | \nstring(31) | \n“affiliate-“, followed by the affiliate-ID. | \naffiliate-12345 | \n
| order_date | \nstring(10) | \n\n | 2013-03-31 | \n
| order_time | \nstring(8) | \n\n | 15:57:34 | \n
| order_date_time | \nstring(19) | \n\n | 2013-03-31 15:57:34 | \n
| address_first_name | \n\n | \n | \n |
| address_last_name | \n\n | \n | \n |
| address_id | \n\n | \n | \n |
| address_street | \n\n | Street name and street number. Empty if no address was specified. | \nMainstr. 123a | \n
| address_street_name | \n\n | Street name only. | \nMainstr. | \n
| address_street_number | \n\n | Street number only. | \n123a | \n
| address_city | \n\n | Empty if no address was specified. | \n\n |
| address_state | \n\n | Empty if no address was specified. | \nKlausMeier | \n
| address_zipcode | \n\n | Empty if no address was specified. | \n123456,78900,9865 | \n
| address_country | \n\n | Empty if no address was specified. | \n\n |
| address_company | \n\n | Empty if no company was specified. | \n\n |
| product_id | \n\n | Unique ID of the product. | \n3323323 | \n
| product_language | \n\n | Language code of the product’s language. | \nen | \n
| product_name | \nstring(63) | \nReadable name of the product. | \nFast wealth guide | \n
Note: The address data may be missing, if an E-ticket is created, but no participant data are available. When the buyer enters the participant data, a new IPN-notification is sent with the event “E-ticket” and action “update”.
\n| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| ipn_version | \nfloat | \nCurrent version of the IPN-interface. | \n1.2 | \n
| api_mode | \nstring(4) | \nIndicates test mode. Possible value is only “test“. | \ntest | \n
| action | \nstring(15) | \nPossible values: create; update; use; cancel_use; revoke; cancel_revoke | \n\n |
| address_email | \nstring(63) | \nEmail-address of the new affiliate. | \n\n |
| address_first_name | \nstring(39) | \n\n | \n |
| address_last_name | \nstring(39) | \n\n | \n |
| address_salutation | \nstring(1) | \nPossible values: F – for Mrs. ; M – for Mr. | \n\n |
| address_title | \nstring(31) | \n\n | Prof. Dr. Dr. | \n
| merchant_id | \nint | \nUnique ID of the vendor. | \n\n |
| merchant_name | \nstring(31) | \nUnique Digistore24-name of the vendor. | \n\n |
| order_id | \nstring(31) | \nThe order-ID followed by a dash and the E-ticket-ID. | \n\n |
| order_date | \nstring(10) | \nDate of the order. | \n\n |
| order_time | \nstring(8) | \nTime of the order. | \n\n |
| order_date_time | \nstring(19) | \nDate and time of the order. | \n\n |
| order_is_paid | \nstring(1) | \nY The order is paid or will be paid soon (in case of subscription or installments). N The order is not paid (e.g. the payment was refunded or charged back). | \nY | \n
| order_billing_status | \nstring(15) | \nPossible values: paying (only for rebilling; Payments are active); aborted; unpaid; reminding; completed (only for single payment and installments. The single payment is completed / All; installment payments are completed) | \ncompleted | \n
| product_id | \nint | \n\n | \n |
| product_name | \nstring(63) | \n\n | \n |
| language | \nstring(2) | \n2-letter language code of product. | \n\n |
| note | \ntext | \n\n | \n |
| eticket_id | \nint | \nShort ID of the E-ticket (unique). | \n\n |
| eticket_code | \nint | \nLong ID of the E-ticket (includes the short ID and additionally an authentication code). | \n10032261877243293591 | \n
| eticket_no | \nint | \nNumber of this E-ticket in the current order position (1 for the first eticket, 2 for the second, …) | \n1 | \n
| eticket_count | \nint | \nTotal number of E-tickets in the current order position. | \n3 | \n
| eticket_is_blocked | \nstring(1) | \nY The eticket has been revoked manually; N The E-ticket is usable. | \nN | \n
| eticket_used_at | \ndate | \nEmpty (if not used) or a date. | \n\n |
| eticket_created_at | \ndate | \nEmpty (if not used) or a date. | \n\n |
| eticket_modified_at | \ndate | \nEmpty (if not used) or a date. | \n\n |
| eticket_url | \nurl | \nThe URL to download the E-ticket as a pdf-document. | \n\n |
| location_id | \nint | \n\n | \n |
| location_name | \nstring[63] | \n\n | \n |
| location_note | \ntext | \n\n | \n |
| location_map_image_url | \nstring[255] | \n\n | \n |
| location_country | \nstring[2] | \nISO-Code of the country of the location of the seminar. | \nDE | \n
| location_address | \ntext | \n\n | \n |
| location_latitude | \nstring[15] | \n\n | 43.132472 | \n
| location_longitude | \nstring[15] | \n\n | 11.1109412 | \n
| location_directions | \ntext | \n\n | \n |
Note: The address fields may be missing. They are only added if the custom form contains inputs of an address type (like first name, last name, salutation, street, city and so on).
\n| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| ipn_version | \nfloat | \nCurrent version of the IPN-interface. | \n1.2 | \n
| api_mode | \nstring(4) | \nIndicates test mode. Possible value is only “test“. | \ntest | \n
| action | \nstring(15) | \nPossible value is only “create“. | \ncreate | \n
| order_id | \nstring(31) | \n“E-ticket-“ followed by the E-ticket-ID. | \naffiliate-1234567890 | \n
| order_date | \nstring(10) | \nDate of the order. | \n2013-03-31 | \n
| order_time | \nstring(8) | \nTime of the order. | \n15:57:34 | \n
| order_date_time | \nstring(19) | \nDate and time of the order. | \n2013-03-31 15:57:34 | \n
| address_email | \nstring(63) | \nEmail-address of the new affiliate. | \nuser@domain.com | \n
| address_first_name | \nstring(39) | \n\n | \n |
| address_last_name | \nstring(39) | \n\n | \n |
| address_salutation | \nstring(1) | \nPossible values: F – for Mrs.; M – for Mr. | \nF | \n
| (and so on) | \n\n | \n | \n |
| merchant_id | \nint | \nUnique ID of the vendor. | \n39499382 | \n
| merchant_name | \nstring(31) | \nUnique Digistore24-name of the vendor. | \nKlausMeier | \n
| order_id | \nstring(31) | \nThe order-ID followed by a dash, the form id or the form number. | \nA1B2D3E4-12345-1 | \n
| order_date | \nstring(10) | \nDate of the order. | \n2013-03-31 | \n
| order_time | \nstring(8) | \nTime of the order. | \n15:57:34 | \n
| order_date_time | \nstring(19) | \nDate and time of the order. | \n2013-03-31 15:57:34 | \n
| order_billing_status | \nstring(15) | \nPossible values:paying (only for rebilling; Payments are active); aborted; unpaid; reminding; completed (only for single payment and installments. The single payment is completed / All installment payments are completed) | \ncompleted | \n
| product_id | \nint | \n\n | \n |
| form_no | \n\n | \n | \n |
| form_count | \n\n | \n | \n |
| data-XXXXX | \nstring | \nFor each field of the custom form, a field data-XXXXX is added, where XXXXX is the (internal) name of the field. | \n\n |
| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| ipn_version | \nfloat | \nCurrent version of the IPN-interface. | \n1.2 | \n
| api_mode | \nstring(4) | \nIndicates test mode. Possible value is only “test“. | \ntest | \n
| merchant_id | \nint | \nUnique ID of the vendor. | \n39499382 | \n
| merchant_name | \nstring(31) | \nUnique Digistore24-name of the vendor. | \nJohnSmith | \n
| product_ids | \nstring(10000) | \nComma-separated list of the vendor's product-IDs (or empty, if the vendor has not yet created any products). | \n123456, 123456, 78900,9865 | \n
We add to our request a SHA-512-signature. This allows you to verify the integrity of the transferred data.
\n\nThe ipn request contains these parameters:
\n| Parameter name | \nValue | \n
|---|---|
| buyer_email | \nclaus@domain-xyz.de | \n
| payment_id | \nPAYID-39-22012 | \n
| order_id | \n273732 | \n
| transaction_amount | \n17.00 | \n
| transaction_currency | \nUSD | \n
To create the string to hash
\nbuyer_email=claus@domain-xyz.dexxxxxorder_id=273732xxxxxpayment_id=PAYID-39-22012xxxxxtransaction_amount=17.00xxxxxtransaction_currency=USDxxxxx
342770076245D14ED7DF4D2E5D82216D7EDF8F9E7969B5964C9C5DCB53E962BBECD545E90422B5329C69554FD8B1A7E7410736615FCA7FB5CBB3624CC016E4BC
For every IPN call, the SHA-signature is sent as parameter “sha_sign”.
\nYou may use the Digistore24 IPN system for managing subscription and rebilling on your platform - e.g. on your membership area.
\nUse these events to manage access to your product based on the customer’s payment status:
\nFor subscription cancellations or refunds, use the following event:
\nFor details on how to set up an IPN connection in Digistore24, see our IPN setup guide.
\nThese parameters (and others) are sent as IPN data
\n\nCreate an account for these user data.
\nIf you want to pass user data to Digistore24, please see this article.
\nWhen implementing your platform, please be aware that a buyer may have multiple products.
\nIt’s essential that you store the Digistore24 order id and track the order status for each order id.
\nExample:
\n| Step | \nAction | \nChange | \nEvent | \n
|---|---|---|---|
| 1 | \nbuyer buys product A | \norder id AA11AA11 created | \non_payment sent for order AA11AA11 | \n
| 2 | \nbuyer buys product B | \norder id BB22BB22 created | \non_payment sent for order BB22BB22 | \n
| 3 | \nbuyer cancels AA11AA11 | \nrebilling stopped for AA11AA11 | \non_payment_missed sent for AA11AA11 | \n
If you implement product access on an account level, the buyer may end up without product access after step 3.
Please implement product access on an order level, so that a buyer may have multiple orders.
\nFor upgrades and downgrades, the on_payment_missed event is not sent.
\nAccess to the new product should be granted at a certain date.
\nFor upgrade and downgrades, Digistore24 passes these IPN parameters:
\n| Parameter name | \nType | \nDescription | \nExample value | \n
|---|---|---|---|
| upgraded_order_id | \nstring(15) | \nID of the “upgraded” order, i.e. the order ID the buyer has purchased the upgrade for. | \n1A2B3C4E | \n
| delivery_date | \ndate | \nThe date when the new product should be delivered and access to the previous (upgraded) product should be stopped. If empty, access to the new product should be granted immediately. | \n(empty) or 2014-03-12 | \n
Revoke access to the product of the previous order (upgraded_order_id) on the given date (delivery_date).
At the same time grant access to the new order (order_id).
","user_segment_ids":[]},{"id":32488596961425,"url":"https://devdigistore24.zendesk.com/api/v2/help_center/en-us/articles/32488596961425.json","html_url":"https://dev.digistore24.com/hc/en-us/articles/32488596961425-Billing-on-demand","author_id":21104399012497,"comments_disabled":false,"draft":false,"promoted":false,"position":2,"vote_sum":-2,"vote_count":4,"section_id":32477029106449,"created_at":"2025-02-07T15:40:18Z","updated_at":"2026-08-09T23:33:05Z","name":"Billing on demand","title":"Billing on demand","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2025-08-28T08:49:59Z","user_segment_id":null,"permission_group_id":12152305040273,"content_tag_ids":[],"label_names":[],"body":"With billing on demand, payments can be made flexibly and without user interaction.
\nFor billing on demand to happen, at least one order with these properties must be available:
\nCreate a product that describes the type of rebilling. You can use placeholders to do this such as:
\n[COUNT] minutes of video watched on demand.
\nThis product can, but does not have to, have a payment amount. It can be a 0 EUR product or have a different payment plan.
\nThere are several options to ensure that the payment method you are using supports rebilling:
\nSelect settings[force_rebilling] = Y
\nAdd the GET parameter force_rebilling=Y to the order form URL, e.g.:
\nhttps://www.digistore24.com/product/12345?force_rebilling=Y
\nAfter the customer has paid, you can use the order ID as a reference order for billing on demand.
\nUse the API function createBillingOnDemand() to make any additional payments.
","user_segment_ids":[]},{"id":32581970107793,"url":"https://devdigistore24.zendesk.com/api/v2/help_center/en-us/articles/32581970107793.json","html_url":"https://dev.digistore24.com/hc/en-us/articles/32581970107793-Passing-access-data-to-Digistore24","author_id":21855521203985,"comments_disabled":false,"draft":false,"promoted":false,"position":3,"vote_sum":7,"vote_count":27,"section_id":32544282072977,"created_at":"2025-02-11T13:49:23Z","updated_at":"2026-09-18T02:03:50Z","name":"Passing access data to Digistore24","title":"Passing access data to Digistore24","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2025-03-19T09:10:35Z","user_segment_id":null,"permission_group_id":12152305040273,"content_tag_ids":[],"label_names":[],"body":"Your server's reply to an ipn call should be a simple text.
\nTo indicate that the call is successful, just return this response:
\nOK
You may add extra data, e.g.:
\n\n OK
thankyou_url: https://www.some-domain.com/thank-you
username:\n some-user-name\n \n password: a-secret-password
loginurl:\n https://www.some-domain.com/login headline: You access data\"\n
By default, the access data are shown in the Digistore24 order confirmation email and on the invoice.
\nTo not show the access data on the invoice, add a line:
\nhide_on: invoice
If you want to create more than one membership account, just add more username/password sets. Append \"_2\" for the second account, \"_3_\" for the third, and so on.
\nExample:
\n\n OK
thankyou_url: https://...
username: some-user-name\n \n password: a-secret-password
loginurl:\n https://www.some-domain.com/login\n username_2: another-user-name password_2: another-password loginurl_2: https://another-url.com/login headline: You access data\"
You may add any kind of data.
\nThe response needs to start with OK.
\nYou may add any key-value pairs.
\nText needs to be plain text and cannot have HTML tags.
\nOK \n headline: Your software
Your license key: some-key\n Your software package: a package name
Normal affiliate attribution has a drawback because you cannot guarantee that the referred buyer will end up purchasing the product with the same device they used to open the affiliate's promolink.
\nAs a result, the cookie set in the customer's browser when the promolink was accessed cannot be read if a customer purchases the product on another device - this means that the affiliate is not recognized and thus not remunerated.
\nThis problem can be solved in three ways provided the customer entered data into an opt-in page before changing the device:
\nTo implement the third point on this list, please follow the guide below.
\nEric enters data into an autoresponder on his smartphone. This means that he clicks on Anton's Digistore24 promolink on his smartphone and then lands on an opt-in form. The cookie is then set on his smartphone.
\nEric then receives an email. However, he reads it on his PC and clicks on the link to the sales page contained in the email. He then gets to the order form using another link on the sales page. Nevertheless, Digistore24 should know that Anton was the one to refer the product to Eric. This is where multi-device affiliate tracking comes into play.
\nThese steps are necessary to ensure the affiliate is still recognized for the purchase, even if the buyer switches from their smartphone to their PC.
\nA description of how to get your users' Digistore API keys in your application is given here.
\nCall up your user's tracking code using the API function renderJsTrackingCode().
\nTo do this, run the following PHP code on your server:
\n <?php
define( 'YOUR_API_KEY', '123-xxxxxxxx'\n );
require_once 'ds24_api.php';
try {
\n $api = DigistoreApi::connect( YOUR_API_KEY );
\n $data = $api->renderJsTrackingCode();
\n $api->disconnect();
\n $script_code = $data->script_code;
// Embed\n this tracking code into the platform user's
\n // landing page or your software.
} catch (DigistoreApiException\n $e) {
the( $e->getMessage() );
}
The tracking code may look like this:
\n<script\n src=\"https://www.digistore24.com/track_info/123/abcdef.js?input=NAME\"></script>
Embed this JavaScript code into the page where prospective buyers first visit your platform, e.g. the homepage. Add your own JavaScript code, as described in the next section.
\nCreate a JavaScript code that is also embedded onto the same page. The JavaScript code records the affiliate and stores them together with the buyer data in your database.
\nFor example:
\n<script>
function myStoreAffiliate( affiliate, campaignkey,\n tracking_param )
{
// store the affiliate here\n together with the
// data of the prospective\n buyer.
}
window.addEventListener('digistore24_affiliate',\n function (event) {
var affiliate =\n event.detail.affiliate;
var campaignkey =\n event.detail.campaignkey;
var tracking_param =\n event.detail.tracking_param;
myStoreAffiliate(\n affiliate, campaignkey, tracking_param
);
}, false);
</script>
If you direct the prospective buyer to the Digistore order form, you need to attach the affiliate data to the order form URL:
\nhttps://www.digistore24.com/product/12345/?aff=AFFILIATE&cam=CAMPAIGNKEY&ds24tr=TRACKING_PARAM
\n\nTip\n\nIf your user selects the product for the buy button on your platform, you can offer them their own Digistore products to choose from e.g. from a dropdown list. You can get the products via listProducts().
\n
You find the IPN log in the vendor view under Reports > Integrations (IPN).
\nThere is every IPN request listed – successful as well as failed ones.
\nAn IPN call is considered a success, if the Digistore24 server receives the text “OK” (upper case, without the quotes) from your server.
\nIf an IPN call fails, the Digistore24 server will retry for at least 20 times over the next 10 days. The first retry takes place after 3 minutes. If the calls continue to fail, the repeat interval increases up to 24 hours after 10 attempts.
\nFor several reasons, Digistore24 may repeat IPN calls. Possible reasons are:
\nPlease make sure your IPN script can handle multiple calls for the same IPN event.","user_segment_ids":[]},{"id":32489617516305,"url":"https://devdigistore24.zendesk.com/api/v2/help_center/en-us/articles/32489617516305.json","html_url":"https://dev.digistore24.com/hc/en-us/articles/32489617516305-Delivery-workflow","author_id":21104399012497,"comments_disabled":false,"draft":false,"promoted":false,"position":4,"vote_sum":1,"vote_count":1,"section_id":32477029106449,"created_at":"2025-02-07T16:11:22Z","updated_at":"2025-08-28T08:53:51Z","name":"Delivery workflow","title":"Delivery workflow","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2025-08-28T08:53:51Z","user_segment_id":null,"permission_group_id":12152305040273,"content_tag_ids":[],"label_names":[],"body":"
Digistore24 offers an api to connect your fullfillment software. You agents are preparing the packages and handing them over to the parcel delivery service. Via api calls to Digistore24 your software retrieves data on the deliveries and updates the delivery status.
\nUsing the api, you can make sure
\nYou are selling physical products, which are to be delivered, like books or supplements.
\nYou have a software managing your delivery process.
\nFor every shipped order, Digistore24 creates one or more \"deliveries\".
\nDigistore24 creates a delivery for each order position, which is to be shipped. If you have more then one shipped order position on a purchase, you may want to group deliveries.
\nEvery delivery has a type indicating the current status. Possible values for delivery type are:
\nIn Digistore24, you need to have a product being sold.
\nMake sure, the product type is set correctly to a delivered product type (like a book, a dvd set or supplements).
\nUse api end point listDeliveries() to get a list of open deliveries.
\nTo only get open and not completed deliveries, use parameter:
\nsearch[type]=request,partial_delivery
Cycle through the list of deliveries, processing 3. Mark delivery as \"in progress\" for each delivery.
\nTo make sure, a delivery is only handeled once, use getDelivery() to set the delivery as being processed. Use parameter
\nset_in_progress=Y
In Digistore24's response, evaluate is_set_in_progress
\nUse updateDelivery() to mark the package as shipped and to (optionally) provide parcel tracking data.
\nMake sure, you add the quantity of the product delivered:
\ndata[add_quantity_delivered]=N
If - after the api call - no quantity is left to be delivered, then the data[type] is set to: delivery - indicating, that the delivery is complete.
\nIf not all order positions have been delivered, the data[type] ist set to: partial_delivery - indicating, that there is a quantity left to be delivered.
\nOptionally you may add package tracking information - e.g. tracking[0][parcel_service]=DHL and tracking[0][tracking_id]=123456789 - see updateDelivery() for details.
\nThen proceed with step 3 for the next delivery.
\nTo minimize the number of packages sent, search for delivery with the same address.
\nUse listDeliveries() with these parameters:
\nsearch[type]=request,partial_delivery
search[same_address_as]=DELIVERY_ID
Replace DELIVERY_ID with the id of a delivery.
\nYou'll get a list of deliveries shipped to the same address.
\nThe delivery with the given delivery id is not included in the list.
\nIn the Digistore24 backoffice, you may monitor the deliveries in the vendor view on Reports - Deliveries.
","user_segment_ids":[]},{"id":32490319551377,"url":"https://devdigistore24.zendesk.com/api/v2/help_center/en-us/articles/32490319551377.json","html_url":"https://dev.digistore24.com/hc/en-us/articles/32490319551377-Prepaid-token-payments-with-Digistore24","author_id":21104399012497,"comments_disabled":false,"draft":false,"promoted":false,"position":5,"vote_sum":-1,"vote_count":3,"section_id":32477029106449,"created_at":"2025-02-07T16:37:09Z","updated_at":"2025-03-19T09:08:03Z","name":"Prepaid token payments with Digistore24","title":"Prepaid token payments with Digistore24","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2025-02-18T11:37:18Z","user_segment_id":null,"permission_group_id":12152305040273,"content_tag_ids":[],"label_names":[],"body":"AI assistant applications and SAAS platforms often use prepaid tokens or credits. For example, the user may buy 500 API tokens. If the balance drops below 50 API tokens, another 500 API tokens may be added and billed automatically.
\nThe workflow for purchasing api tokens is as follows:
\nIn the download package of the Digistore24 api connector, you will find PHP code examples.
\nThe user's first contact is with your platform. Usually you'll want them to create an account there.
\nThe api function createBuyUrl allows you (among other things) to
\nThe Digistore24 API will provide a checkout url. Direct the user to this url to perform the payment.
\nSet up a Digistore24 product for buying api tokens.
\nThe api request creates a checkout url to bill 50 USD as a single payment from the buyer. Buyer name and email adresse are prefilled.
\nUrl: https://www.digistore24.com/api/createBuyUrl:
\nHTTP header:
\nPost data:
\nYou can see more parameters here.
\nEither add a webhook or a generic IPN to securely receive the payment status.
\nFor ease of implementation, we recomment this setup.
\nIn the webhook setup form, you should enter the parameter name for tracking[custom] next to Custom parameter.
\nIf the parameter for \"Event\" is \"payment\", book the token, because you received the payment.
\nIf you later receive an event refund or chargeback, then the payment has been cancelled.
\nThe generic IPN integration is slightly more complex, but it does transfer much more data. The value of tracking[custom] is transferred as parameter \"custom\".
\nIf the parameter \"Event\" is \"on_payment\", book the token, because you received the payment.
\nIf you later receive on_refund or on_chargeback, then the payment has been cancelled.
\nYou are responsible for managing the token balance.
\nIn your application, you implement a logic to automatically add new tokens, if the balance drops below a certain limit.
\nBy default, billing on demand is disabled for your account. If you want to use billing on demand, contact our support to enable it. Please add a description of your platform and the current development status or the planned release date to your request.
\nWhen implementing auto recharging, make sure that:
\nThis api request bills for 50 USD from the buyer from step 2.
\nUrl: https://www.digistore24.com/api/createBillingOnDemand
\nHTTP header:
\nPost data:
\nYou can see more parameters here.
\n