Class PaymentProduct
Inherited Members
Namespace: Ingenico.Connect.Sdk.Domain.Product.Definitions
Assembly: connect-sdk-dotnet.dll
Syntax
public class PaymentProduct
Properties
AccountsOnFile
List of tokens for that payment product
Declaration
public IList<AccountOnFile> AccountsOnFile { get; set; }
Property Value
Type | Description |
---|---|
IList<AccountOnFile> |
AcquirerCountry
ISO 3166-1 alpha-2 country code which indicates the most likely country code of the acquirer that will process the transaction. For Google Pay (paymentProductId 320) transactions this acquirerCountry is should be provided in the transactionInfo.countryCode for merchants that use an acquirer that is based in one of the European Economic Area (EEA) countries to make sure the transaction is compliant with the PSD2 Strong Customer Authentication (SCA) requirements. More information on Strong Customer Authentication compliance for Google Pay can be found at https://developers.google.com/pay/api/web/guides/resources/sca
Declaration
public string AcquirerCountry { get; set; }
Property Value
Type | Description |
---|---|
string |
AllowsInstallments
Indicates if the product supports installments
- true - This payment supports installments
- false - This payment does not support installments
Declaration
public bool? AllowsInstallments { get; set; }
Property Value
Type | Description |
---|---|
bool? |
AllowsRecurring
Indicates if the product supports recurring payments
- true - This payment product supports recurring payments
- false - This payment product does not support recurring transactions and can only be used for one-off payments
Declaration
public bool? AllowsRecurring { get; set; }
Property Value
Type | Description |
---|---|
bool? |
AllowsTokenization
Indicates if the payment details can be tokenized for future re-use
- true - Payment details from payments done with this payment product can be tokenized for future re-use
- false - Payment details from payments done with this payment product can not be tokenized
Declaration
public bool? AllowsTokenization { get; set; }
Property Value
Type | Description |
---|---|
bool? |
AuthenticationIndicator
Indicates if the payment product supports 3D Security (mandatory, optional or not needed).
Declaration
public AuthenticationIndicator AuthenticationIndicator { get; set; }
Property Value
Type | Description |
---|---|
AuthenticationIndicator |
AutoTokenized
Indicates if the payment details can be automatically tokenized for future re-use
- true - Payment details from payments done with this payment product can be automatically tokenized for future re-use
- false - Payment details from payments done with this payment product can not be automatically tokenized
Declaration
public bool? AutoTokenized { get; set; }
Property Value
Type | Description |
---|---|
bool? |
CanBeIframed
This property is only relevant for payment products that use third party redirects. This property indicates if the third party disallows their payment pages to be embedded in an iframe using the X-Frame-Options header.
- true - the third party allows their payment pages to be embedded in an iframe.
- false - the third party disallows their payment pages to be embedded in an iframe.
Declaration
public bool? CanBeIframed { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DeviceFingerprintEnabled
Indicates if device fingerprint is enabled for the product
- true
- false
Declaration
public bool? DeviceFingerprintEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DisplayHints
Object containing display hints like the order in which the product should be shown, the name of the product and the logo
Declaration
public PaymentProductDisplayHints DisplayHints { get; set; }
Property Value
Type | Description |
---|---|
PaymentProductDisplayHints |
Fields
Object containing all the fields and their details that are associated with this payment product. If you are not interested in the data in the fields you should have us filter them out (using filter=fields in the query-string)
Declaration
public IList<PaymentProductField> Fields { get; set; }
Property Value
Type | Description |
---|---|
IList<PaymentProductField> |
FieldsWarning
If one or more of the payment product fields could not be constructed, no payment product fields will be returned and a message will be present in this property stating why.
Declaration
public string FieldsWarning { get; set; }
Property Value
Type | Description |
---|---|
string |
Id
The ID of the payment product in our system
Declaration
public int? Id { get; set; }
Property Value
Type | Description |
---|---|
int? |
IsAuthenticationSupported
Indicates if the payment product supports 3D-Secure.
Declaration
public bool? IsAuthenticationSupported { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IsJavaScriptRequired
This property indicates if the payment product requires JavaScript to be enabled on the customer's browser. This is usually only true if the payment product depends on a third party JavaScript integration.
- true - the payment product requires JavaScript to be enabled.
- false - the payment product does not require JavaScript to be enabled. This is the default value if the property is not present.
Declaration
public bool? IsJavaScriptRequired { get; set; }
Property Value
Type | Description |
---|---|
bool? |
MaxAmount
Maximum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
Declaration
public long? MaxAmount { get; set; }
Property Value
Type | Description |
---|---|
long? |
MinAmount
Minimum amount in cents (using 2 decimals, so 1 EUR becomes 100 cents) for transactions done with this payment product
Declaration
public long? MinAmount { get; set; }
Property Value
Type | Description |
---|---|
long? |
MobileIntegrationLevel
This provides insight into the level of support for payments using a device with a smaller screen size. You can for instance use this to rank payment products differently on devices with a smaller screen. Possible values are:
- NO_SUPPORT - The payment product does not work at all on a mobile device
- BASIC_SUPPORT - The payment product has not optimized its user experience for devices with smaller screens
- OPTIMISED_SUPPORT - The payment product offers a user experience that has been optimized for devices with smaller screens
Declaration
public string MobileIntegrationLevel { get; set; }
Property Value
Type | Description |
---|---|
string |
PaymentMethod
Indicates which payment method will be used for this payment product. Payment method is one of:
- bankTransfer
- card
- cash
- directDebit
- eInvoice
- invoice
- redirect
Declaration
public string PaymentMethod { get; set; }
Property Value
Type | Description |
---|---|
string |
PaymentProduct302SpecificData
Apple Pay (payment product 302) specific details.
Declaration
public PaymentProduct302SpecificData PaymentProduct302SpecificData { get; set; }
Property Value
Type | Description |
---|---|
PaymentProduct302SpecificData |
PaymentProduct320SpecificData
Google Pay (payment product 320) specific details.
Declaration
public PaymentProduct320SpecificData PaymentProduct320SpecificData { get; set; }
Property Value
Type | Description |
---|---|
PaymentProduct320SpecificData |
PaymentProduct863SpecificData
WeChat Pay (payment product 863) specific details.
Declaration
public PaymentProduct863SpecificData PaymentProduct863SpecificData { get; set; }
Property Value
Type | Description |
---|---|
PaymentProduct863SpecificData |
PaymentProductGroup
The payment product group that has this payment product, if there is any. Not populated otherwise. Currently only one payment product group is supported:
- cards
Declaration
public string PaymentProductGroup { get; set; }
Property Value
Type | Description |
---|---|
string |
SupportsMandates
Indicates whether the payment product supports mandates.
Declaration
public bool? SupportsMandates { get; set; }
Property Value
Type | Description |
---|---|
bool? |
UsesRedirectionTo3rdParty
Indicates whether the payment product requires redirection to a third party to complete the payment. You can use this to filter out products that require a redirect if you don't want to support that.
- true - Redirection is required
- false - No redirection is required
Declaration
public bool? UsesRedirectionTo3rdParty { get; set; }
Property Value
Type | Description |
---|---|
bool? |