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
When sending award requests to your endpoint, Appcharge applies a retry mechanism to handle transient network or server issues. Each retry attempt is delayed by 15 seconds with no additional delay added between retries.
Since customers are expected to receive immediate feedback for a successful award, Appcharge enforces a 10-second timeout for each request. If your endpoint takes longer than 10 seconds to respond, the request will automatically time out and be treated as a failed attempt. We strongly recommend keeping your endpoint’s response time well below this limit to ensure a smooth customer experience and reduce the chance of failed awards.