CardPaymentMethodSpecificInputBase (onlinepayments-sdk-java 4.12.0 API)

java.lang.Object
- com.onlinepayments.domain.CardPaymentMethodSpecificInputBase

public class CardPaymentMethodSpecificInputBase
extends Object

Object containing the specific input details for card payments

Constructor Summary

Constructors
Constructor and Description

CardPaymentMethodSpecificInputBase()

Constructors
Constructor and Description
`CardPaymentMethodSpecificInputBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAllowDynamicLinking()` * true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
`String`	`getAuthorizationMode()` Determines the type of the authorization that will be used.
`CurrencyConversionSpecificInput`	`getCurrencyConversionSpecificInput()` Object containing specific input required for Dynamic Currency Conversion.
`String`	`getInitialSchemeTransactionId()` The unique scheme transactionId of the initial transaction that was performed with SCA.
`PaymentProduct130SpecificInput`	`getPaymentProduct130SpecificInput()` Object containing specific input required for CB payments
`PaymentProduct3208SpecificInput`	`getPaymentProduct3208SpecificInput()` Object containing specific input required for OneyDuplo Leroy Merlin payments.
`PaymentProduct3209SpecificInput`	`getPaymentProduct3209SpecificInput()` Object containing specific input required for OneyDuplo Alcampo payments.
`PaymentProduct5100SpecificInput`	`getPaymentProduct5100SpecificInput()` Object containing specific input required for Cpay payments.
`Integer`	`getPaymentProductId()` Payment product identifier - Please see Products documentation for a full overview of possible values.
`CardRecurrenceDetails`	`getRecurring()` Object containing data related to recurring
`ThreeDSecureBase`	`getThreeDSecure()` Object containing specific data regarding 3-D Secure
`String`	`getToken()` ID of the token to use to create the payment.
`Boolean`	`getTokenize()` Indicates if this transaction should be tokenized * true - Tokenize the transaction.
`String`	`getTransactionChannel()` Indicates the channel via which the payment is created.
`String`	`getUnscheduledCardOnFileRequestor()` Indicates which party initiated the unscheduled recurring transaction.
`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.
`void`	`setAllowDynamicLinking(Boolean value)` * true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
`void`	`setAuthorizationMode(String value)` Determines the type of the authorization that will be used.
`void`	`setCurrencyConversionSpecificInput(CurrencyConversionSpecificInput value)` Object containing specific input required for Dynamic Currency Conversion.
`void`	`setInitialSchemeTransactionId(String value)` The unique scheme transactionId of the initial transaction that was performed with SCA.
`void`	`setPaymentProduct130SpecificInput(PaymentProduct130SpecificInput value)` Object containing specific input required for CB payments
`void`	`setPaymentProduct3208SpecificInput(PaymentProduct3208SpecificInput value)` Object containing specific input required for OneyDuplo Leroy Merlin payments.
`void`	`setPaymentProduct3209SpecificInput(PaymentProduct3209SpecificInput value)` Object containing specific input required for OneyDuplo Alcampo payments.
`void`	`setPaymentProduct5100SpecificInput(PaymentProduct5100SpecificInput value)` Object containing specific input required for Cpay payments.
`void`	`setPaymentProductId(Integer value)` Payment product identifier - Please see Products documentation for a full overview of possible values.
`void`	`setRecurring(CardRecurrenceDetails value)` Object containing data related to recurring
`void`	`setThreeDSecure(ThreeDSecureBase value)` Object containing specific data regarding 3-D Secure
`void`	`setToken(String value)` ID of the token to use to create the payment.
`void`	`setTokenize(Boolean value)` Indicates if this transaction should be tokenized * true - Tokenize the transaction.
`void`	`setTransactionChannel(String value)` Indicates the channel via which the payment is created.
`void`	`setUnscheduledCardOnFileRequestor(String value)` Indicates which party initiated the unscheduled recurring transaction.
`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.
`CardPaymentMethodSpecificInputBase`	`withAllowDynamicLinking(Boolean value)` * true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
`CardPaymentMethodSpecificInputBase`	`withAuthorizationMode(String value)` Determines the type of the authorization that will be used.
`CardPaymentMethodSpecificInputBase`	`withCurrencyConversionSpecificInput(CurrencyConversionSpecificInput value)` Object containing specific input required for Dynamic Currency Conversion.
`CardPaymentMethodSpecificInputBase`	`withInitialSchemeTransactionId(String value)` The unique scheme transactionId of the initial transaction that was performed with SCA.
`CardPaymentMethodSpecificInputBase`	`withPaymentProduct130SpecificInput(PaymentProduct130SpecificInput value)` Object containing specific input required for CB payments
`CardPaymentMethodSpecificInputBase`	`withPaymentProduct3208SpecificInput(PaymentProduct3208SpecificInput value)` Object containing specific input required for OneyDuplo Leroy Merlin payments.
`CardPaymentMethodSpecificInputBase`	`withPaymentProduct3209SpecificInput(PaymentProduct3209SpecificInput value)` Object containing specific input required for OneyDuplo Alcampo payments.
`CardPaymentMethodSpecificInputBase`	`withPaymentProduct5100SpecificInput(PaymentProduct5100SpecificInput value)` Object containing specific input required for Cpay payments.
`CardPaymentMethodSpecificInputBase`	`withPaymentProductId(Integer value)` Payment product identifier - Please see Products documentation for a full overview of possible values.
`CardPaymentMethodSpecificInputBase`	`withRecurring(CardRecurrenceDetails value)` Object containing data related to recurring
`CardPaymentMethodSpecificInputBase`	`withThreeDSecure(ThreeDSecureBase value)` Object containing specific data regarding 3-D Secure
`CardPaymentMethodSpecificInputBase`	`withToken(String value)` ID of the token to use to create the payment.
`CardPaymentMethodSpecificInputBase`	`withTokenize(Boolean value)` Indicates if this transaction should be tokenized * true - Tokenize the transaction.
`CardPaymentMethodSpecificInputBase`	`withTransactionChannel(String value)` Indicates the channel via which the payment is created.
`CardPaymentMethodSpecificInputBase`	`withUnscheduledCardOnFileRequestor(String value)` Indicates which party initiated the unscheduled recurring transaction.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CardPaymentMethodSpecificInputBase
```
public CardPaymentMethodSpecificInputBase()
```
- Method Detail
  - 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 don't support this. In case the acquirer doesn't 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 don't support this. In case the acquirer doesn't 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 don't support this. In case the acquirer doesn't 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).
  - 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
  - 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.

