This guide is for software developers and system administrators, who want to connect a vendor’s billing system to Digistore24.
Introduction
A buyer orders the product “Guide To Happiness”.
Then there will be:
- An order-ID for each order, e.g. A3NXHEHF. This order-ID is unique.
- A product-ID, e.g. 122343 for product “Guide to Happiness”. Each order of “Guide to Happiness” has the same product-ID 122343.
- A transaction-ID for each transaction and test payment. A transaction is a payment, a refund or a chargeback. This transaction-ID is unique.
Term explanation
Buyer
A buyer is the person in front of the computer screen, who buys your product.
Order
If a buyer buys one or more products using the same order form at the same time, this is one order.
An order consists of one initial sale and up to three upsells. These are referred to as “order items”.
Transaction
A transaction is a payment, a refund or a chargeback.
At Digistore24, we process one transaction for each order item.
Example: If a buyer buys an initial sale and the first upsell, then there are two transactions meaning two payments.
IPN Call
This 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.
Quick Integration Guide
Preparing the IPN script
- Download the IPN receiver script here.
- Review the script. Locate the comments and adjust the script according to the comments. Pay special attention to the “// EDIT HERE”-comments.
- Make sure the constant SHA_PASSPHRASE is set to a unique, non-guessable value.
- Put the script on your server. Note the URL, which will run the script on your server.
Creating an IPN connection in Digistore24
- Go to Settings > Integrations (IPN).
- Click Add new connection.
- Scroll down and click Generic.
- Enter a Name for the connection.
- Go to For products to select which products the IPN connection should be applied to.
- Go to Send notifications for to select for what kind of events notifications should be sent.
- Go to For order event to select for which order events notifications should be sent.
Note
Make sure the order events that you have specified in your script are selected here as well.
- As IPN URL, enter the URL which will run the script on your server.
- As IPN password, enter the SHA_PASSPHRASE of your script.
- As IPN timing, select “Before redirect to thank you page”.
- Make sure Active is set to Yes.
- Click Test connection and review the result.
- If the return says "OK", click Save. Otherwise, make the required changes and re-test the connection.
- Test your IPN setup.
- Make a test purchase.
- Check if the order is processed correctly on your server.
- Go to Reports > IPN to review the IPN log.
Updating your IPN setup
Use this procedure to update your existing IPN setup in Digistore24 when parameters or logic change.
-
Backup your existing setup.
-
Save a copy of the current IPN script.
- Go to Settings > Integrations (IPN).
- In the list of IPN connections, click the pencil icon next to the connection you want to update.
-
Note your existing Digistore24 IPN configurations, i.e. URL, IPN password, selected products and order events.
-
-
Update your IPN script.
-
Edit the IPN script as desired.
-
Set a new SHA_PASSPHRASE.
-
-
Upload your IPN script.
- Upload the updated IPN script to your server.
- Note the new IPN URL.
-
Update your Digistore24 settings.
- Go to Settings > Integrations (IPN).
- In the list of IPN connections, click the pencil icon next to the connection you want to update.
- Go to For products to review which products the IPN connection should be applied to.
- Go to Send notifications for to review for what kind of events notifications should be sent.
- Go to For order event to review for which order events notifications should be sent.
Note
Make sure the order events that you have specified in your script are selected here as well.
- Replace the old IPN URL with the new one.
- As IPN password, enter the new SHA_PASSPHRASE.
- Click Test connection and review the result.
- If the return says "OK", click Save. Otherwise, make the required changes and re-test the connection.
-
Test your IPN setup.
- Make a test purchase.
- Check if the order is processed correctly on your server.
- Go to Reports > IPN to review the IPN log.