Newer Version Available

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

Payments Methods

Namespace

ConnectApi

Payments Methods

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

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.