NotificationAdditionalData class abstract
NotificationAdditionalData
Properties:
- paymentAccountReference - Reference of the payment account.
- acquirerAccountCode - The acquirer account code.
- acquirerCode - The acquirer code.
- acquirerReference - The acquirer reference.
- acsRenderingTypePeriodAcsInterface - ACS interface. Related to 3DS.
- acsRenderingTypePeriodAcsUiTemplate - ACS UI template.
- alias - Alias for this card.
- aliasType - Alias type.
- arn - Acquirer Reference Number of the dispute.
- authCode - Authcode of the scheme.
- authenticationType - 3DS authentication type
- authorisationMid - Authorisation MID of the acquirer.
- authorisedAmountCurrency - The currency authorised for a dynamic zero auth request.
- authorisedAmountValue - The amount authorised for a dynamic zero auth request.
- avsResult - Address Verification Service result.
- avsResultRaw - Address Verification Service result raw.
- bankAccountNumber - The bank account number.
- bankLocation - The bank location.
- bankLocationId - The bank location ID.
- bankName - The bank name.
- bankVerificationResult - The bank verification result.
- bankVerificationResultRaw - The bank verification result raw.
- bic - Business Identifier Code.
- billingAddressPeriodCity - BillingAddress: county.
- billingAddressPeriodHouseNumberOrName - BillingAddress: house number or name.
- billingAddressPeriodPostalCode - BillingAddress: postal code.
- billingAddressPeriodStateOrProvince - BillingAddress: state or province
- billingAddressPeriodStreet - BillingAddress: street
- browserCode - Browser code.
- captureDelayHours - The amount of delay after authorisation.
- captureMerchantReference - The merchant reference of the capture.
- capturePspReference - The PSP reference of the capture.
- cardBin - Card Bank Identification number.
- cardIssuingBank - Card issuing bank.
- cardIssuingCountry - Card issuing country.
- cardIssuingCurrency - Card issuing currency.
- cardPaymentMethod - Card payment method.
- cardSchemeEnhancedDataLevel - Card scheme enhanced data level.
- cardSummary - Card summary
- cavv - Secure Cardholder Authentication Verification Value.
- cavvAlgorithm - CAVV algorithm.
- challengeCancel - Information about the 3DS challenge being canceled.
- checkoutSessionId - ID of the Checkout Session.
- cvcResult - Card Verification Code result.
- cvcResultRaw - Card Verification Code result raw.
- deliveryAddressPeriodCity - Delivery address: city.
- deliveryAddressPeriodCountry - Delivery address: country.
- deliveryAddressPeriodHouseNumberOrName - Delivery address: house number or name.
- deliveryAddressPeriodPostalCode - Delivery address: postal code.
- deliveryAddressPeriodStateOrProvince - Delivery address: state or province.
- deliveryAddressPeriodStreet - Delivery address: street.
- deviceType - Type of device the request was made from.
- directdebitGBPeriodDateOfSignature - Direct debit GB: date of signature.
- directdebitGBPeriodMandateId - Direct debit GB: mandate ID.
- directdebitGBPeriodSequenceType - Direct debit GB: sequence type.
- directdebitGBPeriodServiceUserName - Direct debit GB: service user name.
- directdebitGBPeriodServiceUserNumber - Direct debit GB: service user number.
- eci - 3DS: Electronic Commerce Indicator.
- expiryDate - Expiry date of the card.
- extraCostsCurrency - Additional cost used in BIN or card verification.
- extraCostsValue - Related additional cost value.
- extraCostsValueGratuity - Gratuity related additional cost value.
- extraCostsValueSurcharge - Surcharge related additional cost value.
- fraudCheckLessThanCheckIDGreaterThanLessThanNameGreaterThan - Information on the fraud check in a dynamic format.
- fraudManualReview - Indicates if the risk check was done manually.
- fraudOffset - The fraud offset.
- fraudResultType - Result type of the fraud check.
- fraudRiskLevel - The risk level of the transaction as classified by the machine learning fraud risk rule. The risk level indicates the likelihood that a transaction will result in a fraudulent dispute. Possible values: * veryLow * low * medium * high * veryHigh
- fundingSource - Funding source.
- grossCurrency - Chargeback gross currency.
- grossValue - Chargeback gross value.
- iban - International Bank Account Number.
- installmentsPeriodValue - The number of installments that the payment amount should be charged with. Example: 5 > Only relevant for card payments in countries that support installments.
- interactionCounter - 3DS interaction counter.
- issuerCommentsPeriodCardholderName - Card holder name.
- issuerCountry - Country of the card issuer.
- latestCardPeriodBin - Recurring: Latest card BIN.
- latestCardPeriodExpiryDate - Recurring: Latest card expiry date.
- latestCardPeriodSummary - Recurring: Latest card summary.
- liabilityShift - Risk liability shift.
- metadata - A set of key-value pairs provided in the request, prefixed with 'metadata.'. For example, 'metadata.myField: myValue'
- networkTokenPeriodAvailable - Recurring related.
- networkTokenPeriodBin - Recurring related.
- networkTokenPeriodTokenSummary - Recurring related.
- nfcPeriodExpire - NFC related.
- nfcPeriodIssue - NFC related.
- nfcPeriodPinPeriodProvided - NFC related.
- nfcPeriodUid - NFC related.
- opiPeriodTransToken - Trans token related to Oracle Opera.
- ownerCity - Owner city.
- ownerName - Owner name.
- payULatamTrazabilityCode - Related to PayU in LATAM.
- paymentLinkId - ID of the Checkout payment link.
- realtimeAccountUpdaterStatus - Real time Account Update status.
- recurringPeriodContractTypes - Recurring contract types.
- recurringPeriodFirstPspReference - Recurring first PSP reference.
- recurringPeriodRecurringDetailReference - The token for stored payment details to make recurring payments.
- referred - If the payment is referred, this field is set to true. This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. Example: true
- refusalReasonRaw - Raw refusal reason received from the acquirer, where available. Example: AUTHORISED
- retryPeriodRescueScheduled - Indicates if an auto rescue for a payment is scheduled.
- riskProfile - Related to Risk.
- riskProfileReference - Related to Risk.
- shopperCountry - Country of the shopper.
- shopperEmail - Email of the shopper.
- shopperIP - IP of the shopper.
- shopperInteraction - The shopper interaction type of the payment request. Example: Ecommerce
- shopperLocale - The locale of the shopper.
- shopperSocialSecurityNumber - The social security number of the shopper.
- shopperStatement - The text to be shown on the shopper's bank statement.
- shopperTelephone - The telephone number of the shopper.
- store - Identifier of the store processing the transaction.
- tenderReference - Tender reference. For point-of-sale integrations only.
- terminalId - Terminal ID. For point-of-sale integrations only.
- threeDAuthenticated - A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
- threeDAuthenticatedResponse - The raw 3DS authentication result from the card issuer. Example: N
- threeDOffered - A Boolean value indicating whether 3DS was offered for this payment. Example: true
- threeDOfferedResponse - The raw enrollment result from the 3DS directory services of the card schemes. Example: Y
- threeDSVersion - The 3D Secure 2 version.
- tokenTxVariant - Payment method variant of the token/wallet payment method.
- totalFraudScore - Total fraud score from risk.
- untokenisedCardSummary - Card summary without tokenization.
- xid - The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. Example: ODgxNDc2MDg2MDExODk5MAAAAAA=
- Annotations
-
- @BuiltValue.new()
Constructors
- NotificationAdditionalData([void updates(NotificationAdditionalDataBuilder b)])
-
factory
Properties
- acquirerAccountCode → String?
-
The acquirer account code.
no setter
- acquirerCode → String?
-
The acquirer code.
no setter
- acquirerReference → String?
-
The acquirer reference.
no setter
- acsRenderingTypePeriodAcsInterface → String?
-
ACS interface. Related to 3DS.
no setter
- acsRenderingTypePeriodAcsUiTemplate → String?
-
ACS UI template.
no setter
- alias → String?
-
Alias for this card.
no setter
- aliasType → String?
-
Alias type.
no setter
- arn → String?
-
Acquirer Reference Number of the dispute.
no setter
- authCode → String?
-
Authcode of the scheme.
no setter
- authenticationType → String?
-
3DS authentication type
no setter
-
Authorisation MID of the acquirer.
no setter
-
The currency authorised for a dynamic zero auth request.
no setter
-
The amount authorised for a dynamic zero auth request.
no setter
- avsResult → String?
-
Address Verification Service result.
no setter
- avsResultRaw → String?
-
Address Verification Service result raw.
no setter
- bankAccountNumber → String?
-
The bank account number.
no setter
- bankLocation → String?
-
The bank location.
no setter
- bankLocationId → String?
-
The bank location ID.
no setter
- bankName → String?
-
The bank name.
no setter
- bankVerificationResult → String?
-
The bank verification result.
no setter
- bankVerificationResultRaw → String?
-
The bank verification result raw.
no setter
- bic → String?
-
Business Identifier Code.
no setter
- billingAddressPeriodCity → String?
-
BillingAddress: county.
no setter
- billingAddressPeriodHouseNumberOrName → String?
-
BillingAddress: house number or name.
no setter
- billingAddressPeriodPostalCode → String?
-
BillingAddress: postal code.
no setter
- billingAddressPeriodStateOrProvince → String?
-
BillingAddress: state or province
no setter
- billingAddressPeriodStreet → String?
-
BillingAddress: street
no setter
- browserCode → String?
-
Browser code.
no setter
- captureDelayHours → String?
-
The amount of delay after authorisation.
no setter
- captureMerchantReference → String?
-
The merchant reference of the capture.
no setter
- capturePspReference → String?
-
The PSP reference of the capture.
no setter
- cardBin → String?
-
Card Bank Identification number.
no setter
- cardIssuingBank → String?
-
Card issuing bank.
no setter
- cardIssuingCountry → String?
-
Card issuing country.
no setter
- cardIssuingCurrency → String?
-
Card issuing currency.
no setter
- cardPaymentMethod → String?
-
Card payment method.
no setter
- cardSchemeEnhancedDataLevel → String?
-
Card scheme enhanced data level.
no setter
- cardSummary → String?
-
Card summary
no setter
- cavv → String?
-
Secure Cardholder Authentication Verification Value.
no setter
- cavvAlgorithm → String?
-
CAVV algorithm.
no setter
- challengeCancel → String?
-
Information about the 3DS challenge being canceled.
no setter
- checkoutSessionId → String?
-
ID of the Checkout Session.
no setter
- cvcResult → String?
-
Card Verification Code result.
no setter
- cvcResultRaw → String?
-
Card Verification Code result raw.
no setter
- deliveryAddressPeriodCity → String?
-
Delivery address: city.
no setter
- deliveryAddressPeriodCountry → String?
-
Delivery address: country.
no setter
- deliveryAddressPeriodHouseNumberOrName → String?
-
Delivery address: house number or name.
no setter
- deliveryAddressPeriodPostalCode → String?
-
Delivery address: postal code.
no setter
- deliveryAddressPeriodStateOrProvince → String?
-
Delivery address: state or province.
no setter
- deliveryAddressPeriodStreet → String?
-
Delivery address: street.
no setter
- deviceType → String?
-
Type of device the request was made from.
no setter
- directdebitGBPeriodDateOfSignature → String?
-
Direct debit GB: date of signature.
no setter
- directdebitGBPeriodMandateId → String?
-
Direct debit GB: mandate ID.
no setter
- directdebitGBPeriodSequenceType → String?
-
Direct debit GB: sequence type.
no setter
- directdebitGBPeriodServiceUserName → String?
-
Direct debit GB: service user name.
no setter
- directdebitGBPeriodServiceUserNumber → String?
-
Direct debit GB: service user number.
no setter
- eci → String?
-
3DS: Electronic Commerce Indicator.
no setter
- expiryDate → String?
-
Expiry date of the card.
no setter
- extraCostsCurrency → String?
-
Additional cost used in BIN or card verification.
no setter
- extraCostsValue → String?
-
Related additional cost value.
no setter
- extraCostsValueGratuity → String?
-
Gratuity related additional cost value.
no setter
- extraCostsValueSurcharge → String?
-
Surcharge related additional cost value.
no setter
- fraudCheckLessThanCheckIDGreaterThanLessThanNameGreaterThan → String?
-
Information on the fraud check in a dynamic format.
no setter
- fraudManualReview → String?
-
Indicates if the risk check was done manually.
no setter
- fraudOffset → String?
-
The fraud offset.
no setter
- fraudResultType → String?
-
Result type of the fraud check.
no setter
- fraudRiskLevel → NotificationAdditionalDataFraudRiskLevelEnum?
-
The risk level of the transaction as classified by the machine learning fraud risk rule. The risk level indicates the likelihood that a transaction will result in a fraudulent dispute. Possible values: * veryLow * low * medium * high * veryHigh
no setter
- fundingSource → String?
-
Funding source.
no setter
- grossCurrency → String?
-
Chargeback gross currency.
no setter
- grossValue → String?
-
Chargeback gross value.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- iban → String?
-
International Bank Account Number.
no setter
- installmentsPeriodValue → String?
-
The number of installments that the payment amount should be charged with. Example: 5 > Only relevant for card payments in countries that support installments.
no setter
- interactionCounter → String?
-
3DS interaction counter.
no setter
- issuerCommentsPeriodCardholderName → String?
-
Card holder name.
no setter
- issuerCountry → String?
-
Country of the card issuer.
no setter
- latestCardPeriodBin → String?
-
Recurring: Latest card BIN.
no setter
- latestCardPeriodExpiryDate → String?
-
Recurring: Latest card expiry date.
no setter
- latestCardPeriodSummary → String?
-
Recurring: Latest card summary.
no setter
- liabilityShift → String?
-
Risk liability shift.
no setter
-
metadata
→ BuiltMap<
String, String> ? -
A set of key-value pairs provided in the request, prefixed with 'metadata.'. For example, 'metadata.myField: myValue'
no setter
- networkTokenPeriodAvailable → String?
-
Recurring related.
no setter
- networkTokenPeriodBin → String?
-
Recurring related.
no setter
- networkTokenPeriodTokenSummary → String?
-
Recurring related.
no setter
- nfcPeriodExpire → String?
-
NFC related.
no setter
- nfcPeriodIssue → String?
-
NFC related.
no setter
- nfcPeriodPinPeriodProvided → String?
-
NFC related.
no setter
- nfcPeriodUid → String?
-
NFC related.
no setter
- opiPeriodTransToken → String?
-
Trans token related to Oracle Opera.
no setter
- ownerCity → String?
-
Owner city.
no setter
- ownerName → String?
-
Owner name.
no setter
- paymentAccountReference → String?
-
Reference of the payment account.
no setter
- paymentLinkId → String?
-
ID of the Checkout payment link.
no setter
- payULatamTrazabilityCode → String?
-
Related to PayU in LATAM.
no setter
- realtimeAccountUpdaterStatus → String?
-
Real time Account Update status.
no setter
- recurringPeriodContractTypes → String?
-
Recurring contract types.
no setter
- recurringPeriodFirstPspReference → String?
-
Recurring first PSP reference.
no setter
- recurringPeriodRecurringDetailReference → String?
-
The token for stored payment details to make recurring payments.
no setter
- referred → String?
-
If the payment is referred, this field is set to true. This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. Example: true
no setter
- refusalReasonRaw → String?
-
Raw refusal reason received from the acquirer, where available. Example: AUTHORISED
no setter
- retryPeriodRescueScheduled → String?
-
Indicates if an auto rescue for a payment is scheduled.
no setter
- riskProfile → String?
-
Related to Risk.
no setter
- riskProfileReference → String?
-
Related to Risk.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shopperCountry → String?
-
Country of the shopper.
no setter
- shopperEmail → String?
-
Email of the shopper.
no setter
- shopperInteraction → String?
-
The shopper interaction type of the payment request. Example: Ecommerce
no setter
- shopperIP → String?
-
IP of the shopper.
no setter
- shopperLocale → String?
-
The locale of the shopper.
no setter
- shopperSocialSecurityNumber → String?
-
The social security number of the shopper.
no setter
- shopperStatement → String?
-
The text to be shown on the shopper's bank statement.
no setter
- shopperTelephone → String?
-
The telephone number of the shopper.
no setter
- store → String?
-
Identifier of the store processing the transaction.
no setter
- tenderReference → String?
-
Tender reference. For point-of-sale integrations only.
no setter
- terminalId → String?
-
Terminal ID. For point-of-sale integrations only.
no setter
- threeDAuthenticated → String?
-
A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true
no setter
- threeDAuthenticatedResponse → String?
-
The raw 3DS authentication result from the card issuer. Example: N
no setter
- threeDOffered → String?
-
A Boolean value indicating whether 3DS was offered for this payment. Example: true
no setter
- threeDOfferedResponse → String?
-
The raw enrollment result from the 3DS directory services of the card schemes. Example: Y
no setter
- threeDSVersion → String?
-
The 3D Secure 2 version.
no setter
- tokenTxVariant → String?
-
Payment method variant of the token/wallet payment method.
no setter
- totalFraudScore → String?
-
Total fraud score from risk.
no setter
- untokenisedCardSummary → String?
-
Card summary without tokenization.
no setter
- xid → String?
-
The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. Example: ODgxNDc2MDg2MDExODk5MAAAAAA=
no setter
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
dynamic updates(NotificationAdditionalDataBuilder)) → NotificationAdditionalData -
Rebuilds the instance.
inherited
-
toBuilder(
) → NotificationAdditionalDataBuilder -
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<
NotificationAdditionalData> -
no setter