---
schema_version: "1"
id: b5a9a7a669d41c4c3851928e82447b49a8307f6176b6e2e4c990fa9be4e3cfdb
title: PaymentsSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_paymentssettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_paymentssettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: f863770ea337dee3311fb8a06adb4952290752993bca73e2714cbfd151cda206
description: Represents the Salesforce Payments settings when this feature is enabled for the org.
---
# PaymentsSettings

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

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") 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.

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

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

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Payments</members\>
        <name\>Settings</name\>
    </types\>
    <version\>57.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).