Class CreatePlanRequest

Fat Zebra REST Create Plan Request

In order to create a new recurring purchase plan you must submit the following details:

Name (string)
Reference (your internal reference -- this will be used to look up the plan). This must be unique -- plans with duplicate references will cause an error.
Description
Amount (numerical)

Example:

// Create a gateway for the Fat Zebra REST Gateway
  // (routes to GatewayFactory::create)
  $gateway = Omnipay::create('FatzebraGateway');

  // Initialise the gateway
  $gateway->initialize(array(
      'username' => 'TEST',
      'token'    => 'TEST',
      'testMode' => true, // Or false when you are ready for live transactions
  ));

  // Do a create plan transaction on the gateway
  $transaction = $gateway->CreatePlan(array(
      'name'                     => 'Test Plan',
      'transactionReference'     => 'TestPlan',
      'description'              => 'A plan created for testing',
      'amount'                   => '10.00',
  ));
  $response = $transaction->send();
  if ($response->isSuccessful()) {
      echo "Create Plan transaction was successful!\n";
      $plan_id = $response->getTransactionReference();
      echo "Plan reference = " . $plan_id . "\n";
  }

Omnipay\Common\Message\AbstractRequest implements Omnipay\Common\Message\RequestInterface

Omnipay\Fatzebra\Message\AbstractRestRequest

Omnipay\Fatzebra\Message\CreatePlanRequest

Namespace: Omnipay\Fatzebra\Message
See: Omnipay\Fatzebra\FatzebraGateway
Link: http://www.paystream.com.au/developer-guides/
Located at Message/CreatePlanRequest.php

Methods summary
`public string`	# `getName( )` Get the plan name Get the plan name Returns string
`public Omnipay\Fatzebra\Message\CreatePlanRequest`	# `setName( $value )` Set the plan name Set the plan name Returns `Omnipay\Fatzebra\Message\CreatePlanRequest` provides a fluent interface.
`public mixed`	# `getData( )` Get the raw data array for this message. The format of this varies from gateway to gateway, but will usually be either an associative array, or a SimpleXMLElement. Get the raw data array for this message. The format of this varies from gateway to gateway, but will usually be either an associative array, or a SimpleXMLElement. Returns mixed
`protected string`	# `getEndpoint( )` Get transaction endpoint. Get transaction endpoint. Create Plans are created using the /purchases resource. Returns string Overrides `Omnipay\Fatzebra\Message\AbstractRestRequest::getEndpoint()`

Methods inherited from Omnipay\Fatzebra\Message\AbstractRestRequest
`getHttpMethod(), getUsername(), sendData(), setUsername()`

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()

Constants inherited from Omnipay\Fatzebra\Message\AbstractRestRequest
`API_VERSION`

Properties inherited from Omnipay\Fatzebra\Message\AbstractRestRequest
`$liveEndpoint, $testEndpoint`

Properties inherited from Omnipay\Common\Message\AbstractRequest
`$httpClient, $httpRequest, $negativeAmountAllowed, $parameters, $response, $zeroAmountAllowed`

Namespaces

Classes

Class CreatePlanRequest

Returns

Returns

Returns

Returns

Overrides