---
schema_version: "1"
id: ac04f7b61334660544cdb17cecf965bd7213e3bdeec570fe834706d4c1ff7fa3
title: PaymentGatewayProvider
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_paymentgatewayprovider.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_paymentgatewayprovider.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 1048317272f90611942e31d1fd576026b8faa4318213c45979df675a9d049724
description: Represents the metadata associated with a payment gateway provider. This type extends the Metadata metadata type and inherits its fullName field.
---
# PaymentGatewayProvider

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

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## 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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d736851e99">Field Name</th>

              <th class="featureTableHeader  " id="d736851e102">Field Type</th>

              <th class="featureTableHeader  " id="d736851e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">apexAdapter</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">string</td>

              <td class="entry" headers="d736851e105" data-title="Description">The Apex adapter class name for your payment gateway. This field is unique
                within your organization.</td>

            </tr>

            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">comments</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">string</td>

              <td class="entry" headers="d736851e105" data-title="Description">Users can add comments to provide additional details about a record. Maximum of
                1000 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">gatewayType</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">GatewayType (enumeration of type String)</td>

              <td class="entry" headers="d736851e105" data-title="Description">Defines the payment gateway type.<a name="ul_p4n_yln_p3c"><!-- --></a>
                <ul class="ul bulletList" id="ul_p4n_yln_p3c">
                  <li class="li"><samp class="codeph nolang">Adyen</samp></li>

                  <li class="li"><samp class="codeph nolang">Braintree</samp></li>

                  <li class="li"><samp class="codeph nolang">CyberSource</samp></li>

                  <li class="li"><samp class="codeph nolang">Paypal</samp></li>

                  <li class="li"><samp class="codeph nolang">Stripe</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">idempotencySupported</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">IdempotencySupportStatus (enumeration of type String)</td>

              <td class="entry" headers="d736851e105" data-title="Description">Required. Defines whether the payment gateway ignores duplicate payment gateway
                calls (<samp class="codeph nolang">Yes</samp>) or whether it processes duplicate
                gateway calls (<samp class="codeph nolang">No</samp>).<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Yes</samp></li>

                  <li class="li"><samp class="codeph nolang">No</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d736851e99" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d736851e102" data-title="Field Type">string</td>

              <td class="entry" headers="d736851e105" data-title="Description">Required. The label of this payment gateway provider record.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a PaymentGatewayProvider component.

<PaymentGatewayProvider xmlns="http://soap.sforce.com/2006/04/metadata">
    <apexAdapter\>SalesforceAdapter</apexAdapter\>
    <comments\>Comments</comments\>
    <gatewayType\>Stripe</gatewayType\>
    <idempotencySupported\>Yes</idempotencySupported\>
    <masterLabel\>SalesforceAdapter</masterLabel\>
</PaymentGatewayProvider\>

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

<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>\*</members\>
        <name\>PaymentGatewayProvider</name\>
    </types\>
    <version\>48.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).