Order Completed

{
  "eventName": "order.completed",
  "eventId": "3f5bffbc-369e-4599-8c4d-abfe0ae0ef96",
  "timestamp": 1632345000,
  "sessionId": "345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
  "requestId": "23539478-c744-566a-c78c-c4cc7763ff62",
  "result": "success",
  "reason": "invalid_credentials",
  "attributes": {
    "persona": "non_payer",
    "blackFridayTest": "Base_group"
  },
  "customer": {
    "playerId": "671e81bb-55ef-428b-97ba-f67783971e0d",
    "email": "john.doe@gmail.com"
  },
  "offer": {
    "externalId": "22ae81bb-55ef-428b-97ba-f67783971e4a",
    "type": "PopUp",
    "subType": "DailyBonus",
    "name": "Spring Is Here",
    "indexToCollect": "1", 
    "products": [
      {
        "displayName": "Gold Coins",
        "productExternalId": "31ae81bb-55ef-428b-97ba-f67783971e553",
        "productQuantity": "1000"
      },
      {
        "displayName": "Silver Shield",
        "productExternalId": "9af1abb-55ef-428b-97ba-f677839716ac9",
        "productQuantity": "40"
      }
    ]
  },
  "order": {
    "subtotal": 1000,
    "discountAmount": 200,
    "totalPayment": 850,
    "taxAmount": 50,
    "currencyCode": "USD",
    "currencySymbol": 36,
    "paymentMethod": "credit_card",
    "pricePointMetadata": 999,
    "isSavedPaymentMethodUsed": true,
    "isNewPaymentMethodSaved": false
  },
  "coupon": {
    "couponName": "SPRING10",
    "promoCodeName": "KELSEY10",
    "discount": 10.0,
    "discountPercentage": 10.0
  },
  "storeMetadata": {
    "offerType": "Bundle",
    "offerSequenceIndex": "1"
  },
  "geolocation": {
    "countryCode2": "US",
    "region": "Florida",
    "ipAddress": "192.168.1.1.",
    "zipCode": "34997"
  },
  "transactions": [
    {
      "purchaseId": "901e81bb-55ea-428b-97ba-b67783971e08",
      "type": "paid",
      "timestamp": 1632345000,
      "amount": "9.99",
      "amountUSD": "9.99",
      "totalTaxAmount": "1.80",
      "totalTaxAmountUsd": "1.80",
      "currencyExchangeCostUsd": "0.25",
      "chargeBackFeeUsd": "0.00",
      "receiptNumber": "493e81cc-55ef-428b-97ba-n67783971c66"
    }
  ],
  "sessionMetadata": { "abTest": "group1", "locale": "en-US" }
}

{
  "eventName": "order.completed",
  "eventId": "3f5bffbc-369e-4599-8c4d-abfe0ae0ef96",
  "timestamp": 1632345000,
  "sessionId": "345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
  "requestId": "23539478-c744-566a-c78c-c4cc7763ff62",
  "result": "success",
  "reason": "invalid_credentials",
  "attributes": {
    "persona": "non_payer",
    "blackFridayTest": "Base_group"
  },
  "customer": {
    "playerId": "671e81bb-55ef-428b-97ba-f67783971e0d",
    "email": "john.doe@gmail.com"
  },
  "offer": {
    "externalId": "22ae81bb-55ef-428b-97ba-f67783971e4a",
    "type": "PopUp",
    "subType": "DailyBonus",
    "name": "Spring Is Here",
    "indexToCollect": "1", 
    "products": [
      {
        "displayName": "Gold Coins",
        "productExternalId": "31ae81bb-55ef-428b-97ba-f67783971e553",
        "productQuantity": "1000"
      },
      {
        "displayName": "Silver Shield",
        "productExternalId": "9af1abb-55ef-428b-97ba-f677839716ac9",
        "productQuantity": "40"
      }
    ]
  },
  "order": {
    "subtotal": 1000,
    "discountAmount": 200,
    "totalPayment": 850,
    "taxAmount": 50,
    "currencyCode": "USD",
    "currencySymbol": 36,
    "paymentMethod": "credit_card",
    "pricePointMetadata": 999,
    "isSavedPaymentMethodUsed": true,
    "isNewPaymentMethodSaved": false
  },
  "coupon": {
    "couponName": "SPRING10",
    "promoCodeName": "KELSEY10",
    "discount": 10.0,
    "discountPercentage": 10.0
  },
  "storeMetadata": {
    "offerType": "Bundle",
    "offerSequenceIndex": "1"
  },
  "geolocation": {
    "countryCode2": "US",
    "region": "Florida",
    "ipAddress": "192.168.1.1.",
    "zipCode": "34997"
  },
  "transactions": [
    {
      "purchaseId": "901e81bb-55ea-428b-97ba-b67783971e08",
      "type": "paid",
      "timestamp": 1632345000,
      "amount": "9.99",
      "amountUSD": "9.99",
      "totalTaxAmount": "1.80",
      "totalTaxAmountUsd": "1.80",
      "currencyExchangeCostUsd": "0.25",
      "chargeBackFeeUsd": "0.00",
      "receiptNumber": "493e81cc-55ef-428b-97ba-n67783971c66"
    }
  ],
  "sessionMetadata": { "abTest": "group1", "locale": "en-US" }
}

An event triggered when an order is successfully paid and processed, and confirmation is sent to the publisher or game. Event Data

eventName

string

Event name.

eventId

string

Event ID.

timestamp

number

Event timestamp in Epoch time. Example: 1632345000.

sessionId

string

The session ID of the player’s current session. Example: 345397c6-d963-4aa4-a0ba-2aaca6c3ee05.

requestId

string

