org.killbill.billing.payment.api

Interface Payment

All Superinterfaces:

Entity

public interface Payment
extends Entity

Method Summary

Modifier and Type	Method and Description
java.util.UUID	getAccountId()
java.math.BigDecimal	getAuthAmount()
java.math.BigDecimal	getCapturedAmount()
java.math.BigDecimal	getCreditedAmount()
Currency	getCurrency()
java.lang.String	getExternalKey()
java.util.List<PaymentAttempt>	getPaymentAttempts()
java.util.UUID	getPaymentMethodId()
java.lang.Integer	getPaymentNumber()
java.math.BigDecimal	getPurchasedAmount()
java.math.BigDecimal	getRefundedAmount()
java.util.List<PaymentTransaction>	getTransactions()
java.lang.Boolean	isAuthVoided()

Methods inherited from interface org.killbill.billing.util.entity.Entity

getCreatedDate, getId, getUpdatedDate

Method Detail

getAccountId

java.util.UUID getAccountId()

Returns:

the account id

getPaymentMethodId

java.util.UUID getPaymentMethodId()

Returns:

the payment method id

getPaymentNumber

java.lang.Integer getPaymentNumber()

Returns:

the payment number

getExternalKey

java.lang.String getExternalKey()

Returns:

the external key

getAuthAmount

java.math.BigDecimal getAuthAmount()

Returns:

the authorized amount

getCapturedAmount

java.math.BigDecimal getCapturedAmount()

Returns:

the captured amount

getPurchasedAmount

java.math.BigDecimal getPurchasedAmount()

Returns:

the purchased amount

getCreditedAmount

java.math.BigDecimal getCreditedAmount()

Returns:

the credited amount

getRefundedAmount

java.math.BigDecimal getRefundedAmount()

Returns:

the refunded amount

isAuthVoided

java.lang.Boolean isAuthVoided()

Returns:

true if there was a void operation following an authorization

getCurrency

Currency getCurrency()

Returns:

the currency associated with that payment

getTransactions

java.util.List<PaymentTransaction> getTransactions()

Returns:

the list of attempts on that payment

getPaymentAttempts

java.util.List<PaymentAttempt> getPaymentAttempts()

Returns:

the list of Payment attempts (past and future)