Newer Version Available

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

ReferencedRefundRequest

Access information about the referenced refund requests. Extends the RefundRequest class.

Namespace

CommercePayments

Example

1global commercepayments.GatewayResponse processRequest(commercepayments.PaymentGatewayContext gatewayContext) {
2    commercepayments.RequestType requestType = gatewayContext.getPaymentRequestType();
3    if (requestType == commercepayments.RequestType.ReferencedRefund) {
4        commercepayments.*ReferencedRefundRequest* refundRequest = (commercepayments.*ReferencedRefundRequest*) gatewayContext.getPaymentRequest();
5    }
6}

ReferencedRefundRequest Constructors

The following are constructors for ReferencedRefundRequest.

ReferencedRefundRequest(amount, paymentId)

This constructor is intended for test usage and throws an exception if used outside of the Apex test context.

Parameters

amount
Type: Double
The amount to be debited or captured.
paymentId
Type: String
The payment record.

ReferencedRefundRequest Properties

The following are properties for ReferencedRefundRequest.

PaymentId

References a payment object.

Property Value

Type: String

accountId

References an account.

Property Value

Type: String

amount

References an amount.

Property Value

Type: Double

ReferencedRefundRequest Methods

The following are methods for ReferencedRefundRequest.