PaymentsSettings

Represents the Salesforce Payments settings when this feature is enabled for the org.

Parent Type and Manifest Access

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

PaymentsSettings values are stored in the Payments.settings file in the settings folder.

The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

PaymentsSettings is available in API version 57.0 and later.

Special Access Rules

This metadata type is only accessible by developers and customers using Salesforce Payments.

Fields

Field Name	Description
enablePayments	Field Type boolean Description Indicates whether Salesforce Payments is enabled (`true`) or not (`false`) for an org. The default is false.

Declarative Metadata Sample Definition

The following is a sample payments.settings metadata file.

1<?xml version="1.0" encoding="UTF-8"?>
2   <PaymentsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3     <enablePayments>true</enablePayments>
4   </PaymentsSettings>

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>Payments</members>
4        <name>Settings</name>
5    </types>
6    <version>57.0</version>
7</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide