WEBHOOK
player-order-report
{
  "orderId": "<string>",
  "purchaseId": "<string>",
  "appChargePaymentId": "<string>",
  "purchaseDateAndTimeUtc": "2023-11-07T05:31:56Z",
  "playerId": "<string>",
  "bundleName": "<string>",
  "bundleId": "<string>",
  "sku": "<string>",
  "products": [
    {
      "amount": 0,
      "sku": "<string>",
      "name": "<string>"
    }
  ],
  "priceInDollar": 123,
  "priceInCents": 123,
  "subTotal": 123,
  "tax": 123,
  "taxRate": 17.5,
  "taxInDollar": 123,
  "currency": "<string>",
  "currencyExchangeCost": 123,
  "action": "purchase",
  "actionStatus": "completed",
  "originalPriceInDollar": 123,
  "paymentPriceInDollar": 123,
  "paymentMethod": "<string>",
  "countryCode2": "<string>",
  "priceTotalInDollar": 123,
  "playerEmail": "<string>",
  "sessionMetadata": "<string>",
  "receiptId": "<string>",
  "estimatedPublisherNetAmount": 123,
  "estimatedAppchargeFee": 123,
  "pricePointMetadata": 123,
  "createdByIp": "<string>",
  "zipCode": "<string>",
  "promoCodeName": "<string>",
  "discount": 123,
  "discountRatePoints": "<string>",
  "storeMetadata": {
    "productSequenceIndex": 123,
    "utms": {
      "utmSource": "<string>",
      "utmMedium": "<string>",
      "utmCampaign": "<string>"
    }
  }
}
{
  "publisherPurchaseId": "<string>"
}
Note: Read more about Player Order Reporting.
When a player makes a purchase, Appcharge processes the transaction and ensures the publisher receives direct updates. This webhook is a critical part of the order transaction process, providing essential details that allow publishers to track and align their transactions accurately. After the player is charged, Appcharge sends a detailed update to the publisher via a predefined webhook.
  • Webhook Configuration: The webhook URL will be configured in Appcharge’s management dashboard.
  • Transaction Alignment:
    • Publishers should use orderId to create a 1-to-1 transaction alignment with their transaction.
    • Appcharge will create a 1-to-1 transaction alignment with the returned publisherPurchaseId.

​
Retry mechanism

If the webhook returns a status code outside the 2XX range indicating a failed response, or if the publisherPurchaseId is missing, empty, or an invalid string, Appcharge will attempt to resend the webhook notification 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.

Headers

​
x-publisher-token
string
required

The publisher token.

​
signature
string
required

The signed payload.

Body

application/json

Response

200
application/json

Successful processing of the order report.

The response is of type object.