io.puremetrics.sdk

Class PureMetrics.Revenue.Builder

java.lang.Object

io.puremetrics.sdk.PureMetrics.Revenue.Builder

Enclosing class:

PureMetrics.Revenue

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

Builder class for PureMetrics.Revenue Object. Provides a convenient way to set the various fields of a PureMetrics.Revenue 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.Revenue.Builder	addMeta(java.util.HashMap<java.lang.String,java.lang.Object> meta) Add any additional information which you want to pass.
PureMetrics.Revenue.Builder	addPayment(java.lang.String mode, long convertedAmount, long fees) Add the Payment Details.
PureMetrics.Revenue	build() Combine all of the options that have been set and return a new PureMetrics.Revenue object
PureMetrics.Revenue.Builder	setCurrency(java.lang.String currency) Set the Transaction Currency.
PureMetrics.Revenue.Builder	setDiscount(java.lang.String discountCode, long discountValue) Add the discount which is applied to the transaction.
PureMetrics.Revenue.Builder	setPaymentProviderTransactionId(java.lang.String transactionId) The ID using which the transaction can be identified in the payment provider's system.
PureMetrics.Revenue.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.Revenue.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.Revenue.Builder

setPaymentProviderTransactionId

public PureMetrics.Revenue.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.Revenue.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.Revenue.Builder

setDiscount

public PureMetrics.Revenue.Builder setDiscount(java.lang.String discountCode,
                                               long discountValue)

Add the discount which is applied to the transaction. This is optional but there can be only a single discount per transaction

Parameters:

discountCode - Discount code used

discountValue - Discount amount if any

Returns:

PureMetrics.Revenue.Builder

addMeta

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

Add any additional information which you want to pass. This is optional

Parameters:

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

Returns:

PureMetrics.Revenue.Builder

addPayment

public PureMetrics.Revenue.Builder addPayment(java.lang.String mode,
                                              long convertedAmount,
                                              long fees)

Add the Payment Details. If you are splitting the payment into wallets and cards etc, then add multiple payments with the amount specifically applied in that mode

Parameters:

mode - Payment Mode

convertedAmount - Payment amount converted in the transaction currency

fees - fess charged by the payment gateway if any

Returns:

PureMetrics.Revenue.Builder

build

public PureMetrics.Revenue build()

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

Returns:

PureMetrics.Revenue