Class

TransactionBuilder

Facilitates configuring and building a Transaction instance.

Declaration

class TransactionBuilder

Topics

Initializers

init(posID: String, location: Location?, capabilities: [PeripheralCapability], invoice: Invoice?)
Initialize a TransactionBuilder with the specified POS ID and available peripheral capabilities. Optionally, an Invoice can be attached to the resulting Transaction When the Invoice is provided here, the invoice reference is used to set the Transaction.reference and the total gross amount is used to set the Transaction.amount
init(posID: String, location: Location?, capabilities: [PeripheralCapability], invoice: Invoice?, transactionID: UUID, transactionDateTime: Date, transactionType: TransactionType, transactionReference: String?, transactionAmount: Decimal, currency: Currency, metaData: [String : String]?, service: String?, secureFormat: SecureFormat?)

Instance Methods

func allowPartialApproval(Bool) -> TransactionBuilder
Specify whether Partial Approval is allowed for the transaction. Partial Approval means that the amount approved for the transaction could be lower than the amount requested.
func amount(Decimal, currency: Currency) -> TransactionBuilder
Specify the total amount to be paid by the customer (or refunded to the customer) for the transaction. The amount should be in major units of the specified Currency
func auth() -> TransactionBuilder
Specify that the transaction will be processed as an Auth. i.e. the amount will be authorized but the funds will not be captured from the customer’s card. The Amount must be provided.
func build() throws -> Transaction
Builds the Transaction with all the specified values.
func capabilities([PeripheralCapability]) throws -> TransactionBuilder
Specify the capabilities that will be available to use by the Peripheral when starting the transaction. This option is provided to allow for Transaction Fallback. For example, when a chip card fails to read, it is possible to try again with only PeripheralCapability.cardMagStripe enabled.
func capture(transactionId: UUID) -> TransactionBuilder
Specify that the transaction will be processed as a Capture and provide a valid Transaction ID that has previously been processed as a Auth for the funds to be captured from the customer’s card. The Amount must be provided.
func customerEmailAddress(String) -> TransactionBuilder
Specify the email address for the customer. When the email address is provided and the transaction is uploaded to Quantum Pay Cloud, the customer will be sent the transaction receipt via email.
func dateTime(Date) -> TransactionBuilder
Specify the Date that the transaction will be recorded against. This can be any valid value with any time zone, but the value in UTC time zone will be used. Optional. The default value is the current date/time in UTC when not specified.
func fallBackReason(TransactionFallbackReason) -> TransactionBuilder
Specify the reason for using different capabilities for this transaction. Optional, but must be provided when the Capabilities are specified.
func invoice(Invoice) -> TransactionBuilder
Associate the specified Invoice with the resulting Transaction
func metaData([String : String]) -> TransactionBuilder
Attach a dictionary to the transaction. The keys of the dictionary will be presented on the receipt and can also be used to locate the transaction on the Quantum Pay Portal. Only one meta-data object can be associated with the transaction. Optional.
func reference(String) -> TransactionBuilder
Specify the Reference code for the transaction. This should be a value that represents a unique order or invoice within the application. Optional. The default value is automatically generated when not specified.
func refund(transactionId: UUID) -> TransactionBuilder
Specify that the transaction will be processed as a Refund and provide a valid Transaction ID that has previously been processed as a Sale or Capture. The Amount must be provided.
func sale() -> TransactionBuilder
Specify that the transaction will be processed as a Sale. i.e. The Amount must be provided.
func secureFormat(SecureFormat) -> TransactionBuilder
Specify the SecureFormat to be used for handling the encrypted transaction data. Do not override unless advised to do so by the Quantum Pay Customer Support.
func service(String) -> TransactionBuilder
Specify the Service that will process the transaction. The Service is usually a merchant account. Optional, but must be provided if the tenant has more than one service set up on Quantum Pay Cloud.
func undo(transactionId: UUID) -> TransactionBuilder
Specify that the transaction will be processed as an Undo and provide a valid Transaction ID that has previously been processed as a Sale, Auth, Capture or Refund. The Amount does not need to be provided.
func void(transactionId: UUID) -> TransactionBuilder
Specify that the transaction will be processed as a Void and provide a valid Transaction ID that has previously been processed as a Sale, Auth, Capture or Refund. The Amount does not need to be provided.

Relationships

Conforms To