PaymentsSharingSettings

Represents the settings to enable account-based sharing to view details related to Revenue Cloud Billing on the objects for Payments and Refunds.

Use account-based sharing to view Revenue Cloud Billing details on these objects.

Payment
Payment Authorization
Payment Authorization Adjustment
Refund
Saved Payment Method

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

The PaymentsSharingSettings values are stored in the PaymentsSharing.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

PaymentsSharingSettings components are available in API version 64.0 and later.

Special Access Rules

If you don’t have the View All Records permission to the Payments and Refunds objects, then you can:

View the records only when the records have a value for the Account field and a shared Account ID.
Use Payment Sale API and Payment Authorization API irrespective of whether the Account ID is null or shared.
Use Payment Capture API, Authorization Reversal API, Create Payment Refund Billing API, and Apply Refunds to Payments API only when the corresponding Authorization or Payment record has a shared Account ID.

See Commerce Payments resources.

Fields

Field Name	Field Type	Description
`delegatePaymentSharingToAccount`	boolean	Indicates whether sharing for these objects must be delegated to the corresponding Account record (`true`) or not (`false`). Payment, Payment Authorization, Payment Authorization Adjustment, Refund, or Saved Payment Method. The default value is `false`. If this field’s value is set to `true`, you get access to these objects based on the access you have for the Account object. For example, if you have Read access to the Account object, you get Read access to the objects for Payments and Refunds. For saved payment method, the sharing is delegated to merchant account instead of account if the user has Manage Saved Payment Methods user permission.

Declarative Metadata Sample Definition

The following is an example of a PaymentsSharingSettings component.

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

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>PaymentsSharing</members>
5        <name>Settings</name>
6    </types>
7    <version>68.0</version>
8</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.