getSitePaymentMethodType( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a payment method type, with some fields localized according to the caller's language and country.

The callers language and country are taken from the languageCode or countryCode parameters in the request. If these parameters are not specified, the values are taken from context of the call if possible. For example, if this method is called from a Wix site, the selected language on that site will be used. If language or country can't be determined, the method doesn't perform any filtering or localization.

Language and country are used to determine localized values for the displayName, description fields. Country is used to determine localized values for the priority and promoted fields in merchantFlow and buyerFlow. currencyCode is used to determine the eligibility of payment method types for the provided currency.

Permissions
Manage Blog
Manage Bookings Services and Settings
Manage Challenges
Access Verticals by Automations
Set Up Automations
Manage Payments - All Permissions
Read Site Payment Method Types
Manage Events
Manage Portfolio
Manage Restaurants - all permissions
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
sitePaymentMethodTypeIdstringRequired

Site payment method type ID.


optionsGetSitePaymentMethodTypeOptions
Returns
Return Type:Promise<SitePaymentMethodType>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?