Set Up Third-Party Payment Gateways

Initial Setup for Configuring Third-Party Payment Gateway

1. Create an e-commerce merchant account in the third-party payment gateway that you want to implement.
   1. Log in to your third-party payment gateway provider and add an e-commerce merchant account.
   2. Navigate to the key management, developer, or advanced settings section of your chosen payment gateway platform, and generate an API key or secret key.

      Your API key would look like: AQEvhmfxJ43HaxxHw0m/n3Q5qf3Ve4pBCIBMV3dVwyD4zesmTx/rk8/RZRz2w0bDdqMQwV1bDb7kfNy1WIxIIkxgBw==-C5bPe6tPCqOM35AEGroDa54J1Bl9AnsQKrDsDofVlrk=-i1ibf$Hu2v>8jR:Y9nU.

   3. Note the merchant account user name and API key. You need them to create the named credentials.
2. Create your payment gateway Apex classes in your Salesforce org.
   1. Obtain the adapter class details from your payment gateway provider or AppExchange.
      To build and set up payment gateway adapters, see Payment Gateway Adapters. To define your Apex classes, see Commerce Payments namespace.
   2. Save your Apex classes. Note the adapter name as you need it to create your payment gateway provider.
3. Create a legacy named credential in your Salesforce org to specify authentication parameters and the URL of your Apex callout endpoint.
   1. Specify a user-friendly name for the label and a unique identifier for the name.
   2. Enter the URL of your third-party payment gateway.
   3. Select Named Principal as the identity type and Password Authentication as the authentication protocol.
   4. Use your merchant account user name as the username. Use the API key as password as required by your payment gateway provider.
   5. Save the named credentials as you need them to create your payment gateway.
4. Register your third-party payment gateway site in your Salesforce org to make sure that Apex callouts from the org to the payment gateway site are successful.
   1. Enter a name and URL of your third-party payment gateway.
   2. Mark the site as active and save your changes.
5. Add your third-party payment gateway URL as a trusted URL in your Salesforce org.
   1. Enter an API name.
   2. Enter the URL of your third-party payment gateway.
   3. Mark the URL as active and save your changes.
6. Enable and set up your Salesforce site, so you can send and receive payments notifications from your third-party gateway.
   1. Enter a label, name, and home page for your site.
   2. Set the site’s public access settings to Guest Access to the Payments API.
   3. Save your site details.

Configure Notification Settings on Your Third-Party Payment Gateway

The payment gateway uses a webhook to send notifications to your payment gateway adapter. A webhook is a combination of your site endpoint and the ID of the payment gateway provider. Create a webhook by providing a URL in the standard notification transport settings of your third-party payment gateway.

1. Use this URL for your site’s endpoint, replacing MyDomainName with your site's domain and URL. For example:
   https://MyDomainName.my.salesforce-sites.com/solutions/services/data/v65.0/commerce/payments/notify
2. Find the ID of your payment gateway provider, and append the ?provider=ID query parameter to the endpoint. For example, https://MyDomainName.my.salesforce-sites.com/solutions/services/data/v65.0/commerce/payments/notify?provider=0cJR00000004CEhMAM
3. Enter the webhook in your third-party payment gateway’s standard notification settings.

Configure Payment Gateway Provider and Payment Gateway

Add a payment gateway provider after you set up your merchant account, your adapter classes, and your Salesforce site. Then, add a payment gateway on the payment gateway provider.

1. From Setup, in the Quick Find box, enter Billing, and then select Step 7: Payment Configurations in the Guided Setup.
2. Expand the Configure Third-Party Payment Gateways step, click Configure Payment Gateways, and then click Configure.
   

   Note

   For Salesforce orgs that are created in Winter ’26, the Configure Payment Gateways button in Step 7: Payment Configurations of the Billing Guided Setup, which redirects users to the Payment Gateway Configuration tab, is available by default. For Salesforce orgs that are created before Winter ’26, the Payment Gateway Configuration tab isn’t available by default. To fix this issue, change the settings of the Payment Gateway Configuration tab to Default On.

3. Complete these fields to create a payment gateway provider.
   1. Enter a unique name and label for your payment gateway provider.
   2. Select the Apex adapter class from the dropdown list.
   3. Specify your required support for idempotency. For more details, see Idempotency Guidelines.
   4. Save the payment gateway provider details.
4. Complete these fields to add a payment gateway.
   1. Enter a unique name for your payment gateway.
   2. Select a payment gateway provider from the dropdown list.
   3. Select a named credential from the dropdown list.
   4. Mark the status of your payment gateway as Active.
   5. Save the payment gateway details.

   If you already have an existing payment gateway provider, select Step 7: Payment Configurations in the Guided Setup, expand the Configure Third-Party Payment Gateways step, and click Configure Payment Gateways. On the Payment Gateway Configuration page, click Payment Gateways, and then click New. The configuration steps are the same.

Add Multiple Payment Methods

Configure support for payment methods such as Automated Clearing House (ACH), Single Euro Payments Area (SEPA), Bankers’ Automated Clearing Services (BACS), and Bulk Electronic Clearing System (BECS) on your third-party payment gateway. You can process payments, issue refunds, and view these saved payment methods in the Saved Payment Methods tab of your billing profile.

• To add bank payment methods such as ACH, SEPA, BACS, and BECS, use the tokenizePaymentMethod API and set the bankType property in the bankPaymentMethod object to your chosen bank payment method.
• To add card payment methods such as credit card or debit card, use the tokenizePaymentMethod API and set the cardCategory property in the cardPaymentMethod object.