README

Language:: EN || ES

Installation

Install via composer (not hosted in packagist yet)

composer require shieldgate/sdk

Usage

<?php

require 'vendor/autoload.php';

use Payment\Payment;

// First setup your credentials provided by ShieldGate
$applicationCode = "SOME_APP_CODE";
$applicationKey = "SOME_APP_KEY";

Payment::init($applicationCode, $applicationKey);

Once time are set your credentials, you can use available resources.

Resources availables:

Card

Available methods: getList, delete

Charge

Available methods: create, authorize, capture, verify, refund

Cash

Available methods: generateOrder

Card

See full documentation of these features here.

List

<?php

use Payment\Payment;
use Payment\Exceptions\PaymentErrorException;

Payment::init($applicationCode, $aplicationKey);

$card = Payment::card();

// Success response
$userId = "1";
$listOfUserCards = $card->getList($userId);

$totalSizeOfCardList = $listOfUserCards->result_size;
$listCards = $listOfUserCards->cards;

// Get all data of response
$response = $listOfUserCards->getData();

// Catch fail response
try {
	$listOfUserCards = $card->getList("someUID");
} catch (PaymentErrorException $error) {
	// Details of exception
	echo $error->getMessage();
	// You can see the logs for complete information
}

Charges

See full documentation of these features here.

Create new charge

See full documentation about this here

<?php

use Payment\Payment;
use Payment\Exceptions\PaymentErrorException;

// Card token
$cardToken = "myAwesomeTokenCard";

$charge = Payment::charge();

$userDetails = [
    'id' => "1", // Field required
    'email' => "dev@shieldgate.mx" // Field required
];

$orderDetails = [
    'amount' => 100.00, // Field required
    'description' => "XXXXXX", // Field required
    'dev_reference' => "XXXXXX", // Field required
    'vat' => 0.00 // Field required 
];

try {
    $created = $charge->create($cardToken, $orderDetails, $userDetails);
} catch (PaymentErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from gateway service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get transaction status
$status = $created->transaction->status;
// Get transaction ID
$transactionId = $created->transaction->id;
// Get authorization code
$authCode = $created->transaction->authorization_code;

Authorize charge

See the full documentation here

<?php

use Payment\Payment;
use Payment\Exceptions\PaymentErrorException;

// Card token
$cardToken = "myAwesomeTokenCard";

$charge = Payment::charge();

$userDetails = [
    'id' => "1", // Field required
    'email' => "dev@shieldgate.mx" // Field required
];

$orderDetails = [
    'amount' => 100.00, // Field required
    'description' => "XXXXXX", // Field required
    'dev_reference' => "XXXXXX", // Field required
    'vat' => 0.00 // Field required 
];

try {
    $authorization = $charge->authorize($cardToken, $orderDetails, $userDetails);
} catch (PaymentErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from gateway service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get transaction status
$status = $authorization->transaction->status;
// Get transaction ID
$transactionId = $authorization->transaction->id;
// Get authorization code
$authCode = $authorization->transaction->authorization_code;

Capture

See the full documentation here

Need make a authorization process

<?php

use Payment\Payment;
use Payment\Exceptions\PaymentErrorException;

$charge = Payment::charge();

$authorization = $charge->authorize($cardToken, $orderDetails, $userDetails);
$transactionId = $authorization->transaction->id;

try {
    $capture = $charge->capture($transactionId);
} catch (PaymentErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from gwateway service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get transaction status
$status = $capture->transaction->status;

// Make a capture with different amount
$newAmountForCapture = 1000.46;
$capture = $charge->capture($transactionId, $newAmountForCapture);

Refund

See the full documentation here

Need make a create process

<?php

use Payment\Payment;
use Payment\Exceptions\PaymentErrorException;

$charge = Payment::charge();

$created = $charge->create($cardToken, $orderDetails, $userDetails);
$transactionId = $created->transaction->id;

try {
    $refund = $charge->refund($transactionId);
} catch (PaymentErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from gateway service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get status of refund
$status = $refund->status;
$detail = $refund->detail;

// Make a partial refund
$partialAmountToRefund = 10;
$refund = $charge->refund($transactionId, $partialAmountToRefund);

Cash

Generate order

See the all available options in here

<?php

use Payment\Payment;
use Payment\Exceptions\PaymentErrorException;

$cash = Payment::cash();

$carrierDetails = [
    'id' => 'oxxo', // Field required
    'extra_params' => [ // Depends of carrier, for oxxo is required
        'user' => [ // For oxxo is required
            'name' => "Juan",
            'last_name' => "Perez"
        ]
    ]
];

$userDetails = [
   'id' => "1", // Field required
   'email' => "randm@mail.com" // Field required
];

$orderDetails = [
    'dev_reference' => "XXXXXXX", // Field required 
    'amount' => 100, // Field required
    'expiration_days' => 1, // Field required
    'recurrent' => false, // Field required
    'description' => "XXXXXX" // Field required
];

try {
    $order = $cash->generateOrder($carrierDetails, 
    $userDetails, 
    $orderDetails);
} catch (PaymentErrorException $error) {
    // See the console output for complete information
    // Access to HTTP code from gateway service
    $code = $error->getCode();
    $message = $error->getMessage();
}

// Get reference code
$referenceCode = $order->transaction->reference;
// Get expiration date
$expirationData = $order->transaction->expiration_date;
// Get order status
$status = $order->transaction->status;

Run unit tests

composer run test

=============================

Instalación

Intalación via composer (Por ahora no disponible desde packagist)

composer require shieldgate/sdk

Uso

<?php

require 'vendor/autoload.php';

use Payment\Payment;

// Primero configura las credenciales otorgadas por ShieldGate
$applicationCode = "SOME_APP_CODE";
$applicationKey = "SOME_APP_KEY";

Payment::init($applicationCode, $applicationKey);

Una vez configuradas tus credenciales, puedes usar los recursos disponibles.

Recursos disponibles:

Card

Métodos disponibles: getList, delete

Charge

Métodos disponibles: create, authorize, capture, verify, refund

Cash

Métodos disponibles: generateOrder

Tarjeta

Consulta la documentación completa de este medio de pago aquí.