Package com.onlinepayments.domain

Class CardPaymentMethodSpecificInputBase

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

  • Constructor Details

    • CardPaymentMethodSpecificInputBase

      public CardPaymentMethodSpecificInputBase()

  • 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase 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.

    • getCurrencyConversionSpecificInput

      public CurrencyConversionSpecificInput getCurrencyConversionSpecificInput()
      Object containing specific input required for Dynamic Currency Conversion.

    • setCurrencyConversionSpecificInput

      public void setCurrencyConversionSpecificInput(CurrencyConversionSpecificInput value)
      Object containing specific input required for Dynamic Currency Conversion.

    • withCurrencyConversionSpecificInput

      public CardPaymentMethodSpecificInputBase withCurrencyConversionSpecificInput(CurrencyConversionSpecificInput value)
      Object containing specific input required for Dynamic Currency Conversion.

    • 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 CardPaymentMethodSpecificInputBase 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).

    • 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase withPaymentProduct3209SpecificInput(PaymentProduct3209SpecificInput value)
      Object containing specific input required for OneyDuplo Alcampo payments.

    • getPaymentProduct5100SpecificInput

      public PaymentProduct5100SpecificInput getPaymentProduct5100SpecificInput()
      Object containing specific input required for Cpay payments.

    • setPaymentProduct5100SpecificInput

      public void setPaymentProduct5100SpecificInput(PaymentProduct5100SpecificInput value)
      Object containing specific input required for Cpay payments.

    • withPaymentProduct5100SpecificInput

      public CardPaymentMethodSpecificInputBase withPaymentProduct5100SpecificInput(PaymentProduct5100SpecificInput value)
      Object containing specific input required for Cpay 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase withRecurring(CardRecurrenceDetails value)
      Object containing data related to recurring

    • getThreeDSecure

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

    • setThreeDSecure

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

    • withThreeDSecure

      public CardPaymentMethodSpecificInputBase withThreeDSecure(ThreeDSecureBase 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase 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 CardPaymentMethodSpecificInputBase 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.