Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.appcharge.com/llms.txt

Use this file to discover all available pages before exploring further.

The Awards API service allows you to manage the awards lifecycle for your app. Awards are how customers get the items or bonuses 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 Appcharge sends award requests to your endpoint, it retries failed delivery attempts to handle transient network or server issues, using the following intervals:
AttemptDelay from previous attempt
Initial deliveryImmediate
1st retry10 seconds
2nd retry10 seconds
If your endpoint returns an error (4XX or 5XX), the response body must include a publisherErrorMessage field explaining the failure. This allows Appcharge to surface meaningful error context for each failed attempt. If all delivery attempts fail, you can still award the player manually from the Publisher Dashboard:
  1. In the sidebar menu, go to Dashboard > Orders. You’ll see a list of orders.
  2. Click the order in which you want to award the player.
  3. In the top right corner, click Retry Award.