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.

An event triggered when an order is refunded, either manually or automatically. Event Data
timestamp
number
The time when the event occurred. Example: 1632345000
appChargePaymentId
string
The Appcharge payment ID for the event. Example: pay_12345
appChargeOrderId
string
The Appcharge order ID for the event. Example: order_12345
playerId
string
The unique identifier of the player involved in the order. Example: player_12345
sessionMetadata
object
Relevant only to Personalization API users, the player session metadata object received from the Personalization API. Example: { "metadata": "data" }
paymentMethod
string
The payment method used for the transaction. Example: credit_card
reason
string
Error reason in case of a failure. Example: insufficient_funds
offer
object
Details about the offer associated with the order.
{ 
  "timestamp": 1632345000, 
  "appChargePaymentId": "pay_12345", 
  "appChargeOrderId": "order_12345", 
  "playerId": "player_12345", 
  "sessionMetadata": {
    "device": "mobile", 
    "region": "US"
  }, 
  "paymentMethod": "credit_card", 
  "reason": "insufficient_funds", 
  "offer": { 
    "offerName": "Special Bundle", 
    "offerInternalId": "offer_12345", 
    "offerExternalId": "ext_offer_12345", 
    "originalPriceInDollar": 10.00, 
    "country": "US", 
    "currency": "USD", 
    "priceInDollar": 8.00, 
    "priceInCents": 800, 
    "subtotal": 750, 
    "tax": 50, 
    "promoCodeName": "PROMO10", 
    "discount": 1.00, 
    "discountRatePoints": "10%", 
    "products": [
      { 
        "name": "Deluxe Skin", 
        "sku": "prod_12345", 
        "amount": 1 
      }
    ] 
  } 
}