Class CardPaymentMethodSpecificInputBase

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CardPaymentMethodSpecificInputBase

Method Detail

getAllowDynamicLinking

setAllowDynamicLinking

withAllowDynamicLinking

getAuthorizationMode

setAuthorizationMode

withAuthorizationMode

getCurrencyConversionSpecificInput

setCurrencyConversionSpecificInput

withCurrencyConversionSpecificInput

getInitialSchemeTransactionId

setInitialSchemeTransactionId

withInitialSchemeTransactionId

getPaymentProduct130SpecificInput

setPaymentProduct130SpecificInput

withPaymentProduct130SpecificInput

getPaymentProduct3208SpecificInput

setPaymentProduct3208SpecificInput

withPaymentProduct3208SpecificInput

getPaymentProduct3209SpecificInput

setPaymentProduct3209SpecificInput

withPaymentProduct3209SpecificInput

getPaymentProduct5100SpecificInput

setPaymentProduct5100SpecificInput

withPaymentProduct5100SpecificInput

getPaymentProductId

setPaymentProductId

withPaymentProductId

getRecurring

setRecurring

withRecurring

getThreeDSecure

setThreeDSecure

withThreeDSecure

getToken

setToken

withToken

getTokenize

setTokenize

withTokenize

getTransactionChannel

setTransactionChannel

withTransactionChannel

getUnscheduledCardOnFileRequestor

setUnscheduledCardOnFileRequestor

withUnscheduledCardOnFileRequestor

getUnscheduledCardOnFileSequenceIndicator

setUnscheduledCardOnFileSequenceIndicator

withUnscheduledCardOnFileSequenceIndicator