Track transactions

A newer version of this documentation is available. Switch to the latest version docs.

To associate a user’s session with their potential purchases (and corresponding revenue), you must send the transaction via a dedicated API. For each transaction, we send:

  • Price (number, mandatory)
  • Currency (CurrencyCode or string, mandatory)
  • Transaction ID (string, optional)

The plugin defines a TransactionItem type to prevent potential typing errors.

import { ContentsquarePlugin, CurrencyCode, TransactionItem } from '@contentsquare/capacitor-plugin';
const myTransaction: TransactionItem = {
transactionValue: 10.99,
transactionCurrency: CurrencyCode.USD,
transactionId: 'my_transaction_id',
};
ContentsquarePlugin.sendTransaction(myTransaction)
.catch(err => {
// Handle Error
});

The currency is conforming to the ISO 4217 standard. Although the currency can be passed as “alphanumeric code”, you should always prefer using the plugin’s CurrencyCode object values. If you have to pass the ISO code as a string, note that capitalization is not a factor ("USD", "Usd" or "usd" will all be treated as the US Dollar).

If the currency passed doesn’t match our supported currencies, the SDK will send a currency value of “-1”. It will be processed as the default currency of the project.