Skip to main contentThe Awards API service allows you to manage the awards lifecycle for your app. Awards are how customers get the items, bonuses, or subscriptions they purchase or earn with Appcharge.
When a customer places an order, whether free or paid, Appcharge processes the transaction, verifies the payment if required, and then calls an API endpoint on your server with the order details.
This callback notifies your server to deliver the award to the customer. Once your server responds with the purchase ID, Appcharge assumes the award has been granted and redirects the customer to the success page confirming that the purchase was completed.
Learn more about the Awards feature.
With Awards API service, you can:
Before you begin
Review the following before you begin:
- Make sure you’ve completed the award notifications setup in the Publisher Dashboard.
- Align the transaction by pairing the Order ID provided by Appcharge,
orderId
with your Purchase ID, publisherPurchaseId
, for each transaction.
Retry mechanism
If your server returns a status code outside the 2XX range indicating a failed response, or if the publisherPurchaseId
is missing, empty, or an invalid string, Appcharge tries to call the endpoint up to 3 times. Each retry is delayed by an additional 15 seconds, resulting in a total retry period of up to 1.5 minutes to maximize the chances of successful delivery.