GatewayProviderPaymentMethodType

Represents an entity that allows integrators and payment providers to choose an active payment to receive an order’s payment data rather than allowing the Salesforce Order Management platform to select a default payment method. This object is available in API version 51.0 and later.

This type extends Metadata and inherits its fields.

Introduced in API version 51.0.

GatewayProviderPaymentMethodType components are stored in the gatewayProviderPaymentMethodTypes directory. Files use the .gatewayProviderPaymentMethodType file extension.

• Type: string
• Required: No
• Description: Additional details about the gateway provider payment method type record. Max length is 1000 characters.

• Type: string
• Required: No
• Description: Links the Salesforce payment method to the payment method used in the Salesforce Order Management storefront. Your payment gateway integration uses this field when finding a payment method to link to a payment.

• Type: string
• Required: Yes
• Description: Required. The gateway provider payment method type name that appears in the user interface.

• Type: string
• Required: No
• Description: Specifies the payment gateway provider that Salesforce Order Management should use when processing payments. One payment gateway provider can be related to multiple payment method types.

• Type: string
• Required: No
• Description: Specifies the type of payment method used on an order in Salesforce Order Management.

• Type: string
• Required: No
• Description: ID of the record type entity related to the gateway provider payment method type.

The following is an example of a GatewayProviderPaymentMethodType component.

1<?xml version="1.0" encoding="UTF-8"?>
2<GatewayProviderPaymentMethodType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <gtwyProviderPaymentMethodType>Klarna</gtwyProviderPaymentMethodType>
4    <masterLabel>Test</masterLabel>
5    <paymentGatewayProvider>adyen__Adyen</paymentGatewayProvider>
6    <paymentMethodType>AlternativePaymentMethod</paymentMethodType>
7    <recordType>AlternativePaymentMethod.Klarna</recordType>
8</GatewayProviderPaymentMethodType>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>GatewayProviderPaymentMethodType</name>
6    </types>
7    <version>51.0</version>
8</Package>