Properties
| Name | Type | Description |
|---|---|---|
| OrderId | String | Purchase order identifier. |
| ProviderData | String | Provider used for the transaction. |
| ProviderName | String | Payment provider to use to fund the purchase. |
| ProviderToken | String | A token generated by the provider to authenticate the request (provider-specific). |
| PurchaseConfirmationPageURL | String | URL to the purchase provider page that details the purchase. |
| PurchaseCurrency | String | Currency for the transaction, may be a virtual currency or real money. |
| PurchasePrice | uint32 | Cost of the transaction. |
| Status | TransactionStatus | Status of the transaction. |
| TitleId | String | The ID of the title to which this player event applies. |
| VirtualCurrencyBalances | Object | Current virtual currency balances for the user. |
| VirtualCurrencyGrants | Object | Virtual currencies granted by the transaction, if any. |
Common Properties
All V1 PlayStream events are formatted as JSON objects and share the following common properties:| Name | Type | Description |
|---|---|---|
| EntityId | String | The identifier for the entity (title, player, etc) to which this event applies. |
| EntityType | String | The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either ‘player’, ‘character’, or ‘title’. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like ‘com.mygame.guild’) as PlayFab may begin to parse root entities at any time. |
| EventId | String | PlayFab-assigned unique identifier for this event. |
| EventName | String | The name of this event. |
| EventNamespace | String | The assigned namespacing for this event. For example: ‘com.myprogram.ads’ |
| Source | String | The name of the source of this PlayStream event; will be PlayFab if the event originated from us. |
| SourceType | SourceType | The type of source of this event (PlayFab partner, other backend, or from the PlayFab API). |
| Timestamp | DateTime | The time (in UTC) associated with this event. |