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
    • Fatzebra
      • Message
  • PHP

Classes

  • AbstractRestRequest
  • CreateCardRequest
  • CreateCustomerRequest
  • CreatePlanRequest
  • CreateSubscriptionRequest
  • DeleteCustomerRequest
  • FetchAllPlansRequest
  • FetchCustomerRequest
  • FetchPlanRequest
  • FetchSubscriptionRequest
  • FetchTransactionRequest
  • PurchaseRequest
  • RefundRequest
  • RestResponse
  • Overview
  • Namespace
  • Class
  • Tree

Class RestResponse

Fat Zebra REST Response

This is the response class for all Fat Zebra REST requests.

Omnipay\Common\Message\AbstractResponse implements Omnipay\Common\Message\ResponseInterface
Extended by Omnipay\Fatzebra\Message\RestResponse
Namespace: Omnipay\Fatzebra\Message
See: Omnipay\Fatzebra\FatzebraGateway
Located at Message/RestResponse.php
Methods summary
public
# __construct( Omnipay\Common\Message\RequestInterface $request, mixed $data, $statusCode = 200 )

Constructor

Constructor

Parameters

$request
the initiating request.
$data
$statusCode

Overrides

Omnipay\Common\Message\AbstractResponse::__construct()
public boolean
# isSuccessful( )

Is the response successful?

Is the response successful?

Returns

boolean
public null|string
# getTransactionReference( )

Gateway Reference

Gateway Reference

Returns

null|string
A reference provided by the gateway to represent this transaction

Overrides

Omnipay\Common\Message\AbstractResponse::getTransactionReference()
public string
# getCardReference( )

Get Card Reference

Get Card Reference

This is used after createCard or createCustomer to get the credit card token to be used in future transactions.

Returns

string
public string
# getCustomerReference( )

Get Customer Reference

Get Customer Reference

This is used after createCustomer to get the customer token to be used in future transactions.

Returns

string
public string
# getPlanReference( )

Get Plan Reference

Get Plan Reference

This is used after createPlan to get the plan token to be used in future transactions.

Returns

string
public string
# getSubscriptionReference( )

Get Subscription Reference

Get Subscription Reference

This is used after createSubscription to get the subscription token to be used in future transactions.

Returns

string
public null|string
# getMessage( )

Response Message

Response Message

Returns

null|string
A response message from the payment gateway

Overrides

Omnipay\Common\Message\AbstractResponse::getMessage()
public null|string
# getCode( )

Response code

Response code

Returns

null|string
A response code from the payment gateway

Overrides

Omnipay\Common\Message\AbstractResponse::getCode()
Methods inherited from Omnipay\Common\Message\AbstractResponse
getData(), getRedirectResponse(), getRequest(), getTransactionId(), isCancelled(), isPending(), isRedirect(), isTransparentRedirect(), redirect()
Properties summary
protected $statusCode
#
Properties inherited from Omnipay\Common\Message\AbstractResponse
$data, $request
Omnipay Fat Zebra / Paystream Gateway Module API Documentation API documentation generated by ApiGen