> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetSitePaymentMethodType # Package: payments # Namespace: SitePaymentMethodTypeService # Method link: https://dev.wix.com/docs/api-reference/business-management/payments/site-payment-method-types/get-site-payment-method-type.md ## Permission Scopes: Read Site Payment Method Types: SCOPE.DC-PAYMENTS.READ-SITE_PAYMENT_METHOD_TYPES ## Introduction 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. --- ## REST API ### Schema ``` Method: getSitePaymentMethodType Description: 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. URL: https://www.wixapis.com/payments/site-payment-method-types/v1/site-payment-method-types/{sitePaymentMethodTypeId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: sitePaymentMethodTypeId Method parameters: query param name: countryCode | type: countryCode | description: Country used to determine localized values for fields in the response. Must be a 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#officially_assigned_code_elements) format. query param name: currencyCode | type: currencyCode | description: Currency used to determine localized values for fields in the response. Must be a 3-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. query param name: languageCode | type: languageCode | description: Language used to determine localized values for fields in the response. Must be a 2-letter language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. query param name: requestedFields | type: array | description: Requested additional fields - enum: - ALLOWED_CURRENCIES: Return `allowedCurrencyCodes`. param name: sitePaymentMethodTypeId | type: none | required: true Return type: GetSitePaymentMethodTypeResponse - name: sitePaymentMethodType | type: SitePaymentMethodType | description: Requested site payment method type. - name: id | type: string | description: Payment method type GUID. - name: legacyId | type: string | description: Value used buy some legacy APIs to refer to this payment method type. Can be empty. - name: displayName | type: string | description: 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. - name: description | type: string | description: 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. - name: features | type: Features | description: Features supported for this payment method type. - name: expressFlow | type: ExpressFlow | description: Express flow configuration. - name: supported | type: boolean | description: Whether this payment method type can be used in an express flow on checkout. - name: regularFlow | type: RegularFlow | description: Regular flow configuration. - name: supported | type: boolean | description: Whether this payment method type can be used in a regular flow on checkout. - name: disputes | type: Disputes | description: Disputes configuration. - name: supported | type: boolean | description: Whether disputes are supported for this payment method type. - name: installments | type: Installments | description: Installments configuration. - name: supported | type: boolean | description: Whether installments are supported for this payment method type. - name: maxInstallmentLimit | type: integer | description: Max number of installments that can be configured by a provider. - name: allowedCountryCodes | type: array | description: Countries for which installments can be enabled. - name: refunds | type: Refunds | description: Refunds configuration. - name: supported | type: boolean | description: Whether refunds are supported for this payment method type. - name: maxRefundabilityPeriodInDays | type: integer | description: Maximum period in which payments made using this payment method type can be refunded. - name: authCapture | type: AuthCapture | description: Authorize and capture configuration. - name: supported | type: boolean | description: Whether the authorize and capture flow is supported for this payment method type. - name: maxCapturePeriodInDays | type: integer | description: Period to wait for the auth capture to be completed before canceling the transaction. - name: regularTokenization | type: RegularTokenization | description: Regular tokenization configuration. - name: supported | type: boolean | description: Whether the default tokenization mechanism can be configured for this payment method type. - name: customTokenization | type: CustomTokenization | description: Custom tokenization configuration. - name: supported | type: boolean | description: Whether a custom tokenization mechanism can be configured for this payment method type, such as a provider-specific tokenization method. - name: nextAction | type: NextAction | description: Next action configuration. - name: iframe | type: IFrame | description: iframe configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown in an iframe. - name: newTab | type: NewTab | description: New tab configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown in a new tab. - name: fullPageRedirect | type: FullPageRedirect | description: Full page redirect configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown by redirecting to a new page. - name: barcode | type: Barcode | description: Barcode configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown as a barcode to scan. - name: qrCode | type: QrCode | description: QR code configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown as a QR code to scan. - name: credentialOnFile | type: CredentialOnFile | description: Credential-on-File (CoF) configuration. - name: supported | type: boolean | description: Whether the Credential-on-File (CoF) feature is supported for this payment method type. - name: moto | type: Moto | description: Mail Order/Telephone Order (MOTO) configuration. - name: supported | type: boolean | description: Whether Mail Order/Telephone Order (MOTO) is supported for this payment method type. - name: promotionalMessages | type: PromotionalMessages | description: Promotional message configuration. - name: supported | type: boolean | description: Whether promotional messages is supported for this payment method type. - name: merchantFlow | type: MerchantFlow | description: 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. - name: icons | type: array | description: Details about the icons to display for this payment method type on the merchant's Accept Payments page in the site dashboard. Icons are localized according to the locale of the call. Define a locale by specifying a `countryCode` and `languageCode` when calling `Get Payment Method Type` or `List Payment Method Types`. For more detailed information, see the method descriptions. - name: image | type: Image | description: Icon image. - name: id | type: string | description: WixMedia image GUID. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. - name: width | type: integer | description: Original image width. - name: tag | type: string | description: Icon tag. Payment method types can have multiple icons, and tags are used to differentiate between them. For example, the UI design for multiple payment method types is upgraded, and now they each have an old icon tagged "v1" and a new icon tagged "v2". Developers can then easily choose to display all the original "v1" style of icons, or all the new "v2" style. - name: format | type: Format | description: Icon image format. - enum: SVG, PNG - name: priority | type: integer | description: Priority given to this payment method type in the list shown to the merchant. A lower value relative to other payment method types means a higher position on the list. - name: promoted | type: boolean | description: Whether the payment method type is promoted. Promoted payment method types are displayed more prominently on the Accept Payments page. - name: hidden | type: boolean | description: Whether the merchant cannot choose to accept payments from this payment method type. - name: countryRestricted | type: boolean | description: Indicates that payment method type is restricted in provided country. - name: buyerFlow | type: BuyerFlow | description: 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. - name: icons | type: array | description: Details about the icons to display for this payment method type on a site's checkout page. Icons are localized according to the locale of the call. Define a locale by specifying a `countryCode` and `languageCode` when calling `Get Payment Method Type` or `List Payment Method Types`. For more detailed information, see the method descriptions. - name: priority | type: integer | description: The priority given to this payment method type in the list of payment method types shown to the buyer. A lower value relative to other payment method types means a higher position on the list. - name: hidden | type: boolean | description: Whether the merchant cannot choose to accept payments from this payment method type. - name: countryRestricted | type: boolean | description: Indicates that payment method type is restricted in provided country. - name: minPaymentAmount | type: string | description: Minimum payment amount that can be made with this payment method type. If the request omits `currencyCode`, the field is not set because its value depends on the currency. - name: brandOnly | type: boolean | description: 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. - name: inPerson | type: boolean | description: Whether the payment method type can only be used for in-person payments, such as cash, point-of-sale payments, and card readers. - name: transactionExpirationDelayInSeconds | type: integer | description: Time (in seconds after which a transaction is marked as expired if it is not completed. Max: `15552000` (180 days) - name: currencyRestricted | type: boolean | description: Indicates that payment method type is restricted for the provided `currencyCode`. - name: currencyRestrictionEnabled | type: boolean | description: Indicates the payment method type has currency restriction and it is enabled. - name: allowedCurrencyCodes | type: array | description: Allowed currencies - name: paymentBrands | type: array | description: List of supported payment brands. These brands are represented by other site payment method types. The purpose of this list is to support the display of the brands' icons next to the payment method type. - name: paymentBrandId | type: string | description: GUID of a payment method type representing a payment brand. ``` ### Examples ### Get Site Payment Method Type Retrieves a Site Payment Method Type ```curl curl -X GET \ 'https://www.wixapis.com/payments/site-payment-method-types/v1/site-payment-method-types/a536f171-a501-4078-9ff4-f66957f67540' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.payments.SitePaymentMethodTypeService.getSitePaymentMethodType(sitePaymentMethodTypeId, options) Description: 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. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: sitePaymentMethodTypeId Method parameters: param name: options | type: GetSitePaymentMethodTypeOptions none - name: languageCode | type: string | description: Language used to determine localized values for fields in the response. Must be a 2-letter language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. - name: countryCode | type: string | description: Country used to determine localized values for fields in the response. Must be a 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#officially_assigned_code_elements) format. - name: currencyCode | type: string | description: Currency used to determine localized values for fields in the response. Must be a 3-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. - name: requestedFields | type: array | description: Requested additional fields - enum: - ALLOWED_CURRENCIES: Return `allowedCurrencyCodes`. param name: sitePaymentMethodTypeId | type: string | description: Site payment method type GUID. | required: true Return type: PROMISE - name: _id | type: string | description: Payment method type GUID. - name: legacyId | type: string | description: Value used buy some legacy APIs to refer to this payment method type. Can be empty. - name: displayName | type: string | description: 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. - name: description | type: string | description: 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. - name: features | type: Features | description: Features supported for this payment method type. - name: expressFlow | type: ExpressFlow | description: Express flow configuration. - name: supported | type: boolean | description: Whether this payment method type can be used in an express flow on checkout. - name: regularFlow | type: RegularFlow | description: Regular flow configuration. - name: supported | type: boolean | description: Whether this payment method type can be used in a regular flow on checkout. - name: disputes | type: Disputes | description: Disputes configuration. - name: supported | type: boolean | description: Whether disputes are supported for this payment method type. - name: installments | type: Installments | description: Installments configuration. - name: supported | type: boolean | description: Whether installments are supported for this payment method type. - name: maxInstallmentLimit | type: integer | description: Max number of installments that can be configured by a provider. - name: allowedCountryCodes | type: array | description: Countries for which installments can be enabled. - name: refunds | type: Refunds | description: Refunds configuration. - name: supported | type: boolean | description: Whether refunds are supported for this payment method type. - name: maxRefundabilityPeriodInDays | type: integer | description: Maximum period in which payments made using this payment method type can be refunded. - name: authCapture | type: AuthCapture | description: Authorize and capture configuration. - name: supported | type: boolean | description: Whether the authorize and capture flow is supported for this payment method type. - name: maxCapturePeriodInDays | type: integer | description: Period to wait for the auth capture to be completed before canceling the transaction. - name: regularTokenization | type: RegularTokenization | description: Regular tokenization configuration. - name: supported | type: boolean | description: Whether the default tokenization mechanism can be configured for this payment method type. - name: customTokenization | type: CustomTokenization | description: Custom tokenization configuration. - name: supported | type: boolean | description: Whether a custom tokenization mechanism can be configured for this payment method type, such as a provider-specific tokenization method. - name: nextAction | type: NextAction | description: Next action configuration. - name: iframe | type: IFrame | description: iframe configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown in an iframe. - name: newTab | type: NewTab | description: New tab configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown in a new tab. - name: fullPageRedirect | type: FullPageRedirect | description: Full page redirect configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown by redirecting to a new page. - name: barcode | type: Barcode | description: Barcode configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown as a barcode to scan. - name: qrCode | type: QrCode | description: QR code configuration. - name: supported | type: boolean | description: Whether the next payment action can be shown as a QR code to scan. - name: credentialOnFile | type: CredentialOnFile | description: Credential-on-File (CoF) configuration. - name: supported | type: boolean | description: Whether the Credential-on-File (CoF) feature is supported for this payment method type. - name: moto | type: Moto | description: Mail Order/Telephone Order (MOTO) configuration. - name: supported | type: boolean | description: Whether Mail Order/Telephone Order (MOTO) is supported for this payment method type. - name: promotionalMessages | type: PromotionalMessages | description: Promotional message configuration. - name: supported | type: boolean | description: Whether promotional messages is supported for this payment method type. - name: merchantFlow | type: MerchantFlow | description: 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. - name: icons | type: array | description: Details about the icons to display for this payment method type on the merchant's Accept Payments page in the site dashboard. Icons are localized according to the locale of the call. Define a locale by specifying a `countryCode` and `languageCode` when calling `Get Payment Method Type` or `List Payment Method Types`. For more detailed information, see the method descriptions. - name: image | type: string | description: Icon image. - name: tag | type: string | description: Icon tag. Payment method types can have multiple icons, and tags are used to differentiate between them. For example, the UI design for multiple payment method types is upgraded, and now they each have an old icon tagged "v1" and a new icon tagged "v2". Developers can then easily choose to display all the original "v1" style of icons, or all the new "v2" style. - name: format | type: Format | description: Icon image format. - enum: SVG, PNG - name: priority | type: integer | description: Priority given to this payment method type in the list shown to the merchant. A lower value relative to other payment method types means a higher position on the list. - name: promoted | type: boolean | description: Whether the payment method type is promoted. Promoted payment method types are displayed more prominently on the Accept Payments page. - name: hidden | type: boolean | description: Whether the merchant cannot choose to accept payments from this payment method type. - name: countryRestricted | type: boolean | description: Indicates that payment method type is restricted in provided country. - name: buyerFlow | type: BuyerFlow | description: 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. - name: icons | type: array | description: Details about the icons to display for this payment method type on a site's checkout page. Icons are localized according to the locale of the call. Define a locale by specifying a `countryCode` and `languageCode` when calling `Get Payment Method Type` or `List Payment Method Types`. For more detailed information, see the method descriptions. - name: priority | type: integer | description: The priority given to this payment method type in the list of payment method types shown to the buyer. A lower value relative to other payment method types means a higher position on the list. - name: hidden | type: boolean | description: Whether the merchant cannot choose to accept payments from this payment method type. - name: countryRestricted | type: boolean | description: Indicates that payment method type is restricted in provided country. - name: minPaymentAmount | type: string | description: Minimum payment amount that can be made with this payment method type. If the request omits `currencyCode`, the field is not set because its value depends on the currency. - name: brandOnly | type: boolean | description: 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. - name: inPerson | type: boolean | description: Whether the payment method type can only be used for in-person payments, such as cash, point-of-sale payments, and card readers. - name: transactionExpirationDelayInSeconds | type: integer | description: Time (in seconds after which a transaction is marked as expired if it is not completed. Max: `15552000` (180 days) - name: currencyRestricted | type: boolean | description: Indicates that payment method type is restricted for the provided `currencyCode`. - name: currencyRestrictionEnabled | type: boolean | description: Indicates the payment method type has currency restriction and it is enabled. - name: allowedCurrencyCodes | type: array | description: Allowed currencies - name: paymentBrands | type: array | description: List of supported payment brands. These brands are represented by other site payment method types. The purpose of this list is to support the display of the brands' icons next to the payment method type. - name: paymentBrandId | type: string | description: GUID of a payment method type representing a payment brand. ``` ### Examples ### getSitePaymentMethodType ```javascript import { sitePaymentMethodTypes } from '@wix/payments'; async function getSitePaymentMethodType(sitePaymentMethodTypeId,options) { const response = await sitePaymentMethodTypes.getSitePaymentMethodType(sitePaymentMethodTypeId,options); }; ``` ### getSitePaymentMethodType (with elevated permissions) ```javascript import { sitePaymentMethodTypes } from '@wix/payments'; import { auth } from '@wix/essentials'; async function myGetSitePaymentMethodTypeMethod(sitePaymentMethodTypeId,options) { const elevatedGetSitePaymentMethodType = auth.elevate(sitePaymentMethodTypes.getSitePaymentMethodType); const response = await elevatedGetSitePaymentMethodType(sitePaymentMethodTypeId,options); } ``` ### getSitePaymentMethodType (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { sitePaymentMethodTypes } from '@wix/payments'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { sitePaymentMethodTypes }, // Include the auth strategy and host as relevant }); async function getSitePaymentMethodType(sitePaymentMethodTypeId,options) { const response = await myWixClient.sitePaymentMethodTypes.getSitePaymentMethodType(sitePaymentMethodTypeId,options); }; ``` ---