Autodesk Developer Network

Autodesk App Store: IPN notification format

Instant Payment Notification (IPN) is a message service that automatically notifies you about purchasing
transactions related to your App. You can use it to automate back-office and administrative functions, such as automatically fulfilling orders and providing customers with order status or to send the serial number for activation, etc. 

How it works

You need to create an IPN listener web service and then specify the URL of the listener in your profile in the
Autodesk App Store. The Autodesk App Store then sends notifications of all transaction-related events to your URL.

IPN (Instant Payment Notification) specification for Paid Apps

Your web service endpoint should accept:

HTTP Headers

Method

POST

Data Format

x-www-form-urlencoded

 

Body Structure

Parameter Name

Type

Notes

Sample value

appId

Integer

App's Unique ID in the Autodesk App Store. See note (2)

2024453975166401172

appLanguage

Text

Language of the it can be one of: cs, de, en, es, fr, hu, it, ja, ko, pl, pt, ru, zh-CN, zh-TW

en

appOS

Text

The operating selected for an app, it can be one of: Win32, Win64, Web, Mac, Win32_64, Linux

Win32_64

auth

Text

 

A6P4OiUSwAL6901WUc3VK.fiUaYTR5AND5h.XpBaMqrI8gSmid.
n0tFsfAMP6u3unDXUuiABwGtZWQlN.RFtDcA

business

Text

 

Mypaypalid@company.com

buyer_adsk_account

Text

Autodesk registered buyer’s email address

useremail@company.com

charset

Text

 

windows-1252

custom

Integer

 

200703030249937

first_name

Text

 

UserFirstName

form_charset

Text

 

UTF-8

handling_amount

Double

 

0.00

item_name

Text

App name

MyAppNameInStore

item_number

Text

App’s legacy ID in the Autodesk App Store for apps created before 20th March 2016, else it will be the same as appId parameter. See note (2)

 

appstore.exchange.autodesk.com screenshot en

last_name

Text

 

Userlastname

mc_currency

Text

 

USD

mc_fee

Double

 

0.43

mc_gross

Double

Payment amount completed by the buyer.

5.50

notify_version

Double

 

3.8

payer_email

Text

 

name@company.com

payer_id

Text

 

NEH6BJPL9LBYG

payer_status

Text

 

verified

payment_date

URL Encoded UTC Date

 

23%3A36%3A36+Jan+11%2C+2014+PST

payment_fee

Double

 

0.43

payment_gross

Double

 

5.50

payment_status

Text

 

Completed

payment_type

Text

 

instant

protection_eligibility

Text

 

Ineligible

quantity

Integer

 

1

receiver_email

Text

 

publihserPaypal@company.com

receiver_id

Text

 

GDGRD3PAZBMD8

residence_country

Text

 

US

shipping

Double

 

0.00

tax

Double

 

0.50

transaction_subject

Integer

 

200703030249937

txn_id

Text

 

0AG18756HD086633A

txn_type

Text

Represents the kind of transaction for which the IPN message was sent. See notes (1) 

web_accept

verify_sign

Text

Encrypted string used to validate the authenticity of the transaction.

AFcWxV21C7fd0v3bYYYRCpSSRl31AsmAEVMn38537K1tk5tZM
nvtnW6

 

Important notes:

  1. Below are additional variables that are used for Instant Payment Notifications:

Variable

Value

Description

txn_type

"subscr_signup"

This Instant Payment Notification is for a subscription sign-up.

"subscr_cancel"

This Instant Payment Notification is for a subscription cancellation.

"subscr_payment"

This Instant Payment Notification is for a subscription payment.

"web_accept"

This Instant Payment Notification is for a payment for paid App (Perpetual, not on subscription).

subscr_id

Transaction-specific

ID generated for the subscription.

  1. If this is your first time to set up IPN listener in AppStore, please parse the “appId” parameter to located your App. If you already have a running IPN which parse the item_number to find your app, you can continue to use this, please notice the “item_number” for apps created after 20th March 2016 will be the same as “appId” (eg: 2024453975166401172), which has no suffix for OS or Language.

IPN (Instant Payment Notification) specification for Free/Trial Apps

Free and Trial apps must expose a similar endpoint for IPN, but the number of parameters is reduced.

For Trial apps the IPN is simplified with only: txn_id, custom, payment_status, item_number, buyer_adsk_account, payment_gross, txn_type, appId, appLanguage, appOS. The txn_type could be one of the following values “FREE”, “Free30DayTrial” or “TRIAL” for Free/Trial IPN.

For Free Apps you can only get the ID of the App (unique id of the App in Autodesk App Store) and the user who has downloaded the App.

More information

The ADN team is here to help you be a successful publisher on Autodesk App Store. We’ll do whatever we can do to help you. You are welcome to email appsubmissions@autodesk.com if you have any further questions.