Purchase Details (ProductV2)

This API provides purchase details from the ProductV2 service. It allows you to retrieve detailed information about a purchase using the purchaseToken. It is useful for obtaining the Order UID (which can be used in other APIs) and verifying the purchase status. This API does not require authentication.

Endpoint

Method	URL
GET	https://api.catappult.io/productv2/8.20250505/inapp/purchases/{purchase_token}

Authentication

No authentication required.

Path Parameters

Parameter	Type	Required	Description
purchase_token	string	Required	Purchase ID defined as token in the Purchase class of the SDK.

Response

Status	Description
200	Success. Returns the purchase details.

Success (200) Response Fields

Name	Type	Description
uid	String	Purchase ID defined as token in the Purchase class.
sku	String	SKU of the product purchased.
domain	String	Package name of the application that originated this purchase.
type	String	Type of the product purchased.
status	String	Status of the transaction.
state	String	State of the transaction.
payload	String	String-based payload specified by the developer when initiating this purchase.
created	String	Timestamp of the creation date. E.g. 2025-01-14T11:06:31.231117Z
buyer	Object	Object with information of the buyer source.
buyer.type	String	Buyer type. Example: WALLET
buyer.reference	String	Buyer reference.
order	Object	Object with the information of the order made in the payment.
order.uid	String	UID of the order. Defined as orderId in the Purchase class.
order.gateway	String	Gateway of the order. Possible value is broker.
order.reference	String	Reference ID of the order. Defined as UID in Aptoide Connect channels.
order.status	String	Status of the order made.
order.created	String	Timestamp of the creation date. E.g. 2025-01-14T11:06:31.231117Z

Example Response

{
  "uid": "catappult.inapp.purchase.AXVCN5PZPXNYKQ7J",
  "sku": "attempts",
  "domain": "com.appcoins.diceroll.sdk",
  "type": "CONSUMABLE",
  "status": "COMPLETED",
  "state": "CONSUMED",
  "payload": "dee8217d-8f5b-427c-872c-fa5bb32c2444",
  "created": "2025-05-02T22:12:20.053838Z",
  "buyer": {
    "type": "WALLET",
    "reference": "0x6e581078d392f98a53a8e9b0a10a35169c431a1e"
  },
  "order": {
    "uid": "SEVD6MDBKR5XBZZU",
    "gateway": "broker",
    "reference": "SEVD6MDBKR5XBZZU",
    "status": "COMPLETED",
    "created": "2025-05-02T22:12:20.096345Z"
  }
}

type

Value	Description
CONSUMABLE	Product type is a Consumable.
SUBSCRIPTION	Product type is a Subscription.

status

Value	Description
PENDING	The purchase is pending one or more actions to be completed. Example: Consumption
COMPLETED	The purchase is successfully completed.
VOIDED	The purchase is voided.

state

Value	Description
PENDING	The purchase is pending acknowledgement or consumption.
CONSUMED	The purchase has been consumed.
ACKNOWLEDGED	The purchase has been acknowledged.

order.status

Value	Description
PENDING	The order is pending one or more actions to be completed.
COMPLETED	The order is successfully completed.
FAILED	The order failed to be completed due to an error.
CANCELED	The order is canceled and may no longer be completed.
REFUNDED	The order was refunded.
CHARGEDBACK	The order was chargedback.