ID assigned by Appcharge to each request sent to the publisher. Helps the publisher identify and debug failed requests.

result

string

Event result. Example: success.

reason

string

Reason for the event result. Example: invalid_credentials.

attributes

map<any,any>

A key-value map used to label events for tracking personas or tests. Example: { "persona":"non_payer", "blackFridayTest":"Base_group" }

customer

object

Information about the player.

Show properties

playerId

string

Player ID.

string

Player email address.

offer

object

List of offers.

Show properties

externalId

string

External ID of the offer as configured in the Publisher Dashboard.

type

string

Offer type.

subType

string

Offer subtype.

name

string

Offer name.

indexToCollect

string

The index of the sub-offer currently available to be collected in a rolling offer.

products

[object]

List of products in an offer.

Show properties

displayName

string

Display name of the product.

productExternalId

string

External ID of the product as configured in the Publisher Dashboard.

productQuantity

string

The quantity of the product. Must be a minimum 0 and equal to or less than 24 digits long.

order

object

Show properties

subtotal

int

Total order amount in the player’s local currency, excluding taxes and discounts.

discountAmount

int

Discount amount applied to the order in the player’s local currency.

totalPayment

int

Total amount paid by the player, including discounts and taxes in the player’s local currency.

taxAmount

int

Tax amount in the player’s local currency.

currencyCode

string

Currency code in ISO_4217 format.

currencySymbol

string

Currency symbol.

paymentMethod

string

Payment method used for the order.

pricePointMetadata

number

The price point in USD cents.

isSavedPaymentMethodUsed

boolean

Whether a player attempted to pay using a saved payment method.

isNewPaymentMethodSaved

boolean

Whether a player attempted to save a new payment method in the checkout.

storeMetadata

object

Show properties

offerSequenceIndex

string

Index of the sub-offer within an offer.

offerType

string

Offer type.

coupon

object

Information about the coupon.

Show properties

couponName

string

Coupon name.

Promo code name.

discount

float

Discount amount in USD.

discountPercentage

float

Discount percentage.

geolocation

object

Information about the player’s geolocation.

Show properties

countryCode2

enum

Two-letter country code in ISO-3166 alpha-2 format. Example: US

region

string

Region or state.

ipAddress

string

IP address in IPv4 format. Example: 80.178.249.122.

zipCode

string

Zip code.

transactions

[object]

Information about each transaction.

Show properties

purchaseId

string

Purchase ID.

type

string

Transaction type.

timestamp

number

Transaction timestamp in Epoch time. Example: 1632345000.

amount

string

Transaction amount in the player’s local currency.

amountUSD

string

Transaction amount in USD.

totalTaxAmount

string

Tax amount in the player’s local currency.

totalTaxAmountUsd

string

Tax amount in USD.

currencyExchangeCostUsd

string

Currency exchange fee in USD.

chargeBackFeeUsd

string

Chargeback fee in USD.

receiptNumber

string

Player receipt number.

sessionMetadata

object

Session metadata.

Show properties

any

Information about the session, provided as part of the Personalization API.

{
  "eventName": "order.completed",
  "eventId": "3f5bffbc-369e-4599-8c4d-abfe0ae0ef96",
  "timestamp": 1632345000,
  "sessionId": "345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
  "requestId": "23539478-c744-566a-c78c-c4cc7763ff62",
  "result": "success",
  "reason": "invalid_credentials",
  "attributes": {
    "persona": "non_payer",
    "blackFridayTest": "Base_group"
  },
  "customer": {
    "playerId": "671e81bb-55ef-428b-97ba-f67783971e0d",
    "email": "john.doe@gmail.com"
  },
  "offer": {
    "externalId": "22ae81bb-55ef-428b-97ba-f67783971e4a",
    "type": "PopUp",
    "subType": "DailyBonus",
    "name": "Spring Is Here",
    "indexToCollect": "1", 
    "products": [
      {
        "displayName": "Gold Coins",
        "productExternalId": "31ae81bb-55ef-428b-97ba-f67783971e553",
        "productQuantity": "1000"
      },
      {
        "displayName": "Silver Shield",
        "productExternalId": "9af1abb-55ef-428b-97ba-f677839716ac9",
        "productQuantity": "40"
      }
    ]
  },
  "order": {
    "subtotal": 1000,
    "discountAmount": 200,
    "totalPayment": 850,
    "taxAmount": 50,
    "currencyCode": "USD",
    "currencySymbol": 36,
    "paymentMethod": "credit_card",
    "pricePointMetadata": 999,
    "isSavedPaymentMethodUsed": true,
    "isNewPaymentMethodSaved": false
  },
  "coupon": {
    "couponName": "SPRING10",
    "promoCodeName": "KELSEY10",
    "discount": 10.0,
    "discountPercentage": 10.0
  },
  "storeMetadata": {
    "offerType": "Bundle",
    "offerSequenceIndex": "1"
  },
  "geolocation": {
    "countryCode2": "US",
    "region": "Florida",
    "ipAddress": "192.168.1.1.",
    "zipCode": "34997"
  },
  "transactions": [
    {
      "purchaseId": "901e81bb-55ea-428b-97ba-b67783971e08",
      "type": "paid",
      "timestamp": 1632345000,
      "amount": "9.99",
      "amountUSD": "9.99",
      "totalTaxAmount": "1.80",
      "totalTaxAmountUsd": "1.80",
      "currencyExchangeCostUsd": "0.25",
      "chargeBackFeeUsd": "0.00",
      "receiptNumber": "493e81cc-55ef-428b-97ba-n67783971c66"
    }
  ],
  "sessionMetadata": { "abTest": "group1", "locale": "en-US" }
}

Payment Resolved Order Canceled

Overview

What's New

Web Store

Checkout

Events Center