trackTransactionError

To track a transaction error you can use the trackTransactionError method with the following attributes:

/* {trackerName} is a placeholder for the initialized tracker on your page.  */

window.snowplow("trackTransactionError:{trackerName}", {
  resolution,
  error_code,
  error_shortcode,
  error_description,
  error_type,
  transaction
});

• Where resolution is the system action selected in this failure event E.g. Allowing retries, blocking the payment gateway, contacting the user or other.
• Where error_code is the error-identifying code for the transaction issue E.g. E522.
• Where error_shortcode is the shortcode for the transaction error E.g declined_by_api, pm_card_radarBlock.
• Where error_description is the longer description for the transaction error.
• Where error_type is the type of error the specific issue is regarded as in the standard classification of hard and soft. Hard error types mean the customer must provide another form of payment e.g. an expired card. Soft errors can be the result of temporary issues where retrying might be successful e.g. processor declined the transaction.
• Where transaction is the transaction the issue occurred in.

Example usage:

window.snowplow("trackTransactionError:{trackerName}", {
  resolution: "rejection",
  error_code: "E123",
  error_shortcode: "CARD_DECLINE",
  error_description: "Card has been declined by the issuing bank.",
  error_type: "hard",
  transaction: {
    revenue: 45,
    currency: "EUR",
    transaction_id: "T12345",
    payment_method: "card" 
  }
});

Track transaction errors using a self describing event

To track transaction errors in the Node.js tracker, you can use the buildSelfDescribingEvent method together with the correct parameters for the transaction error event.

/* Where `t` is a placeholder for the initialized tracker instance on your application.  */

t.track(buildSelfDescribingEvent({
  event: {
    schema: "iglu:com.snowplowanalytics.snowplow.ecommerce/snowplow_ecommerce_action/jsonschema/1-0-2",
    data: {
      type: "trns_error"
    }
  }
}), [
  /* Transaction Error context */
  {
    schema: "iglu:com.snowplowanalytics.snowplow.ecommerce/transaction_error/jsonschema/1-0-0",
    data: { 
      /* ...Transaction error data */
    }
  },
  /* Transaction context */
  {
    schema: "iglu:com.snowplowanalytics.snowplow.ecommerce/transaction/jsonschema/1-0-0",
    data: {
      /* ...Transaction data */
    }
  }
]);

Where transaction error data can include:

• resolution as the system action selected in this failure event E.g. Allowing retries, blocking the payment gateway, contacting the user or other.
• error_code as the error-identifying code for the transaction issue E.g. E522.
• error_shortcode as the shortcode for the transaction error E.g declined_by_api, pm_card_radarBlock.
• error_description as the longer description for the transaction error.
• error_type as the type of error the specific issue is regarded as in the standard classification of hard and soft. Hard error types mean the customer must provide another form of payment e.g. an expired card. Soft errors can be the result of temporary issues where retrying might be successful e.g. processor declined the transaction. For the transaction taking part in the process, an additional transaction data context is added on the contexts to be sent with the event.

Example usage:

/* Where `t` is a placeholder for the initialized tracker instance on your application.  */

t.track(buildSelfDescribingEvent({
  event: {
    schema: "iglu:com.snowplowanalytics.snowplow.ecommerce/snowplow_ecommerce_action/jsonschema/1-0-2",
    data: {
      type: "trns_error"
    }
  }
}), [
  /* Transaction Error context */
  {
    schema: "iglu:com.snowplowanalytics.snowplow.ecommerce/transaction_error/jsonschema/1-0-0",
    data: { 
      resolution: "rejection",
      error_code: "E123",
      error_shortcode: "CARD_DECLINE",
      error_description: "Card has been declined by the issuing bank.",
      error_type: "hard",
    }
  },
  /* Transaction context */
  {
    schema: "iglu:com.snowplowanalytics.snowplow.ecommerce/transaction/jsonschema/1-0-0",
    data: {
      revenue: 45,
      currency: "EUR",
      transaction_id: "T12345",
      payment_method: "card" 
    }
  }
]);

To learn more about tracking self describing events in Node.js take a look at the buildSelfDescribingEvent documentation.