v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB

Purchase API

Get Purchase V2

Retrieves all information about a particular purchase. When you make a call, you get a <code>PurchaseNotification</code> string that contains general purchase information, purchase item information, and other customized data (for example, x-parameters and license keys).<br />For XML examples and schemas, see the Additional Examples - Get Purchase V2.

get/purchase/getpurchase/v2

Query parameters

purchaseIdstring required

Unique ID of an existing purchase.

reimbursementIdstring

Any combination of numbers. A numerical value is required, but it does not affect the API call for paid orders. For fully or partially refunded orders, enter value 0 to receive a (partial) refund notification and value -1 to receive a paid order notification.

Headers

Accept'application/json' | 'application/xml'

Expected response format.

Response

PurchaseNotificationstring

The purchase notification as an escaped JSON-string. For schema definitions, see the Notification Reference.

ResultMessagestring

Optional result or error message.