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 AbstractRestRequest

Fat Zebra Abstract REST Request

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

Test modes:

There are two test modes in the Paystream system - one is a sandbox environment and the other is a test mode flag.

The Sandbox Environment is an identical copy of the live environment which is 100% functional except for communicating with the banks.

The Test Mode Flag is used to switch the live environment into test mode. If test: true is sent with your request your transactions will be executed in the live environment, but not communicate with the bank backends. This mode is useful for testing changes to your live website.

Currently this class makes the assumption that if the testMode flag is set then the Sandbox Environment is being used.

Omnipay\Common\Message\AbstractRequest implements Omnipay\Common\Message\RequestInterface
Extended by Omnipay\Fatzebra\Message\AbstractRestRequest

Direct known subclasses

Omnipay\Fatzebra\Message\CreateCardRequest, Omnipay\Fatzebra\Message\CreateCustomerRequest, Omnipay\Fatzebra\Message\PurchaseRequest, Omnipay\Fatzebra\Message\RefundRequest, Omnipay\Fatzebra\Message\CreatePlanRequest, Omnipay\Fatzebra\Message\CreateSubscriptionRequest, Omnipay\Fatzebra\Message\DeleteCustomerRequest, Omnipay\Fatzebra\Message\FetchAllPlansRequest, Omnipay\Fatzebra\Message\FetchCustomerRequest, Omnipay\Fatzebra\Message\FetchPlanRequest, Omnipay\Fatzebra\Message\FetchSubscriptionRequest, Omnipay\Fatzebra\Message\FetchTransactionRequest
Abstract
Namespace: Omnipay\Fatzebra\Message
See: Omnipay\Fatzebra\FatzebraGateway
Link: http://www.paystream.com.au/developer-guides/
Located at Message/AbstractRestRequest.php
Methods summary
protected string
# getHttpMethod( )

Get HTTP Method.

Get HTTP Method.

This is nearly always POST but can be over-ridden in sub classes.

Returns

string
protected string
# getEndpoint( )

Get API endpoint URL

Get API endpoint URL

Returns

string
public string
# getUsername( )

Get the gateway username

Get the gateway username

Returns

string
public Omnipay\Fatzebra\Message\AbstractRestRequest
# setUsername( $value )

Set the gateway username

Set the gateway username

Returns

Omnipay\Fatzebra\Message\AbstractRestRequest
provides a fluent interface.
public ResponseInterface
# sendData( mixed $data )

Send the request with specified data

Send the request with specified data

Parameters

$data
The data to send

Returns

ResponseInterface
Methods inherited from Omnipay\Common\Message\AbstractRequest
__construct(), formatCurrency(), getAmount(), getAmountInteger(), getCancelUrl(), getCard(), getCardReference(), getClientIp(), getCurrency(), getCurrencyDecimalPlaces(), getCurrencyNumeric(), getDescription(), getIssuer(), getItems(), getNotifyUrl(), getParameter(), getParameters(), getPaymentMethod(), getResponse(), getReturnUrl(), getTestMode(), getToken(), getTransactionId(), getTransactionReference(), initialize(), send(), setAmount(), setCancelUrl(), setCard(), setCardReference(), setClientIp(), setCurrency(), setDescription(), setIssuer(), setItems(), setNotifyUrl(), setParameter(), setPaymentMethod(), setReturnUrl(), setTestMode(), setToken(), setTransactionId(), setTransactionReference(), toFloat(), validate()
Methods inherited from Omnipay\Common\Message\MessageInterface
getData()
Constants summary
string API_VERSION
# 'v1.0'
Properties summary
protected string $testEndpoint

Sandbox Endpoint URL

Sandbox Endpoint URL

# 'https://gateway.sandbox.fatzebra.com.au'
protected string $liveEndpoint

Live Endpoint URL

Live Endpoint URL

# 'https://gateway.fatzebra.com.au'
Properties inherited from Omnipay\Common\Message\AbstractRequest
$httpClient, $httpRequest, $negativeAmountAllowed, $parameters, $response, $zeroAmountAllowed
Omnipay Fat Zebra / Paystream Gateway Module API Documentation API documentation generated by ApiGen