Order Completed Success

{ 
  "timestamp": 1632345000, 
  "appChargePaymentId": "pay_12345", 
  "appChargeOrderId": "order_1",
  "playerId": "player_12345",
  "sessionMetadata": {
    "device": "mobile", 
    "region": "US"
  },
  "storeMetadata": { 
    "productsSequenceIndex": 1 
  },  
  "paymentMethod": "card",
  "estimatedPublisherNetAmount": "7.50", 
  "estimatedAppchargeFee": "0.50", 
  "isSavedPaymentMethodUsed": "True", 
  "isNewPaymentMethodSaved": "True", 
  "reason": "insufficient_funds", 
  "pricePointMetadata": "800", 
  "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 
      } 
    ] 
  } 
}

{ 
  "timestamp": 1632345000, 
  "appChargePaymentId": "pay_12345", 
  "appChargeOrderId": "order_1",
  "playerId": "player_12345",
  "sessionMetadata": {
    "device": "mobile", 
    "region": "US"
  },
  "storeMetadata": { 
    "productsSequenceIndex": 1 
  },  
  "paymentMethod": "card",
  "estimatedPublisherNetAmount": "7.50", 
  "estimatedAppchargeFee": "0.50", 
  "isSavedPaymentMethodUsed": "True", 
  "isNewPaymentMethodSaved": "True", 
  "reason": "insufficient_funds", 
  "pricePointMetadata": "800", 
  "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 
      } 
    ] 
  } 
}

An event triggered when an order is successfully paid and processed, and confirmation is sent to the publisher or game. 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" }

storeMetadata

object

Details on offer-related metadata.

Show properties

productsSequenceIndex

int

The index of the offer. Example: {"productsSequenceIndex": 1}

paymentMethod

string

The payment method used for the transaction. Example: credit_card

estimatedPublisherNetAmount

number

The estimated amount the publisher receives after all deductions. Example: 7.50

estimatedAppchargeFee

number

The estimated Appcharge fee for the transaction. Example: 0.50

isSavedPaymentMethodUsed

boolean

Indicates if a player used/tried to use a saved card to pay in the checkout. Example: true

isNewPaymentMethodSaved

boolean

Whether a player has saved or tried to save a new card during payment. Example: true

reason

string

Error reason in case of a failure. Example: insufficient_funds

pricePointMetadata

number

The base price of the price point in USD cents. Example: 800

offer

object

Details about the offer associated with the order.

Show properties

offerName

string

The name of the offer. Example: Special Bundle

offerInternalId

string

The Appcharge offer ID. Example: offer_12345

offerExternalId

string

The publisher’s offer ID. Example: ext_offer_12345

originalPriceInDollar

number

The base price of the offer in USD. Example: 10.00

country

string

The ISO 3166-1 alpha-2 country code of the player. Example: US

currency

string

The ISO 4217 currency code used for the payment. Example: USD

priceInDollar

number

The paid price without taxes, converted to USD in real-time. Example: 8.00

priceInCents

number

The paid price in local currency (in cents). Example: 800

subtotal

number

The price paid by the player in local currency, excluding taxes. Example: 750

tax

number

The tax amount paid by the player (in cents of local currency). Example: 50

The name of the promo code being applied. Example: PROMO10

discount

float

The discount amount in the currency the order was placed in. Example: 1.00

discountRatePoints

string

The rate of the discount as a percentage. Example: 10%

products

array of objects

A list of products included in the offer.

Show properties

name

string

The name of the product. Example: Deluxe Skin

sku

string

The publisher’s product ID. Example: prod_12345

amount

number

The quantity of the purchased product. Example: 1

{ 
  "timestamp": 1632345000, 
  "appChargePaymentId": "pay_12345", 
  "appChargeOrderId": "order_1",
  "playerId": "player_12345",
  "sessionMetadata": {
    "device": "mobile", 
    "region": "US"
  },
  "storeMetadata": { 
    "productsSequenceIndex": 1 
  },  
  "paymentMethod": "card",
  "estimatedPublisherNetAmount": "7.50", 
  "estimatedAppchargeFee": "0.50", 
  "isSavedPaymentMethodUsed": "True", 
  "isNewPaymentMethodSaved": "True", 
  "reason": "insufficient_funds", 
  "pricePointMetadata": "800", 
  "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 
      } 
    ] 
  } 
}

Payment Intent Failed Order Completed Failed

Overview

What's New

Web Store

Checkout

Events Center