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 the payment is being processed by gateway. |
| isRedirect() | Returns whether the user needs to be redirected. |
| isSuccessful() | Returns whether the payment was successful. |
| redirect() | Perform the redirect. |
# getCode()
Returns the response code.
View source (opens new window)
# getData()
Returns the data.
View source (opens new window)
Returns
mixed
# getMessage()
Returns the gateway message.
View source (opens new window)
# getRedirectData()
Returns the redirect data provided.
View source (opens new window)
# getRedirectMethod()
Returns the redirect method to use, if any.
View source (opens new window)
# getRedirectUrl()
Returns the redirect URL to use, if any.
View source (opens new window)
# getTransactionReference()
Returns the transaction reference.
View source (opens new window)
# isProcessing()
Returns whether the payment is being processed by gateway.
View source (opens new window)
# isRedirect()
Returns whether the user needs to be redirected.
View source (opens new window)
# isSuccessful()
Returns whether the payment was successful.
View source (opens new window)
# redirect()
Perform the redirect.