Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Action Links Resources
Activity Reminders Resources
Application for Program
Batch Resource
Bot Version Activation Resource
Briefcase Priming Records Resource
Call Coaching Resources
Clean Resources
CMS Managed Content Resources
Commerce B2B and D2C Resources
Commerce Einstein Webstore Resources
Connect Resources
Content Taxonomy Resources
Content Workspace Permissions Resource
Conversation Application Definition Resource
Conversations Resources
Custom Domain Resources
Customer Asset Lifecycle Management Resources
Data Cloud Resources
Data Integration Resources
Duplicate Resources
Einstein Prediction Service Resources
Prompt Templates Resources
Einstein Recommendation Resources
Email Merge Field Services Resource
Employee Profiles Resources
Enhanced CMS Workspaces Resources
Environment Hub Resources
Experience Cloud CMS Content Search Resource
Experience Cloud Microsites Resources
Experience Cloud Sites Knowledge Resources
Experience Cloud Sites Moderation Resources
Experience Cloud Sites Resources
Experience Model Resources
External Email Services Resource
Field Service Recordset Filter Criteria Resource
Field Service Shifts from Pattern Resource
Files Connect Repository Resources
Files Resources
Folders Resources
Forecasts Resources
Knowledge Article View Stat Resource
List Share Resources
Managed Topics Resources
Messaging Channels Resource
Microbatching Resources
Motifs Resources
Named Credentials Resources
Navigation Menu Items Resource
Network Data Category Resources
Next Best Action Resources
Notification Settings Resources
Notifications Resources
OAuth Credentials Resources
OAuth Usage Resources
Orchestration Resources
Pardot Business Unit Context Resource
Personalization Resources
Private Connect Resources
Push Notifications Resource
Quick Text Resource
Quip Related Records Resource
Salesforce Omnichannel Inventory Resources
Salesforce Order Management Resources
Salesforce Payments Resources
Payment Authorization
Payment Authorization, Capture
Payment Authorization, Reverse
Post Authorization
Payment, Create Refund
Payment, Sale
Payment Method Tokenization
Apple Pay Domains
Apple Pay Domain, Delete
Payment Intents
Payment Method Sets
Payment Activity Timeline
Saved Payment Method
Saved Payment Methods
Save Payment Method Token
Payment Link, Get Details
Payment Link, Create Order
Salesforce Scheduler Resources
Search Resources
Share Captured Activity Resource
Social Engagement Resources
Social Engagement Setup Resources
Surveys Resources
Topics Resources
Topics on Records Resource
User Files Resources
Chatter Resources
Request Bodies
Response Bodies
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Salesforce Payments Resources

Information about Salesforce Payments, including content, rendered version, and sharing.

For the most updated Payments API documentation, see the Salesforce Payments APIs and the Salesforce Commerce Payments APIs in the B2B Commerce and D2C Commerce Developer Guide.

Note

To access Salesforce Payments resources whose endpoints begin /commerce/payments, your org must have one or more of these licenses:

  • Salesforce Payments
  • Salesforce Order Management
  • B2B Commerce, or D2C Commerce

Available resources are:

Resource Description
/commerce/payments/authorizations Authorizes a payment.
/commerce/payments/postAuths Confirm that the merchant is ready to capture payment of an existing pre-authorized transaction.
/commerce/payments/authorizations/authorizationId​/captures Captures a payment authorization.
/commerce/payments/authorizations/authorizationId​/reversals Reverses a payment authorization.
/commerce/payments/payments/paymentId​/refunds Creates a refund for a payment.
/commerce/payments/payment-methods Tokenizes a payment method.
/commerce/payments/sales Executes a payment without a previous authorization.

To access Salesforce Payments resources whose endpoints begin /payments, you need these licenses and permissions

  • Salesforce Payments Internal license
  • Salesforce Payments External User license
  • Payments Administrator permissions
  • Authenticated Payer permissions
  • Access to public API sites for guest users who want to make payments

Available resources:

resource description
/payments/merchant-accounts/merchantAccountId​/apple-pay-domains Registers an Apple Pay domain.
/payments/merchant-accounts/merchantAccountId/apple-pay-domains/applePayDomainId Deletes an Apple Pay domain.
/payments/merchant-accounts/merchantAccountId​/saved-payment-methods Creates a saved payment method or retrieve all saved payment methods.
/payments/merchant-accounts/merchantAccountId​/saved-payment-methods/savedPaymentMethodId Deletes, creates, or updates a saved payment method associated with a given merchant account.
/payments/merchant-accounts/merchantAccountId/saved-payment-methods/saveToken Creates the saved payment method details obtained from the payment gateway. Updates the saved payment method details obtained from the payment gateway. Delete the saved payment method details record.
/payments/payment-method-sets​/paymentMethodSetId Retrieves payment method sets.
/payments/payment-intents Initiates payments.
/payments/payment-intents/paymentIntentId/timeline Retrieves the payment activity timeline for a payment intent.
/payments/link-to-order/paymentLinkId Create an order for a payment link.
/payments/payment-link-configs/paymentLinkId Retrieve the payment link details.