Package com.onlinepayments.domain

Class CardPaymentMethodSpecificInput

java.lang.Object
com.onlinepayments.domain.CardPaymentMethodSpecificInput
public class CardPaymentMethodSpecificInput extends Object

  • Constructor Details

    • CardPaymentMethodSpecificInput

      public CardPaymentMethodSpecificInput()

  • Method Details

    • getAllowDynamicLinking

      public Boolean getAllowDynamicLinking()
      • true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
      • false - Indicates that the dynamic linking (including Card On File data) will be ignored.

    • setAllowDynamicLinking

      public void setAllowDynamicLinking(Boolean value)
      • true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
      • false - Indicates that the dynamic linking (including Card On File data) will be ignored.

    • withAllowDynamicLinking

      public CardPaymentMethodSpecificInput withAllowDynamicLinking(Boolean value)
      • true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
      • false - Indicates that the dynamic linking (including Card On File data) will be ignored.

    • getAuthorizationMode

      public String getAuthorizationMode()
      Determines the type of the authorization that will be used. Allowed values:
      • FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can't be reversed and need to be captured for the full amount within 7 days.
      • PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount.
      • SALE - The payment creation results in an authorization that is already captured at the moment of approval.

      Only used with some acquirers, ignored for acquirers that do not support this. In case the acquirer does not allow this to be specified the authorizationMode is 'unspecified', which behaves similar to a final authorization.

    • setAuthorizationMode

      public void setAuthorizationMode(String value)
      Determines the type of the authorization that will be used. Allowed values:
      • FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can't be reversed and need to be captured for the full amount within 7 days.
      • PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount.
      • SALE - The payment creation results in an authorization that is already captured at the moment of approval.

      Only used with some acquirers, ignored for acquirers that do not support this. In case the acquirer does not allow this to be specified the authorizationMode is 'unspecified', which behaves similar to a final authorization.

    • withAuthorizationMode

      public CardPaymentMethodSpecificInput withAuthorizationMode(String value)
      Determines the type of the authorization that will be used. Allowed values:
      • FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can't be reversed and need to be captured for the full amount within 7 days.
      • PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount.
      • SALE - The payment creation results in an authorization that is already captured at the moment of approval.

      Only used with some acquirers, ignored for acquirers that do not support this. In case the acquirer does not allow this to be specified the authorizationMode is 'unspecified', which behaves similar to a final authorization.

    • getCard

      public Card getCard()
      Object containing card details

    • setCard

      public void setCard(Card value)
      Object containing card details

    • withCard

      public CardPaymentMethodSpecificInput withCard(Card value)
      Object containing card details

    • getCardOnFileRecurringExpiration

      public String getCardOnFileRecurringExpiration()
      The end date of the last scheduled payment in a series of transactions. Format YYYYMMDD

    • setCardOnFileRecurringExpiration

      public void setCardOnFileRecurringExpiration(String value)
      The end date of the last scheduled payment in a series of transactions. Format YYYYMMDD

    • withCardOnFileRecurringExpiration

      public CardPaymentMethodSpecificInput withCardOnFileRecurringExpiration(String value)
      The end date of the last scheduled payment in a series of transactions. Format YYYYMMDD

    • getCardOnFileRecurringFrequency

      public String getCardOnFileRecurringFrequency()
      Period of payment occurrence for recurring and installment payments. Allowed values:
      • Yearly
      • Quarterly
      • Monthly
      • Weekly
      • Daily

    • setCardOnFileRecurringFrequency

      public void setCardOnFileRecurringFrequency(String value)
      Period of payment occurrence for recurring and installment payments. Allowed values:
      • Yearly
      • Quarterly
      • Monthly
      • Weekly
      • Daily

    • withCardOnFileRecurringFrequency

      public CardPaymentMethodSpecificInput withCardOnFileRecurringFrequency(String value)
      Period of payment occurrence for recurring and installment payments. Allowed values:
      • Yearly
      • Quarterly
      • Monthly
      • Weekly
      • Daily

    • getCobrandSelectionIndicator

      public String getCobrandSelectionIndicator()
      For cobranded cards, this field indicates the brand selection method:
      • default - The holder implicitly accepted the default brand.
      • alternative - The holder explicitly selected an alternative brand.
      • notApplicable - The card is not cobranded.

    • setCobrandSelectionIndicator

      public void setCobrandSelectionIndicator(String value)
      For cobranded cards, this field indicates the brand selection method:
      • default - The holder implicitly accepted the default brand.
      • alternative - The holder explicitly selected an alternative brand.
      • notApplicable - The card is not cobranded.

    • withCobrandSelectionIndicator

      public CardPaymentMethodSpecificInput withCobrandSelectionIndicator(String value)
      For cobranded cards, this field indicates the brand selection method:
      • default - The holder implicitly accepted the default brand.
      • alternative - The holder explicitly selected an alternative brand.
      • notApplicable - The card is not cobranded.

    • getCurrencyConversion

      public CurrencyConversionInput getCurrencyConversion()

    • setCurrencyConversion

      public void setCurrencyConversion(CurrencyConversionInput value)

    • withCurrencyConversion

      public CardPaymentMethodSpecificInput withCurrencyConversion(CurrencyConversionInput value)

    • getInitialSchemeTransactionId

      public String getInitialSchemeTransactionId()
      The unique scheme transactionId of the initial transaction that was performed with SCA. In case this is unknown a scheme transactionId of an earlier transaction part of the same sequence can be used as a fall-back. Strongly advised to be submitted for any MerchantInitiated or recurring transaction (a subsequent one).

    • setInitialSchemeTransactionId

      public void setInitialSchemeTransactionId(String value)
      The unique scheme transactionId of the initial transaction that was performed with SCA. In case this is unknown a scheme transactionId of an earlier transaction part of the same sequence can be used as a fall-back. Strongly advised to be submitted for any MerchantInitiated or recurring transaction (a subsequent one).

    • withInitialSchemeTransactionId

      public CardPaymentMethodSpecificInput withInitialSchemeTransactionId(String value)
      The unique scheme transactionId of the initial transaction that was performed with SCA. In case this is unknown a scheme transactionId of an earlier transaction part of the same sequence can be used as a fall-back. Strongly advised to be submitted for any MerchantInitiated or recurring transaction (a subsequent one).

    • getIsRecurring

      public Boolean getIsRecurring()
      • true - Indicates that the transactions is part of a scheduled recurring sequence. In addition, recurringPaymentSequenceIndicator indicates if the transaction is the first or subsequent in a recurring sequence.
      • false - Indicates that the transaction is not part of a scheduled recurring sequence. The default value for this property is false.

    • setIsRecurring

      public void setIsRecurring(Boolean value)
      • true - Indicates that the transactions is part of a scheduled recurring sequence. In addition, recurringPaymentSequenceIndicator indicates if the transaction is the first or subsequent in a recurring sequence.
      • false - Indicates that the transaction is not part of a scheduled recurring sequence. The default value for this property is false.

    • withIsRecurring

      public CardPaymentMethodSpecificInput withIsRecurring(Boolean value)
      • true - Indicates that the transactions is part of a scheduled recurring sequence. In addition, recurringPaymentSequenceIndicator indicates if the transaction is the first or subsequent in a recurring sequence.
      • false - Indicates that the transaction is not part of a scheduled recurring sequence. The default value for this property is false.

    • getMultiplePaymentInformation

      public MultiplePaymentInformation getMultiplePaymentInformation()
      Container announcing forecoming subsequent payments. Holds modalities of these subsequent payments.

    • setMultiplePaymentInformation

      public void setMultiplePaymentInformation(MultiplePaymentInformation value)
      Container announcing forecoming subsequent payments. Holds modalities of these subsequent payments.

    • withMultiplePaymentInformation

      public CardPaymentMethodSpecificInput withMultiplePaymentInformation(MultiplePaymentInformation value)
      Container announcing forecoming subsequent payments. Holds modalities of these subsequent payments.

    • getPaymentProduct130SpecificInput

      public PaymentProduct130SpecificInput getPaymentProduct130SpecificInput()
      Object containing specific input required for CB payments

    • setPaymentProduct130SpecificInput

      public void setPaymentProduct130SpecificInput(PaymentProduct130SpecificInput value)
      Object containing specific input required for CB payments

    • withPaymentProduct130SpecificInput

      public CardPaymentMethodSpecificInput withPaymentProduct130SpecificInput(PaymentProduct130SpecificInput value)
      Object containing specific input required for CB payments

    • getPaymentProduct3012SpecificInput

      public PaymentProduct3012SpecificInput getPaymentProduct3012SpecificInput()
      Object containing specific input required for bancontact.

    • setPaymentProduct3012SpecificInput

      public void setPaymentProduct3012SpecificInput(PaymentProduct3012SpecificInput value)
      Object containing specific input required for bancontact.

    • withPaymentProduct3012SpecificInput

      public CardPaymentMethodSpecificInput withPaymentProduct3012SpecificInput(PaymentProduct3012SpecificInput value)
      Object containing specific input required for bancontact.

    • getPaymentProduct3208SpecificInput

      public PaymentProduct3208SpecificInput getPaymentProduct3208SpecificInput()
      Object containing specific input required for OneyDuplo Leroy Merlin payments.

    • setPaymentProduct3208SpecificInput

      public void setPaymentProduct3208SpecificInput(PaymentProduct3208SpecificInput value)
      Object containing specific input required for OneyDuplo Leroy Merlin payments.

    • withPaymentProduct3208SpecificInput

      public CardPaymentMethodSpecificInput withPaymentProduct3208SpecificInput(PaymentProduct3208SpecificInput value)
      Object containing specific input required for OneyDuplo Leroy Merlin payments.

    • getPaymentProduct3209SpecificInput

      public PaymentProduct3209SpecificInput getPaymentProduct3209SpecificInput()
      Object containing specific input required for OneyDuplo Alcampo payments.

    • setPaymentProduct3209SpecificInput

      public void setPaymentProduct3209SpecificInput(PaymentProduct3209SpecificInput value)
      Object containing specific input required for OneyDuplo Alcampo payments.

    • withPaymentProduct3209SpecificInput

      public CardPaymentMethodSpecificInput withPaymentProduct3209SpecificInput(PaymentProduct3209SpecificInput value)
      Object containing specific input required for OneyDuplo Alcampo payments.

    • getPaymentProductId

      public Integer getPaymentProductId()
      Payment product identifier - Please see Products documentation for a full overview of possible values.

    • setPaymentProductId

      public void setPaymentProductId(Integer value)
      Payment product identifier - Please see Products documentation for a full overview of possible values.

    • withPaymentProductId

      public CardPaymentMethodSpecificInput withPaymentProductId(Integer value)
      Payment product identifier - Please see Products documentation for a full overview of possible values.

    • getRecurring

      public CardRecurrenceDetails getRecurring()
      Object containing data related to recurring

    • setRecurring

      public void setRecurring(CardRecurrenceDetails value)
      Object containing data related to recurring

    • withRecurring

      public CardPaymentMethodSpecificInput withRecurring(CardRecurrenceDetails value)
      Object containing data related to recurring

    • getReturnUrl

      public String getReturnUrl()
      The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected.

    • setReturnUrl

      public void setReturnUrl(String value)
      The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected.

    • withReturnUrl

      public CardPaymentMethodSpecificInput withReturnUrl(String value)
      The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected.

    • getSchemeReferenceData

      public String getSchemeReferenceData()
      This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication. In case this value is unknown, a Scheme Reference of an earlier transaction that was part of the same sequence can be used as a fall-back. Still, it is strongly advised to submit this value for any Merchant Initiated Transaction or any recurring transaction (hereby defined as "Subsequent").

    • setSchemeReferenceData

      public void setSchemeReferenceData(String value)
      This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication. In case this value is unknown, a Scheme Reference of an earlier transaction that was part of the same sequence can be used as a fall-back. Still, it is strongly advised to submit this value for any Merchant Initiated Transaction or any recurring transaction (hereby defined as "Subsequent").

    • withSchemeReferenceData

      public CardPaymentMethodSpecificInput withSchemeReferenceData(String value)
      This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication. In case this value is unknown, a Scheme Reference of an earlier transaction that was part of the same sequence can be used as a fall-back. Still, it is strongly advised to submit this value for any Merchant Initiated Transaction or any recurring transaction (hereby defined as "Subsequent").

    • getSkipAuthentication

      @Deprecated public Boolean getSkipAuthentication()
      Deprecated.
      Use threeDSecure.skipAuthentication instead. * true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring. * false = 3D Secure authentication will not be skipped for this transaction. Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
      Deprecated: Use threeDSecure.skipAuthentication instead.
      • true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring.
      • false = 3D Secure authentication will not be skipped for this transaction.

      Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.

    • setSkipAuthentication

      @Deprecated public void setSkipAuthentication(Boolean value)
      Deprecated.
      Use threeDSecure.skipAuthentication instead. * true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring. * false = 3D Secure authentication will not be skipped for this transaction. Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
      Deprecated: Use threeDSecure.skipAuthentication instead.
      • true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring.
      • false = 3D Secure authentication will not be skipped for this transaction.

      Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.

    • withSkipAuthentication

      @Deprecated public CardPaymentMethodSpecificInput withSkipAuthentication(Boolean value)
      Deprecated.
      Use threeDSecure.skipAuthentication instead. * true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring. * false = 3D Secure authentication will not be skipped for this transaction. Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
      Deprecated: Use threeDSecure.skipAuthentication instead.
      • true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring.
      • false = 3D Secure authentication will not be skipped for this transaction.

      Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.

    • getThreeDSecure

      public ThreeDSecure getThreeDSecure()
      Object containing specific data regarding 3-D Secure

    • setThreeDSecure

      public void setThreeDSecure(ThreeDSecure value)
      Object containing specific data regarding 3-D Secure

    • withThreeDSecure

      public CardPaymentMethodSpecificInput withThreeDSecure(ThreeDSecure value)
      Object containing specific data regarding 3-D Secure

    • getToken

      public String getToken()
      ID of the token to use to create the payment.

    • setToken

      public void setToken(String value)
      ID of the token to use to create the payment.

    • withToken

      public CardPaymentMethodSpecificInput withToken(String value)
      ID of the token to use to create the payment.

    • getTokenize

      public Boolean getTokenize()
      Indicates if this transaction should be tokenized
      • true - Tokenize the transaction. Note that a payment on the payment platform that results in a status REDIRECTED cannot be tokenized in this way.
      • false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.

    • setTokenize

      public void setTokenize(Boolean value)
      Indicates if this transaction should be tokenized
      • true - Tokenize the transaction. Note that a payment on the payment platform that results in a status REDIRECTED cannot be tokenized in this way.
      • false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.

    • withTokenize

      public CardPaymentMethodSpecificInput withTokenize(Boolean value)
      Indicates if this transaction should be tokenized
      • true - Tokenize the transaction. Note that a payment on the payment platform that results in a status REDIRECTED cannot be tokenized in this way.
      • false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.

    • getTransactionChannel

      public String getTransactionChannel()
      Indicates the channel via which the payment is created. Allowed values:
      • ECOMMERCE - The transaction is a regular E-Commerce transaction.
      • MOTO - The transaction is a Mail Order/Telephone Order.

      Defaults to ECOMMERCE.

    • setTransactionChannel

      public void setTransactionChannel(String value)
      Indicates the channel via which the payment is created. Allowed values:
      • ECOMMERCE - The transaction is a regular E-Commerce transaction.
      • MOTO - The transaction is a Mail Order/Telephone Order.

      Defaults to ECOMMERCE.

    • withTransactionChannel

      public CardPaymentMethodSpecificInput withTransactionChannel(String value)
      Indicates the channel via which the payment is created. Allowed values:
      • ECOMMERCE - The transaction is a regular E-Commerce transaction.
      • MOTO - The transaction is a Mail Order/Telephone Order.

      Defaults to ECOMMERCE.

    • getUnscheduledCardOnFileRequestor

      public String getUnscheduledCardOnFileRequestor()
      Indicates which party initiated the unscheduled recurring transaction. Allowed values:
      • merchantInitiated - Merchant Initiated Transaction.
      • cardholderInitiated - Cardholder Initiated Transaction. Note:
      • This property is not allowed if isRecurring is true.
      • When a customer has chosen to use a token on a hosted checkout this property is set to "cardholderInitiated".

    • setUnscheduledCardOnFileRequestor

      public void setUnscheduledCardOnFileRequestor(String value)
      Indicates which party initiated the unscheduled recurring transaction. Allowed values:
      • merchantInitiated - Merchant Initiated Transaction.
      • cardholderInitiated - Cardholder Initiated Transaction. Note:
      • This property is not allowed if isRecurring is true.
      • When a customer has chosen to use a token on a hosted checkout this property is set to "cardholderInitiated".

    • withUnscheduledCardOnFileRequestor

      public CardPaymentMethodSpecificInput withUnscheduledCardOnFileRequestor(String value)
      Indicates which party initiated the unscheduled recurring transaction. Allowed values:
      • merchantInitiated - Merchant Initiated Transaction.
      • cardholderInitiated - Cardholder Initiated Transaction. Note:
      • This property is not allowed if isRecurring is true.
      • When a customer has chosen to use a token on a hosted checkout this property is set to "cardholderInitiated".

    • getUnscheduledCardOnFileSequenceIndicator

      public String getUnscheduledCardOnFileSequenceIndicator()
      • first = This transaction is the first of a series of unscheduled recurring transactions
      • subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions Note: this property is not allowed if isRecurring is true.

    • setUnscheduledCardOnFileSequenceIndicator

      public void setUnscheduledCardOnFileSequenceIndicator(String value)
      • first = This transaction is the first of a series of unscheduled recurring transactions
      • subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions Note: this property is not allowed if isRecurring is true.

    • withUnscheduledCardOnFileSequenceIndicator

      public CardPaymentMethodSpecificInput withUnscheduledCardOnFileSequenceIndicator(String value)
      • first = This transaction is the first of a series of unscheduled recurring transactions
      • subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions Note: this property is not allowed if isRecurring is true.