Class Transaction

Transaction as reported by the device

See

Hierarchy (view full)

Constructors

constructor

Properties

amountMicros? currency? expirationDate? isAcknowledged? isConsumed? isPending? lastRenewalDate? nativePurchase platform products purchaseDate? purchaseId? renewalIntent? renewalIntentChangeDate? state transactionId

Accessors

parentReceipt

Methods

finish refresh verify toState

Constructors

constructor

Properties

Optional amountMicros

amountMicros?: number

Amount paid by the user, if known, in micro units. Divide by 1,000,000 for value.

Optional currency

currency?: string

Currency used to pay for the transaction, if known.

Optional expirationDate

expirationDate?: Date

Time when the subscription is set to expire following this transaction

Optional isAcknowledged

isAcknowledged?: boolean

True when the transaction has been acknowledged to the platform.

Optional isConsumed

isConsumed?: boolean

True when the transaction was consumed.

Optional isPending

isPending?: boolean

True when the transaction is still pending payment.

Optional lastRenewalDate

lastRenewalDate?: Date

Time a subscription was last renewed

nativePurchase

nativePurchase: Purchase

platform

platform: Platform

Platform this transaction was created on

products

products: {
    id: string;
    offerId?: string;
}[] = []

Purchased products

Type declaration

  • id: string

    Product identifier

  • Optional offerId?: string

    Offer identifier, if known

Optional purchaseDate

purchaseDate?: Date

Time the purchase was made.

For subscriptions this is equal to the date of the first transaction. Note that it might be undefined for deleted transactions (google for instance don't provide any info in that case).

Optional purchaseId

purchaseId?: string

Identifier for the purchase this transaction is a part of.

Optional renewalIntent

renewalIntent?: RenewalIntent

Is the subscription set to renew.

Optional renewalIntentChangeDate

renewalIntentChangeDate?: Date

Time when the renewal intent was changed

state

state: CdvPurchase.TransactionState = TransactionState.UNKNOWN_STATE

State this transaction is in

transactionId

transactionId: string = ''

Transaction identifier.

Accessors

parentReceipt

Methods

finish

  • finish(): Promise<void>

  • Finish a transaction.

    When the application has delivered the product, it should finalizes the order. Only after that, money will be transferred to your account. This method ensures that no customers is charged for a product that couldn't be delivered.

    Returns Promise<void>

    Example

    store.when()
      .approved(transaction => transaction.verify())
      .verified(receipt => receipt.finish())

refresh

  • refresh(purchase, fromConstructor?): void

  • Refresh the value in the transaction based on the native purchase update

    Parameters

    • purchase: Purchase
    • Optional fromConstructor: boolean

    Returns void

verify

  • verify(): Promise<void>

  • Verify a transaction.

    This will trigger a call to the receipt validation service for the attached receipt. Once the receipt has been verified, you can finish the transaction.

    Returns Promise<void>

    Example

    store.when()
      .approved(transaction => transaction.verify())
      .verified(receipt => receipt.finish())

Static toState

Settings

Member Visibility

Theme

On This Page

constructoramountMicroscurrencyexpirationDateisAcknowledgedisConsumedisPendinglastRenewalDatenativePurchaseplatformproductspurchaseDatepurchaseIdrenewalIntentrenewalIntentChangeDatestatetransactionIdparentReceiptfinishrefreshverifytoState