Purchase

  • The purchase message is a JSON object that captures details of a purchased plan, including the plan ID, transaction details, and a confirmation code.

  • This message includes a plan activation time, allowing for delayed activation, or assumes immediate activation if the field is missing.

  • A confirmation code is generated for successful transactions and is especially important for integration with Google Assistant.

  • The message contains a user-facing message intended to be displayed after the transaction is completed.

Purchase message capturing the plan that was purchased including details of the transaction.

JSON representation 
{
  "planId": string,
  "transactionId": string,
  "transactionMessage": string,
  "confirmationCode": string,
  "planActivationTime": string
}
Fields
planId

string

ID of the plan purchased.
transactionId

string

Transaction ID from the purchase request.
transactionMessage

string

Message to be shown to the user after the transaction.
confirmationCode

string

DPA generated confirmation code for successful transaction. Required for Google Assistant integration.
planActivationTime

string (Timestamp format)

Plan activation time. If planActivationTime is missing then GTAF shall assume that the plan has already been activated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".