| Server IP : 66.29.137.217 / Your IP : 18.217.65.73 Web Server : LiteSpeed System : Linux premium294.web-hosting.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : gltevjme ( 1095) PHP Version : 7.0.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/gltevjme/ideyshare.name.ng/app/libraries/vendor/omnipay/pin/src/Message/ |
Upload File : |
<?php
/**
* Pin Authorize Request
*/
namespace Omnipay\Pin\Message;
/**
* Pin Authorize Request
*
* The charges API allows you to create new credit card charges, and to retrieve
* details of previous charges.
*
* This message creates a new charge and returns its details. This may be a
* long-running request.
*
* Gateway Parameters
*
* * email Email address of the customer. Obtained from the card data.
* * description Description of the item purchased (e.g. "500g of single origin beans").
* * amount Amount to charge in the currency’s base unit (e.g. cents
* for AUD, yen for JPY). There is a minimum charge amount for each
* currency; refer to the documentation on supported currencies.
* * ip_address IP address of the person submitting the payment.
* Obtained from getClientIp.
* * Optional currency The three-character ISO 4217 currency code of one
* of our supported currencies, e.g. AUD or USD. Default value is "AUD".
* * Optional capture Whether or not to immediately capture the charge
* ("true" or "false"). If capture is false an authorisation is created.
* Later you can capture. Authorised charges automatically expire after
* 5 days. Default value is "true".
*
* and one of the following:
*
* * card The full details of the credit card to be charged (CreditCard object)
* * card_token Token of the card to be charged, as returned from the card
* tokens API or customer API.
* * customer_token Token of the customer to be charged, as returned
* from the customers API.
*
* ### Example
*
* <code>
* // Create a gateway for the Pin REST Gateway
* // (routes to GatewayFactory::create)
* $gateway = Omnipay::create('PinGateway');
*
* // Initialise the gateway
* $gateway->initialize(array(
* 'secretKey' => 'TEST',
* 'testMode' => true, // Or false when you are ready for live transactions
* ));
*
* // Create a credit card object
* // This card can be used for testing.
* // See https://pin.net.au/docs/api/test-cards for a list of card
* // numbers that can be used for testing.
* $card = new CreditCard(array(
* 'firstName' => 'Example',
* 'lastName' => 'Customer',
* 'number' => '4200000000000000',
* 'expiryMonth' => '01',
* 'expiryYear' => '2020',
* 'cvv' => '123',
* 'email' => 'customer@example.com',
* 'billingAddress1' => '1 Scrubby Creek Road',
* 'billingCountry' => 'AU',
* 'billingCity' => 'Scrubby Creek',
* 'billingPostcode' => '4999',
* 'billingState' => 'QLD',
* ));
*
* // Do an authorize transaction on the gateway
* $transaction = $gateway->authorize(array(
* 'description' => 'Your order for widgets',
* 'amount' => '10.00',
* 'currency' => 'AUD',
* 'clientIp' => $_SERVER['REMOTE_ADDR'],
* 'card' => $card,
* ));
* $response = $transaction->send();
* if ($response->isSuccessful()) {
* echo "Authorize transaction was successful!\n";
* $sale_id = $response->getTransactionReference();
* echo "Transaction reference = " . $sale_id . "\n";
* }
* </code>
*
* @see \Omnipay\Pin\Gateway
* @link https://pin.net.au/docs/api/charges
*/
class AuthorizeRequest extends PurchaseRequest
{
/**
* Get the Capture flag.
*
* Returns the capture parameter, which states whether the charge is
* just an authorisation or it is captured instantly. By default all
* charges are captured. Please note that the return has to be a string
* and not a boolean or Pin's API will disregard it and consider it set
* to 'true'
*
* By default for authorize transactions we return "false".
*
* @return string
*/
public function getCapture()
{
$capture = $this->getParameter('capture');
// By default with Pin a transaction is captured.
return $capture === true ? 'true' : 'false';
}
}