Phoenix Commerce

Mobile payments & in-app purchasing

Application

Within a project there can be multiple applications with their own payment options

Properties

Name Type Description
IdSystem.Int32 The identifier for the Application[queryable][sortable]
ReferenceSystem.String Used by an external system to identify the message[queryable][sortable][required]
NameSystem.StringA human readable name for this Application[required]
SharedSecretSystem.StringPre-agreed secret between the application and server
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
ProjectIdSystem.Int32The Project that this Application belongs to[required]
ProjectProjectNavigation property to Project [expandable]

Product

The payment options available to a particular Application

Properties

Name Type Description
IdSystem.Int32 The identifier for the Product[queryable][sortable]
ProductIdentifierSystem.String A non sequential unique identifier for the product[queryable][sortable][required]
ProductTypeIdProductTypeEnumThe type of Product (eg IAPConsumable,IAPNonConsumable)
ApplicationIdSystem.Int32 The application this product belongs to[queryable][sortable][required]
NameSystem.StringThe Products's name[required]
PriceSystem.DecimalMonetary value for of the product[required]
MinMajorVersionSystem.Int32Minimum major version this product applies too
MinMinorVersionSystem.Int32Minimum minor version this product applies too
IsActiveSystem.BooleanIndicates whether this account is active or not[required]
MinPointVersionSystem.Int32Minimum revision number this product applies too
DescriptionSystem.StringA verbose description of the product
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
ApplicationApplicationNavigation property to Application [expandable]

Project

Refers to the core PhoenixIdentity.Project

Properties

Name Type Description
PhoenixIdentity_ProjectIdSystem.Int32 The Project that this Project belongs to[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed

Operations

ActivateModule
Description not availableSoapRestC#
DeactivateModule
Description not availableSoapRestC#
GetModuleSettings
Description not availableSoapRestC#
UpdateModuleSettings
Description not availableSoapRestC#

Transaction

A record of a payment transaction that a User has performed

Properties

Name Type Description
IdSystem.Int32 the identifier for the Transaction[queryable][sortable]
PhoenixIdentity_UserIdSystem.Int32 The user this transaction belongs to[queryable][required]
ProductIdSystem.Int32 The product this transaction belongs to[queryable][required]
ReferenceSystem.String used by an external system to identify the message[queryable][sortable][required]
ReceiptDataSystem.Stringthe particulars of the recipient[required]
QuantitySystem.Int32the Total quantity of products purchased[required]
StatusTypeIdStatusTypeEnum the status type of the transaction[queryable]
StatusDescriptionSystem.Stringa verbose description of the status
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
ProductProductNavigation property to Product [expandable]

Operations

CreateTransaction
Creates a new Transaction object required to authenticate end usersSoapRestC#
ListTransaction
Returns a paged list of Transaction optionally filtered and sortedSoapRestC#