Open Monograph Press  3.3.0
Omnipay\Common\Message\NotificationInterface Interface Reference
Inheritance diagram for Omnipay\Common\Message\NotificationInterface:
Omnipay\Common\Message\MessageInterface

Public Member Functions

 getMessage ()
 
 getMessage ()
 
 getTransactionReference ()
 
 getTransactionReference ()
 
 getTransactionStatus ()
 
 getTransactionStatus ()
 
- Public Member Functions inherited from Omnipay\Common\Message\MessageInterface
 getData ()
 
 getData ()
 

Data Fields

const STATUS_COMPLETED = 'completed'
 
const STATUS_FAILED = 'failed'
 
const STATUS_PENDING = 'pending'
 

Detailed Description

Member Function Documentation

◆ getMessage() [1/2]

Omnipay\Common\Message\NotificationInterface::getMessage ( )

Response Message

Returns
string A response message from the payment gateway

◆ getMessage() [2/2]

Omnipay\Common\Message\NotificationInterface::getMessage ( )

Response Message

Returns
string A response message from the payment gateway

◆ getTransactionReference() [1/2]

Omnipay\Common\Message\NotificationInterface::getTransactionReference ( )

Gateway Reference

Returns
string A reference provided by the gateway to represent this transaction

◆ getTransactionReference() [2/2]

Omnipay\Common\Message\NotificationInterface::getTransactionReference ( )

Gateway Reference

Returns
string A reference provided by the gateway to represent this transaction

◆ getTransactionStatus() [1/2]

Omnipay\Common\Message\NotificationInterface::getTransactionStatus ( )

Was the transaction successful?

Returns
string Transaction status, one of {
See also
STATUS_COMPLETED}, {
STATUS_PENDING}, or {
STATUS_FAILED}.

◆ getTransactionStatus() [2/2]

Omnipay\Common\Message\NotificationInterface::getTransactionStatus ( )

Was the transaction successful?

Returns
string Transaction status, one of NotificationInterface::STATUS_COMPLETED, NotificationInterface::STATUS_PENDING, or NotificationInterface::STATUS_FAILED.

Field Documentation

◆ STATUS_COMPLETED

const Omnipay\Common\Message\NotificationInterface::STATUS_COMPLETED = 'completed'

◆ STATUS_FAILED

const Omnipay\Common\Message\NotificationInterface::STATUS_FAILED = 'failed'

◆ STATUS_PENDING

const Omnipay\Common\Message\NotificationInterface::STATUS_PENDING = 'pending'

The documentation for this interface was generated from the following file: