Syntax
ipnSetup
(
ipn_url,
name,
product_ids,
domain_id,
categories,
transactions,
timing,
newsletter_send_policy
)
Creates an IPN-connection.
Access rights
Full access required.
Parameters
ipn_url – Digistore24 sends the IPN notification to this URL (like for type “generic”)
name – the name listed on Digistore – e.g. your platform name
product_ids – “all” or a comma-separated list of product IDs
domain_id – used to delete the IPN connection. Also makes sure, that an IPN connection is not created twice for a specific user. The paid “API key/domain_id” is unique. Usually you use your platform name as domain ID. Or leave it blank (and then keep it blank)
categories – Transaction categories. Comma separated list with these values:
- orders
- affiliations
- e-tickets
- custom forms
-
transactions – Transaction types. Comma-separated list with these values:
- payment
- refund
- chargeback
- payment_missed
- rebill_cancelled
- rebill_resumed
- last_paid_day
- all – send events for all transactions (also for new transactions added later – if you use this, make sure that your service ignores unknown transactions).
default is: payment, refund, chargeback, payment_missed
-
timing – controls when the IPN notification is sent:
- before_thankyou (default): send IPN notification, before the buyer is directed to the thankyou page (or next upsell sales page). This slows down the order process and makes the buyer wait. On the other hand you can return order data, which is shown in the order confirmation email.
- Delayed: the IPN notification is in the queue and the buyer is directed to the next order step faster (thankyou page or upsell sales page). The IPN notification is usually sent within 2 minutes.
- sha_passphrase – string[63] – Password with which the parameters are signed. If the text “random” is passed, a random password will be generated (30 characters).The IPN parameters are signed with this password.
-
newsletter_send_policy – string – possible values:
- end_policy_send_always – send ipn always (this is the default).
- end_if_not_optout – send ipn, if there is NO opt-in checkbox OR the buyer checks it.
- end_if_optout – send ipn, if the buyer DOES NOT check the opt-in checkbox.
- end_if_optin – send ipn, if the buyer checks the opt-in checkbox.