customer-public/dev.ansa.kmp.customer.transactions/Transaction

Transaction

data class Transaction(val id: String, val type: TransactionType, val amount: Int, val created: String, val source: TransactionSource?, val paymentMethodId: String?, val reason: String?, val from: String, val to: String, val metadata: JsonObject, val label: String?, val displayName: String, val isCredit: Boolean?)

A Transaction represents the public information available for an Ansa transaction. All movements of money through our closed-loop system will have a corresponding transaction, such as for each Add Balance, Use Balance, or Fund Balance request.

Parameters

Unique identifier for the transaction.

type

The type of transaction. Possible values are: - add_balance - use_balance - merchant_refund - refund_payment_method - merchant_add_promo

amount

The transaction amount. Always a positive integer, in the smallest currency unit used in the original transaction (eg $10.00 USD would be 1000).

created

The timestamp (in RFC 3339 format) when the transaction was created.

source

What source created this transaction. Possible values are: - addBalance - useBalance - useBalanceAndReload - autoReload

paymentMethodId

The identifier of which payment method was associated with this transaction. Only present for add_balance transactions.

reason

Merchant supplied a reason for why the transaction occurred. Only present for merchant_refund or merchant_add_promo transactions.

from

Unique identifier for who this transaction was from. Either the merchant ID or a customer ID.

Unique identifier for who this transaction was to. Either the merchant ID or a customer ID.

metadata

Free form metadata JSON object. This will exactly match any metadata argument passed to a transaction API, such as Add balance, Use balance, or Fund customer balance.

label

Merchant provided label for this transaction. Often used to store a reference to another system, such as an OrderId or an EventId within your system.

Constructors

Transaction

constructor(id: String, type: TransactionType, amount: Int, created: String, source: TransactionSource?, paymentMethodId: String?, reason: String?, from: String, to: String, metadata: JsonObject, label: String?, displayName: String, isCredit: Boolean?)