PaymentResult class abstract

PaymentResult

Properties:

  • paymentType - Type of payment transaction. Elements requested by the Sale System that are related to the payment only. Possible values: * CashAdvance * CashDeposit * Completion * FirstReservation * Instalment * IssuerInstalment * Normal * OneTimeReservation * PaidOut * Recurring * Refund * UpdateReservation
  • paymentInstrumentData
  • amountsResp - Various amounts related to the payment response from the POI System. Amounts approved by the POI and the Acquirer for the payment and loyalty transaction, containing: * The authorised amount to be paid. * The amount of the rebates. * The amount of financial fees. * The cash back part of the requested amount for a payment with cash back. * The tip part of the requested amount for a payment with tip.
  • instalment - Information related an instalment transaction. To request an instalment to the issuer, or to make individual instalments of a payment transaction.
  • currencyConversion - Information related to a currency conversion. A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt).
  • merchantOverrideFlag - Indicates that the Merchant forced the result of the payment to successful. Allows the Sale System to be sure that the payment has been forced.
  • capturedSignature - Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. Only one format of the signature is allowed: * The size of the pad area where the signature is written, given with the maximum abscissa and ordinate values. * The sequence of coordinates where the pen changes direction or lift.
  • protectedSignature - Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding.
  • customerLanguage - The language of the customer that was used on the terminal screen or in text printed by the terminal. Format: two-character ISO 639:2023 format.
  • onlineFlag - Indicate that the payment transaction processing has required the approval of a host. Allows the Sale System to know if the payment was online or offline.
  • authenticationMethod - Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. Possible values: * Bypass * ManualVerification * MerchantAuthentication * OfflinePIN * OnlinePIN * PaperSignature * SecureCertificate * SecureNoCertificate * SecuredChannel * SignatureCapture * UnknownMethod
  • validityDate - End of the validity period for the reservation, for the first reservation, and the reservation updates as well.
  • paymentAcquirerData
Annotations
  • @BuiltValue.new()

Constructors

PaymentResult([void updates(PaymentResultBuilder b)])
factory

Properties

amountsResp → AmountsResp?
Various amounts related to the payment response from the POI System. Amounts approved by the POI and the Acquirer for the payment and loyalty transaction, containing: * The authorised amount to be paid. * The amount of the rebates. * The amount of financial fees. * The cash back part of the requested amount for a payment with cash back. * The tip part of the requested amount for a payment with tip.
no setter
authenticationMethod → BuiltList<PaymentResultAuthenticationMethodEnum>?
Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. Possible values: * Bypass * ManualVerification * MerchantAuthentication * OfflinePIN * OnlinePIN * PaperSignature * SecureCertificate * SecureNoCertificate * SecuredChannel * SignatureCapture * UnknownMethod
no setter
capturedSignature → CapturedSignature?
Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. Only one format of the signature is allowed: * The size of the pad area where the signature is written, given with the maximum abscissa and ordinate values. * The sequence of coordinates where the pen changes direction or lift.
no setter
currencyConversion → BuiltList<CurrencyConversion>?
Information related to a currency conversion. A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt).
no setter
customerLanguage → String?
The language of the customer that was used on the terminal screen or in text printed by the terminal. Format: two-character ISO 639:2023 format.
no setter
hashCode → int
The hash code for this object.
no setterinherited
instalment → Instalment?
Information related an instalment transaction. To request an instalment to the issuer, or to make individual instalments of a payment transaction.
no setter
merchantOverrideFlag → bool?
Indicates that the Merchant forced the result of the payment to successful. Allows the Sale System to be sure that the payment has been forced.
no setter
onlineFlag → bool?
Indicate that the payment transaction processing has required the approval of a host. Allows the Sale System to know if the payment was online or offline.
no setter
paymentAcquirerData → PaymentAcquirerData?
no setter
paymentInstrumentData → PaymentInstrumentData?
no setter
paymentType → PaymentType?
Type of payment transaction. Elements requested by the Sale System that are related to the payment only. Possible values: * CashAdvance * CashDeposit * Completion * FirstReservation * Instalment * IssuerInstalment * Normal * OneTimeReservation * PaidOut * Recurring * Refund * UpdateReservation
no setter
protectedSignature → String?
Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
validityDate → Date?
End of the validity period for the reservation, for the first reservation, and the reservation updates as well.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(PaymentResultBuilder)) → PaymentResult
Rebuilds the instance.
inherited
toBuilder() → PaymentResultBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<PaymentResult>
no setter