About the Site Payment Method Types API

The Site Payment Method Types API allows you to get the payment method types potentially available for use on a site. Some examples of payment method types are Mastercard and Visa cards, Apple Pay, Google Pay, PayPal, iDEAL, Klarna, and Pix.

Payment method types must be configured by the merchant before they can be used to accept payments.

With the Site Payment Method Types API, you:

• Retrieve a payment method type by its ID.
• Retrieve all of a site's payment method types.

This is a read-only API. However, the list of payment method types can be supplemented by implementing a Payment Service Provider service plugin. This plugin can be implemented so that the payment method type is available to:

• All sites following an approval process
• A specific site without approval

This API returns data according to your locale. You can define your locale by specifying a countryCode, languageCode, currencyCode when calling Get Site Payment Method Type or List Site Payment Method Types. For more detailed information, see the descriptions for the countryCode, languageCode, currencyCode parameters of the methods.

Before you begin

This API is for use by Wix users who have onboarded to accept payments through Wix.

Use cases

• Import payment method type properties into external accounting software

Terminology

• Site Payment Method Type: A way to pay online or offline for goods or services offered by a specific Wix site.
• Merchant: A Wix user who owns a website and has onboarded to accept payments through Wix, or a collaborator on that site with sufficient permissions.
• Buyer: A user of a merchant's site who makes a purchase from the merchant.