TransactionInterface
interface TransactionInterface (View source)
Transaction
Refers to a payable entity (Ex: invoice in invoicing system) that have a given reference
to identify it. Transaction usually have a countable value, a weight (Ex: Currency in invoicing system),
the date and time at which the transaction was created and the status of the transaction
Methods
Returns unique identifying value of the transaction on all platform
Returns the transaction id on the payment payment platform
Returns the actual value of the transaction. Usually in case of payment commands, transaction value is the currency based amount of the payment
Return the weight of the transaction. For currency based transactions, this can be
XOF
, 'USD', 'EUR', etc...
Note Weight will impact during transaction value from conversion
Date Time representation of the transaction create time
Returns true if the transaction is processed and false if not
Returns true is the transaction is still in pending state
Details
string|int
getReference()
Returns unique identifying value of the transaction on all platform
string|int
getId()
Returns the transaction id on the payment payment platform
string|int
getValue()
Returns the actual value of the transaction. Usually in case of payment commands, transaction value is the currency based amount of the payment
string
getWeight()
Return the weight of the transaction. For currency based transactions, this can be
XOF
, 'USD', 'EUR', etc...
Note Weight will impact during transaction value from conversion
DateTimeInterface
createdAt()
Date Time representation of the transaction create time
bool
isProcessed()
Returns true if the transaction is processed and false if not
mixed
isPending()
Returns true is the transaction is still in pending state