library sdk

agile-pay/sdk

Code climate

Install

$ composer require agile-pay/sdk

Usage

$agilePay = new \AgilePay\Sdk\AgilePay([
    'api_key' => '',
    'api_secret' => ''
]);

Gateways

To create a new gateway :

$gateway = $agilePay->gateway()->create('stripe', [
    'secret_key' => ''
]);

The response will contain a gateway reference which is used to perform transactions against the gateway, _(*1)

$gateway->reference;

Payment methods

To create a new payment method type of gateway token:

In this case the payment method will be retained with the provided gateway, please check the availability of transaction store in the gateways, _(*2)

Gateways list -> http://docs.agilepay.io/#!/gateway, _(*3)

Gateway token -> http://docs.agilepay.io/#!/payment-method-create-gateway-token, _(*4)

$paymentMethod = $agilePay->paymentMethod()->createGatewayToken($gateway->reference, [
    'number' => '',
    'holder_name' => '',
    'cvv' => '',
    'expiry_month' => '', //mm
    'expiry_year' => '',  //yy
]);

The response will contain a payment method token which is used to perform transactions against the payment method, _(*5)

$paymentMethod->token;

Transactions

Auth (Charge a credit card with a payment method type of gateway token):

$transaction = $agilePay->transaction()
                ->setPaymentMethod($paymentMethod->token;)
                ->auth(500, 'eur'); //Charging 5.00 euros

The response will contain a reference which can be used for second steps transactions such as void, capture and refund, _(*6)

$transaction->reference;

Void (Cancel an authorized transaction):

$response = $agilePay->transaction($transaction->reference)->void();

Capture (Settle an authorized transaction):

$response = $agilePay->transaction($transaction->reference)->capture();

Credit (Refund a settled transaction):

$response = $agilePay->transaction($transaction->reference)->credit();