toro/services.cabcard.toro.transaction.model/TransactionReceipt

TransactionReceipt

data class TransactionReceipt(val saleReferenceId: String? = null, val amount: Int, val authorisedAmount: Int? = null, val type: TransactionType, val gratuityAmount: Int, val currency: CurrencyCode, val authCode: String? = null, val responseCode: ResponseCode, val responseReason: String? = null, val authenticationMethod: AuthenticationMethod8? = null, val additionalResponseInformation: String? = null, val actionCode: String? = null, val aid: String? = null, val applicationLabel: String? = null, val paymentInterface: PaymentInterface, val panStart: String?, val panLastFour: String?, val recipientTransactionId: String?, val initiatorTransactionId: String?, val transactionReference: String?, val dateTime: String?, val terminalSerialNumber: String, val signatureBase64: String? = null, val signatureVerificationFailed: Boolean = false, val captured: Boolean, val longitude: String? = null, val latitude: String? = null, val additionalInformation: Map<String, Any?>? = null)

Constructors

TransactionReceipt

constructor(saleReferenceId: String? = null, amount: Int, authorisedAmount: Int? = null, type: TransactionType, gratuityAmount: Int, currency: CurrencyCode, authCode: String? = null, responseCode: ResponseCode, responseReason: String? = null, authenticationMethod: AuthenticationMethod8? = null, additionalResponseInformation: String? = null, actionCode: String? = null, aid: String? = null, applicationLabel: String? = null, paymentInterface: PaymentInterface, panStart: String?, panLastFour: String?, recipientTransactionId: String?, initiatorTransactionId: String?, transactionReference: String?, dateTime: String?, terminalSerialNumber: String, signatureBase64: String? = null, signatureVerificationFailed: Boolean = false, captured: Boolean, longitude: String? = null, latitude: String? = null, additionalInformation: Map<String, Any?>? = null)

Properties

actionCode

val actionCode: String? = null

Also known as the authorisation response code. EMV tag 8A set by the acquirer.

additionalInformation

val additionalInformation: Map<String, Any?>? = null

The custom data set in TransactionMetadata

additionalResponseInformation

val additionalResponseInformation: String? = null

Additional response information (from gateway or acquirer).

aid

val aid: String? = null

Application identifier of the card that was presented

amount

val amount: Int

The total amount of the transaction represented in the smallest unit of the currency, e.g. cents for USD, pence for GBP.

applicationLabel

val applicationLabel: String? = null

Application label of the card that was presented

authCode

val authCode: String? = null

The authorisation code set by the acquirer.

authenticationMethod

val authenticationMethod: AuthenticationMethod8? = null

Cardholder Verification Method

authorisedAmount

val authorisedAmount: Int? = null

The amount of the transaction that was authorised by the acquirer. In most cases the same as amount, but can differ e.g. partial approvals.

captured

val captured: Boolean

Whether the transaction was captured by the acquirer.

currency

val currency: CurrencyCode

The currency of the transaction.

dateTime

val dateTime: String?

The date and time the transaction occurred in ISO 8601 format.

gratuityAmount

val gratuityAmount: Int

Gratuity amount confirmed by the customer, in pence. Set either via TransactionMetadata.gratuityAmount or via the built-in gratuity flow when services.cabcard.toro.core.model.GratuityConfig mode is not services.cabcard.toro.core.enums.GratuityMode.NONE.

initiatorTransactionId

val initiatorTransactionId: String?

Identifier set by the initiator (merchant) to reference the transaction. The Toro SDK handles this internally and cannot be overridden by the host application.

latitude

val latitude: String? = null

The longitude of the device at the point of transaction.

longitude

val longitude: String? = null

The latitude of the device at the point of transaction.

panLastFour

val panLastFour: String?

The last 4 digits of the Primary Account Number (PAN).

panStart

val panStart: String?

The first 6 or 8 digits of the Primary Account Number (PAN). AKA Bank Identification Number (BIN).

paymentInterface

val paymentInterface: PaymentInterface

The payment interface used to process the transaction. E.g. Contactless.

recipientTransactionId

val recipientTransactionId: String?

Identifier set by the recipient (acquirer) to reference the transaction. This can be the same as the initiatorTransactionId depending on the acquirer.

responseCode

val responseCode: ResponseCode

The result of the authorisation (acquirer decision). Typically APPROVED or DECLINED.

responseReason

val responseReason: String? = null

The reason for the ResponseCode.

saleReferenceId

val saleReferenceId: String? = null

Unique reference number to identify the transaction. Can be set in TransactionMetadata.

signatureBase64

val signatureBase64: String? = null

Cardholder signature base64 encoded if applicable.

signatureVerificationFailed

val signatureVerificationFailed: Boolean = false

Indicates whether the signature verification failed, either due to merchant rejection or customer cancellation during signature entry.

terminalSerialNumber

val terminalSerialNumber: String

The serial number of the terminal the transaction was processed on.

transactionReference

val transactionReference: String?

Unique identification of the transaction assigned by the POI (Point Of Interaction)

type

val type: TransactionType

The type of transaction. Purchase, refund.