PaymentGatewayProvider

Represents the metadata associated with a payment gateway provider.

This type extends Metadata and inherits its fields.

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

Introduced in API version 48.0.

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

• Type: string
• Required: No
• Description: The Apex adapter class name for your payment gateway. This field is unique within your organization.

• Type: string
• Required: No
• Description: Users can add comments to provide additional details about a record. Maximum of 1000 characters.

• Type: GatewayType (enumeration of type string)
• Required: No
• Description: Defines the payment gateway type.
• Possible values:
  • Adyen
  • Braintree
  • CyberSource
  • Paypal
  • Stripe

• Type: IdempotencySupportStatus (enumeration of type string)
• Required: Yes
• Description: Required. Defines whether the payment gateway ignores duplicate payment gateway calls (Yes) or whether it processes duplicate gateway calls (No).
• Possible values:
  • Yes
  • No

• Type: string
• Required: Yes
• Description: Required. The label of this payment gateway provider record.

The following is an example of a PaymentGatewayProvider component.

1<PaymentGatewayProvider xmlns="http://soap.sforce.com/2006/04/metadata">
2    <apexAdapter>SalesforceAdapter</apexAdapter>
3    <comments>Comments</comments>
4    <gatewayType>Stripe</gatewayType>
5    <idempotencySupported>Yes</idempotencySupported>
6    <masterLabel>SalesforceAdapter</masterLabel>
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>

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.