Overview

Namespaces

  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
    • Tests
      • Batch
      • Cache
      • Common
        • Cache
        • Exception
      • Http
        • Curl
        • Exception
        • Message
          • Header
      • Inflection
      • Iterator
      • Log
      • Message
      • Mock
      • Parser
        • Cookie
        • Message
      • Parsers
        • UriTemplate
      • Plugin
        • Async
        • Backoff
        • Cache
        • Cookie
          • CookieJar
        • CurlAuth
        • ErrorResponse
        • History
        • Log
        • Md5
        • Mock
        • Oauth
        • Redirect
      • Service
        • Builder
        • Command
          • LocationVisitor
            • Request
            • Response
        • Description
        • Exception
        • Mock
          • Command
            • Sub
          • Model
        • Resource
      • Stream
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • VivaPayments
      • Message
  • PHP

Classes

  • AbstractRequest
  • AbstractResponse

Interfaces

  • FetchIssuersResponseInterface
  • FetchPaymentMethodsResponseInterface
  • MessageInterface
  • NotificationInterface
  • RedirectResponseInterface
  • RequestInterface
  • ResponseInterface
  • Overview
  • Namespace
  • Class
  • Tree

Interface ResponseInterface

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.

Omnipay\Common\Message\ResponseInterface implements Omnipay\Common\Message\MessageInterface

Direct known implementers

Omnipay\Common\Message\AbstractResponse, Omnipay\Common\Message\FetchIssuersResponseInterface, Omnipay\Common\Message\FetchPaymentMethodsResponseInterface, Omnipay\Common\Message\RedirectResponseInterface

Indirect known implementers

Omnipay\Dummy\Message\Response, Omnipay\VivaPayments\Message\RedirectResponse, Omnipay\VivaPayments\Message\RestResponse
Namespace: Omnipay\Common\Message
See: Omnipay\Common\Message\MessageInterface
Located at Common/Message/ResponseInterface.php
Methods summary
public Omnipay\Common\Message\RequestInterface
# getRequest( )

Get the original request which generated this response

Get the original request which generated this response

Returns

Omnipay\Common\Message\RequestInterface
public boolean
# isSuccessful( )

Is the response successful?

Is the response successful?

Returns

boolean
public boolean
# isRedirect( )

Does the response require a redirect?

Does the response require a redirect?

Returns

boolean
public boolean
# isCancelled( )

Is the transaction cancelled by the user?

Is the transaction cancelled by the user?

Returns

boolean
public null|string
# getMessage( )

Response Message

Response Message

Returns

null|string
A response message from the payment gateway
public null|string
# getCode( )

Response code

Response code

Returns

null|string
A response code from the payment gateway
public null|string
# getTransactionReference( )

Gateway Reference

Gateway Reference

Returns

null|string
A reference provided by the gateway to represent this transaction
Methods inherited from Omnipay\Common\Message\MessageInterface
getData()
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen