Public Member Functions | |
| getCode () | |
| getCode () | |
| getMessage () | |
| getMessage () | |
| getRequest () | |
| getRequest () | |
| getTransactionReference () | |
| getTransactionReference () | |
| isCancelled () | |
| isCancelled () | |
| isRedirect () | |
| isRedirect () | |
| isSuccessful () | |
| isSuccessful () | |
 Public Member Functions inherited from Omnipay\Common\Message\MessageInterface | |
| getData () | |
| getData () | |
Detailed Description
Response Interface
This interface class defines the standard functions that any Omnipay response interface needs to be able to provide. It is an extension of MessageInterface.
- See also
- MessageInterface
Response Interface
This interface class defines the standard functions that any Omnipay response interface needs to be able to provide. It is an extension of MessageInterface.
Definition at line 16 of file lib/vendor/omnipay/common/src/Omnipay/Common/Message/ResponseInterface.php.
Member Function Documentation
◆ getCode() [1/2]
| Omnipay\Common\Message\ResponseInterface::getCode | ( | ) |
Response code
- Returns
- null|string A response code from the payment gateway
Implemented in Omnipay\Common\Message\AbstractResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\PayPal\Message\RestResponse, and Omnipay\PayPal\Message\RestResponse.
◆ getCode() [2/2]
| Omnipay\Common\Message\ResponseInterface::getCode | ( | ) |
Response code
- Returns
- null|string A response code from the payment gateway
Implemented in Omnipay\Common\Message\AbstractResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\PayPal\Message\RestResponse, and Omnipay\PayPal\Message\RestResponse.
◆ getMessage() [1/2]
| Omnipay\Common\Message\ResponseInterface::getMessage | ( | ) |
Response Message
- Returns
- null|string A response message from the payment gateway
Implemented in Omnipay\Common\Message\AbstractResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\Response, and Omnipay\PayPal\Message\Response.
◆ getMessage() [2/2]
| Omnipay\Common\Message\ResponseInterface::getMessage | ( | ) |
Response Message
- Returns
- null|string A response message from the payment gateway
Implemented in Omnipay\Common\Message\AbstractResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\Response, and Omnipay\PayPal\Message\Response.
◆ getRequest() [1/2]
| Omnipay\Common\Message\ResponseInterface::getRequest | ( | ) |
Get the original request which generated this response
- Returns
- RequestInterface
Implemented in Omnipay\Common\Message\AbstractResponse, and Omnipay\Common\Message\AbstractResponse.
◆ getRequest() [2/2]
| Omnipay\Common\Message\ResponseInterface::getRequest | ( | ) |
Get the original request which generated this response
- Returns
- RequestInterface
Implemented in Omnipay\Common\Message\AbstractResponse, and Omnipay\Common\Message\AbstractResponse.
◆ getTransactionReference() [1/2]
| Omnipay\Common\Message\ResponseInterface::getTransactionReference | ( | ) |
Gateway Reference
- Returns
- null|string A reference provided by the gateway to represent this transaction
Implemented in Omnipay\Common\Message\AbstractResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\RestResponse, and Omnipay\PayPal\Message\RestResponse.
◆ getTransactionReference() [2/2]
| Omnipay\Common\Message\ResponseInterface::getTransactionReference | ( | ) |
Gateway Reference
- Returns
- null|string A reference provided by the gateway to represent this transaction
Implemented in Omnipay\Common\Message\AbstractResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\RestResponse, and Omnipay\PayPal\Message\RestResponse.
◆ isCancelled() [1/2]
| Omnipay\Common\Message\ResponseInterface::isCancelled | ( | ) |
Is the transaction cancelled by the user?
- Returns
- boolean
Implemented in Omnipay\Common\Message\AbstractResponse, and Omnipay\Common\Message\AbstractResponse.
◆ isCancelled() [2/2]
| Omnipay\Common\Message\ResponseInterface::isCancelled | ( | ) |
Is the transaction cancelled by the user?
- Returns
- boolean
Implemented in Omnipay\Common\Message\AbstractResponse, and Omnipay\Common\Message\AbstractResponse.
◆ isRedirect() [1/2]
| Omnipay\Common\Message\ResponseInterface::isRedirect | ( | ) |
Does the response require a redirect?
- Returns
- boolean
Implemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, and Omnipay\PayPal\Message\RestAuthorizeResponse.
◆ isRedirect() [2/2]
| Omnipay\Common\Message\ResponseInterface::isRedirect | ( | ) |
Does the response require a redirect?
- Returns
- boolean
Implemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\Common\Message\AbstractResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, and Omnipay\PayPal\Message\RestAuthorizeResponse.
◆ isSuccessful() [1/2]
| Omnipay\Common\Message\ResponseInterface::isSuccessful | ( | ) |
Is the response successful?
- Returns
- boolean
Implemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, and Omnipay\PayPal\Message\RestAuthorizeResponse.
◆ isSuccessful() [2/2]
| Omnipay\Common\Message\ResponseInterface::isSuccessful | ( | ) |
Is the response successful?
- Returns
- boolean
Implemented in Omnipay\Common\Message\AbstractResponseTest_MockRedirectResponse, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\Response, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\RestResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, Omnipay\PayPal\Message\RestAuthorizeResponse, Omnipay\PayPal\Message\ExpressAuthorizeResponse, Omnipay\PayPal\Message\ExpressCompletePurchaseResponse, and Omnipay\PayPal\Message\RestAuthorizeResponse.
The documentation for this interface was generated from the following file:
