1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: <?php
/**
* Fat Zebra REST Purchase Request
*/
namespace Omnipay\Fatzebra\Message;
/**
* Fat Zebra REST Purchase Request
*
* In order to create a purchase you must submit the following details:
*
* * Amount (numerical)
* * Reference (string - maximum 30 characters) -- this must be unique. More
* than one transaction using the same Reference value will raise an error.
* * Customer IP (RFC standard IP address)
*
* Either
*
* * Card Holder (string)
* * Card Number (string, numerical, 13 to 16 digits)
* * Card Expiry (string, mm/yyyy format)
* * CVV (numerical, 3 or 4 digits)
*
* Or
*
* * Card Token (String)
*
* Example:
*
* <code>
* // 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
* ));
*
* // Create a credit card object
* // This card can be used for testing.
* $card = new CreditCard(array(
* 'firstName' => 'Example',
* 'lastName' => 'Customer',
* 'number' => '4005550000000001',
* 'expiryMonth' => '01',
* 'expiryYear' => '2020',
* 'cvv' => '123',
* ));
*
* // Do a purchase transaction on the gateway
* $transaction = $gateway->purchase(array(
* 'amount' => '10.00',
* 'transactionId' => 'TestPurchaseTransaction123456',
* 'clientIp' => $_SERVER['REMOTE_ADDR'],
* 'card' => $card,
* ));
* $response = $transaction->send();
* if ($response->isSuccessful()) {
* echo "Purchase transaction was successful!\n";
* $sale_id = $response->getTransactionReference();
* echo "Transaction reference = " . $sale_id . "\n";
* }
* </code>
*
* @link http://www.paystream.com.au/developer-guides/
* @see Omnipay\Fatzebra\FatzebraGateway
*/
class PurchaseRequest extends AbstractRestRequest
{
public function getData()
{
// An amount parameter is required. All amounts are in
// Australian dollars.
$this->validate('amount', 'transactionId');
$data = array(
'amount' => $this->getAmount(),
'reference' => $this->getTransactionId(),
'customer_ip' => $this->getClientIp(),
);
// A card token can be provided if the card has been stored
// in the gateway.
if ($this->getCardReference()) {
$data['card_token'] = $this->getCardReference();
// If no card token is provided then there must be a valid
// card presented.
} else {
$this->validate('card');
$card = $this->getCard();
$card->validate();
$data['card_holder'] = $card->getName();
$data['card_number'] = $card->getNumber();
$data['card_expiry'] = $card->getExpiryDate('m/Y');
$data['cvv'] = $card->getCvv();
}
return $data;
}
/**
* Get transaction endpoint.
*
* Purchases are created using the /purchases resource.
*
* @return string
*/
protected function getEndpoint()
{
return parent::getEndpoint() . '/purchases';
}
}