craft\commerce
craft\commerce\adjusters
craft\commerce\base
craft\commerce\behaviors
craft\commerce\console
craft\commerce\console\controllers
craft\commerce\controllers
craft\commerce\db
craft\commerce\elements
craft\commerce\elements\actions
craft\commerce\elements\db
craft\commerce\elements\traits
craft\commerce\engines
craft\commerce\errors
craft\commerce\events
craft\commerce\exports
craft\commerce\fieldlayoutelements
craft\commerce\fields
craft\commerce\gateways
craft\commerce\gql\arguments\elements
craft\commerce\gql\interfaces\elements
craft\commerce\gql\queries
craft\commerce\gql\resolvers\elements
craft\commerce\gql\types
craft\commerce\gql\types\elements
craft\commerce\gql\types\generators
craft\commerce\gql\types\input
craft\commerce\helpers
craft\commerce\migrations
craft\commerce\models
craft\commerce\models\payments
craft\commerce\models\responses
craft\commerce\models\subscriptions
craft\commerce\plugin
craft\commerce\queue\jobs
craft\commerce\records
craft\commerce\services
craft\commerce\stats
craft\commerce\test\fixtures\elements
craft\commerce\test\mockclasses
craft\commerce\web\assets\chartjs
craft\commerce\web\assets\commercecp
craft\commerce\web\assets\commerceui
craft\commerce\web\assets\deepmerge
craft\commerce\web\assets\editproduct
craft\commerce\web\assets\orderswidget
craft\commerce\web\assets\productindex
craft\commerce\web\assets\statwidgets
craft\commerce\web\assets\variantmatrix
craft\commerce\web\panel
craft\commerce\web\twig
craft\commerce\widgets

RequestResponseInterface

Type: Interface
Namespace: craft\commerce\base
Implemented by: craft\commerce\models\responses\Dummy, craft\commerce\models\responses\Manual
Since: 2.0

This interface class functions that a Commerce Payment needs to implement.

View source (opens new window)

# Public Methods

Method	Description
getCode()	Returns the response code.
getData()	Returns the data.
getMessage()	Returns the gateway message.
getRedirectData()	Returns the redirect data provided.
getRedirectMethod()	Returns the redirect method to use, if any.
getRedirectUrl()	Returns the redirect URL to use, if any.
getTransactionReference()	Returns the transaction reference.
isProcessing()	Returns whether or not the payment is being processed by gateway.
isRedirect()	Returns whether or not the user needs to be redirected.
isSuccessful()	Returns whether or not the payment was successful.
redirect()	Perform the redirect.

# `getCode()`

Returns the response code.

View source (opens new window)

Returns

string (opens new window)

# `getData()`

Returns the data.

View source (opens new window)

Returns

mixed

# `getMessage()`

Returns the gateway message.

View source (opens new window)

Returns

string (opens new window)

# `getRedirectData()`

Returns the redirect data provided.

View source (opens new window)

Returns

array (opens new window)

# `getRedirectMethod()`

Returns the redirect method to use, if any.

View source (opens new window)

Returns

string (opens new window)

# `getRedirectUrl()`

Returns the redirect URL to use, if any.

View source (opens new window)

Returns

string (opens new window)

# `getTransactionReference()`

Returns the transaction reference.

View source (opens new window)

Returns

string (opens new window)

# `isProcessing()`

Returns whether or not the payment is being processed by gateway.

View source (opens new window)

Returns

boolean (opens new window)

# `isRedirect()`

Returns whether or not the user needs to be redirected.

View source (opens new window)

Returns

boolean (opens new window)

# `isSuccessful()`

Returns whether or not the payment was successful.

View source (opens new window)

Returns

boolean (opens new window)

# `redirect()`

Perform the redirect.

View source (opens new window)

Returns

mixed

← PurchasableInterface ShippingMethod →