PaymentGatewayProvider

Represents the metadata associated with a payment gateway provider. This type extends the Metadata metadata type and inherits its fullName field.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

PaymentGatewayProvider components have the suffix paymentGatewayProvider and are stored in the paymentGatewayProviders folder.

Version

PaymentGatewayProvider components are available in API version 48.0 and later.

Special Access Rules

To access PaymentGatewayProvider, you must have a Salesforce Order Management license with the PaymentPlatform org permission activated.

Fields

Field Name	Field Type	Description
apexAdapter	string	The Apex adapter class name for your payment gateway. This field is unique within your organization.
comments	string	Users can add comments to provide additional details about a record. Maximum of 1000 characters.
idempotencySupported	IdempotencySupportStatus (enumeration of type String)	Required. Defines whether the payment gateway ignores duplicate payment gateway calls (`Yes`) or whether it processes duplicate gateway calls (`No`). `Yes` `No`
isProtected	boolean	Indicates whether the payment gateway provider is protected (`true`) or not protected (`false`). Protected components can’t be linked to or referenced by components created in a subscriber org. A developer can delete a protected component in a future release without worrying about failing installations. However, once a component is marked as unprotected and is released globally, the developer can’t delete it.
masterLabel	string	Required. The label of this payment gateway provider record.

Declarative Metadata Sample Definition

The following is an example of a PaymentGatewayProvider component.

1<PaymentGatewayProvider xmlns="http://soap.sforce.com/2006/04/metadata">
2    <apexAdapter>SalesforceAdapter</apexAdapter>
3    <idempotencySupported>Yes</idempotencySupported>
4    <masterLabel>SalesforceAdapter</masterLabel>
5    <isProtected>true</isProtected>
6    <comments>Comments</comments>
7</PaymentGatewayProvider>

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

1<Package xmlns="http://soap.sforce.com/2006/04/metadata">
2    <types>
3        <members>*</members>
4        <name>PaymentGatewayProvider</name>
5    </types>
6    <version>48.0</version>
7</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide