Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
Datacloud Class
EmailMergeFieldService Class
EmployeeProfiles Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
Knowledge Class
ManagedContent Class
ManagedTopics Class
Mentions Class
Missions Class
NextBestAction Class
OmnichannelInventoryService Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
Payments Methods
Payments Methods
Personalization Class
QuestionAndAnswers Class
Recommendations Class
Records Class
Routing Class
SalesforceInbox Class
SmartDataDiscovery Class
SocialEngagement Class
Survey Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
Functions Namespace (Beta)
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

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

Payments Methods

Authorize a payment, capture an authorized payment, and refund an authorized payment.

Namespace

ConnectApi

Payments Methods

The following are methods for Payments. All methods are static.

authorize(authorizePayment)

Authorize a payment.

API Version

51.0

Requires Chatter

No

Signature

global static ConnectApi.AuthorizationResponse authorize(ConnectApi.AuthorizationRequest authorizePayment)

Parameters

authorizePayment
Type: ConnectApi.AuthorizationRequest
Represents a payment authorization.

Return Value

Type: ConnectApi.AuthorizationResponse

reverseAuthorization(AuthReversalInput, authorizationId)

Reverses a payment authorization.

API Version

51.0

Requires Chatter

No

Signature

global static ConnectApi.AuthorizationReversalResponse reverseAuthorization(ConnectApi.AuthorizationReversalRequest AuthReversalInput, String authorizationId)

Parameters

AuthReversalInput
Type: ConnectApi.AuthorizationReversalRequest
Input information for the payment authorization reversal.
authorizationId
Type: String
The ID of the payment authorization to be reversed.

Return Value

Type: ConnectApi.AuthorizationReversalResponse

capture(AuthCaptureInput, authorizationId)

Capture an authorized payment.

API Version

To access Payments methods, you need the following permissions.
  • Salesforce Order Management License
  • PaymentsAPIUser user permission. This permission is available with the Salesforce Order Management License. Your Salesforce admin assigns it to your profile.

50.0

Requires Chatter

No

Signature

global static ConnectApi.CaptureResponse capture(ConnectApi.CaptureRequest AuthCaptureInput, String authorizationId)

Parameters

AuthCaptureInput
Type: ConnectApi.CaptureRequest
A ConnectApi.CaptureRequest object with information about the payment capture.
authorizationId
Type: String
ID of the payment authorization. Required.

Return Value

Type: ConnectApi.CaptureResponse

refund(ReferencedRefundInput, paymentId)

Refund an authorized payment.

API Version

To access Payments methods, you need the following permissions.
  • Salesforce Order Management License
  • PaymentsAPIUser user permission. This permission is available with the Salesforce Order Management License. Your Salesforce admin assigns it to your profile.

50.0

Requires Chatter

No

Signature

global static ConnectApi.ReferencedRefundResponse refund(ConnectApi.ReferencedRefundRequest ReferencedRefundInput, String paymentId)

Parameters

ReferencedRefundInput
Type: ConnectApi.ReferencedRefundRequest
A ConnectApi.ReferencedRefundRequest object with information about the refund.
paymentId
Type: String
ID of the payment to be refunded. Required.

Return Value

Type: ConnectApi.ReferencedRefundResponse