Site Payment Method Type Object


A way to pay online or offline for goods or services offered by a specific site.

Properties
idstringformat GUIDimmutable

Payment method type ID.


legacyIdstringminLength 1maxLength 50immutable

Value used buy some legacy APIs to refer to this payment method type. Can be empty.


displayNamestringminLength 1maxLength 100

Payment method type display name, based on locale.

Used by Wix when displaying the payment method type, such as in the payment settings page for merchants, or the checkout page for buyers.

Define your locale by specifying a countryCode and languageCode when calling Get Payment Method Type or List Payment Method Types. For more detailed information, see the descriptions for the countryCode and languageCode parameters for those methods.


descriptionstringminLength 1maxLength 1000

Payment method type description, based on locale.

Used by Wix when displaying the payment method type, such as in the payment settings page for merchants, or the checkout page for buyers.

Define your locale by specifying a countryCode and languageCode when calling Get Payment Method Type or List Payment Method Types. For more detailed information, see the descriptions for the countryCode and languageCode parameters for those methods.


featuresFeatures

Features supported for this payment method type.


merchantFlowMerchantFlow

Settings that determine if and how to display this payment method type in the merchant flow. The merchant flow is the process a merchant goes through to configure which payment method types they accept on their site.


buyerFlowBuyerFlow

Settings that determine if and how to display this payment method type in the buyer flow. The buyer flow is the process a buyer goes through to make a purchase att checkout.


brandOnlyboolean

Whether this payment method type is only used to represent a supported payment brand for another payment method type.

For example, a Visa payment method is used to indicate that Visa can be used for credit card transactions. But the Visa payment method type is not used to accept payments. Instead, the credit card payment method type is used.

Brand-only payment method types cannot be used to accept payments, and are not listed as a payment method type in a site's dashboard.


inPersonboolean

Whether the payment method type can only be used for in-person payments, such as cash, point-of-sale payments, and card readers.


transactionExpirationDelayInSecondsintegerminimum 1maximum 15552000format int32

Time (in seconds after which a transaction is marked as expired if it is not completed.

Max: 15552000 (180 days)


currencyRestrictedboolean

Indicates that payment method type is restricted for the provided currencyCode.


currencyRestrictionEnabledboolean

Indicates the payment method type has currency restriction and it is enabled.


allowedCurrencyCodesArray <string>minItems 0maxItems 100format CURRENCY

Allowed currencies

Did this help?