io.puremetrics.sdk

Class PureMetrics.FailedTransaction.Builder

java.lang.Object

io.puremetrics.sdk.PureMetrics.FailedTransaction.Builder

Enclosing class:

PureMetrics.FailedTransaction

public static class PureMetrics.FailedTransaction.Builder
extends java.lang.Object

Builder class for PureMetrics.FailedTransaction Object. Provides a convenient way to set the various fields of a PureMetrics.FailedTransaction and generate associated payload which PureMetrics SDK can process

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PureMetrics.FailedTransaction.Builder	addMeta(java.util.HashMap<java.lang.String,java.lang.Object> meta) Add any additional information which you want to pass
PureMetrics.FailedTransaction	build() Combine all of the options that have been set and return a new PureMetrics.FailedTransaction object
PureMetrics.FailedTransaction.Builder	setAmount(long amount) Set the failed transaction amount
PureMetrics.FailedTransaction.Builder	setCurrency(java.lang.String currency) Set the Transaction Currency.
PureMetrics.FailedTransaction.Builder	setFailureReason(java.lang.String reason) Set the transaction for transaction as mentioned by the payment provider
PureMetrics.FailedTransaction.Builder	setPaymentProviderTransactionId(java.lang.String transactionId) The ID using which the transaction can be identified in the payment provider's system.
PureMetrics.FailedTransaction.Builder	setTransactionId(java.lang.String transactionId) Set The transaction Id for the current transaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setTransactionId

public PureMetrics.FailedTransaction.Builder setTransactionId(java.lang.String transactionId)

Set The transaction Id for the current transaction

Parameters:

transactionId - The transaction id to which the transaction belongs

Returns:

PureMetrics.FailedTransaction.Builder

setPaymentProviderTransactionId

public PureMetrics.FailedTransaction.Builder setPaymentProviderTransactionId(java.lang.String transactionId)

The ID using which the transaction can be identified in the payment provider's system. For example, In case of Stripe this is the 'balance_transaction' id which is returned with a charge response.

Parameters:

transactionId - id generated by the payment provider

Returns:

PureMetrics.FailedTransaction.Builder

setCurrency

public PureMetrics.FailedTransaction.Builder setCurrency(java.lang.String currency)

Set the Transaction Currency. There can be only a single currency for a single transaction.

Parameters:

currency - Currency value has to comply with ISO4217,

Returns:

PureMetrics.FailedTransaction.Builder

setFailureReason

public PureMetrics.FailedTransaction.Builder setFailureReason(java.lang.String reason)

Set the transaction for transaction as mentioned by the payment provider

Parameters:

reason - reason for transaction failure

Returns:

PureMetrics.FailedTransaction.Builder

setAmount

public PureMetrics.FailedTransaction.Builder setAmount(long amount)

Set the failed transaction amount

Parameters:

amount - The amount with which transaction was attempted

Returns:

PureMetrics.FailedTransaction.Builder

addMeta

public PureMetrics.FailedTransaction.Builder addMeta(java.util.HashMap<java.lang.String,java.lang.Object> meta)

Add any additional information which you want to pass

Parameters:

meta - Metadata associated with the revenue event. Example: name, product, category, location etc

Returns:

PureMetrics.FailedTransaction.Builder

build

public PureMetrics.FailedTransaction build()

Combine all of the options that have been set and return a new PureMetrics.FailedTransaction object

Returns:

PureMetrics.FailedTransaction