Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harrypujianto/Veritrans-Codeigniter
https://github.com/harrypujianto/Veritrans-Codeigniter
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/harrypujianto/Veritrans-Codeigniter
- Owner: harrypujianto
- Created: 2015-08-12T09:33:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-04-16T09:06:11.000Z (about 5 years ago)
- Last Synced: 2024-03-06T03:33:28.505Z (4 months ago)
- Language: PHP
- Size: 188 KB
- Stars: 15
- Watchers: 6
- Forks: 65
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Lists
- awesome-codeigniter - Veritrans Codeigniter - Payment gateway library on Veritrans. (Web Services)
- awesome-codeigniter - Veritrans Codeigniter - Payment gateway library on Veritrans. (Web Services)
- awesome-codeigniter - Veritrans Codeigniter - Payment gateway library on Veritrans. (E-commerce)
README
Midtrans Codeigniter library
=======================================================
MIdtrans :heart: CI!
Veritrans now is Midtrans
This is the all new Codeigniter client library for Veritrans 2.0. Visit [https://www.midtrans.com](https://www.veritrans.co.id) for more information about the product and see documentation at [http://docs.midtrans.com](http://docs.veritrans.co.id) for more technical details.
### What's new?
SNAP! for technical info Visit [https://snap-docs.midtrans.com](https://snap-docs.midtrans.com)
### Requirements
The following plugin is tested under following environment:
* PHP v5.4.x or greater
* Codeigniter v2.2.x
## Installation
* Download the library and extract the .zip
* Merge all the files to your codeigniter directory
## Using Veritrans Library
### load library
```php
//set production to true for production environment
$params = array('server_key' => '', 'production' => false);
$this->load->library('veritrans');
$this->veritrans->config($params);
```
### SNAP
For more info please open dan read [snap docs](https://snap-docs.midtrans.com/)
See the snap example [here](https://github.com/harrypujianto/Veritrans-Codeigniter/blob/master/application/controllers/snap.php)
#### frontend requirement
```
Checkout
```
Change `src="https://app.sandbox.midtrans.com/snap/snap.js"` into `src="https://app.midtrans.com/snap/snap.js"`
#### initialize
```
$params = array('server_key' => '', 'production' => false);
$this->load->library('midtrans');
$this->midtrans->config($params);
```
set ``production =>true`` for production environment.
#### Get Snap Token
When button is clicked, call an ajax to the server. Located on
[here](https://github.com/harrypujianto/Veritrans-Codeigniter/blob/master/application/views/checkout_snap.php#L12-L26)
```
Pay!
$('#pay-button').click(function (event) {
event.preventDefault();
$(this).attr("disabled", "disabled");
$.ajax({
url: '<?=site_url()?>/snap/token', //calling this function
cache: false,
```
Calling this [function](https://github.com/harrypujianto/Veritrans-Codeigniter/blob/master/application/controllers/snap.php#L36).
```php
public function token()
{
// Required
$transaction_details = array(
'order_id' => rand(),
'gross_amount' => 94000, // no decimal allowed for creditcard
);
// Optional
$item1_details = array(
'id' => 'a1',
'price' => 18000,
'quantity' => 3,
'name' => "Apple"
);
// Optional
$item2_details = array(
'id' => 'a2',
'price' => 20000,
'quantity' => 2,
'name' => "Orange"
);
// Optional
$item_details = array ($item1_details, $item2_details);
// Optional
$billing_address = array(
'first_name' => "Andri",
'last_name' => "Litani",
'address' => "Mangga 20",
'city' => "Jakarta",
'postal_code' => "16602",
'phone' => "081122334455",
'country_code' => 'IDN'
);
// Optional
$shipping_address = array(
'first_name' => "Obet",
'last_name' => "Supriadi",
'address' => "Manggis 90",
'city' => "Jakarta",
'postal_code' => "16601",
'phone' => "08113366345",
'country_code' => 'IDN'
);
// Optional
$customer_details = array(
'first_name' => "Andri",
'last_name' => "Litani",
'email' => "[email protected]",
'phone' => "081122334455",
'billing_address' => $billing_address,
'shipping_address' => $shipping_address
);
// Fill transaction details
$transaction = array(
'transaction_details' => $transaction_details,
'customer_details' => $customer_details,
'item_details' => $item_details,
);
//error_log(json_encode($transaction));
$snapToken = $this->midtrans->getSnapToken($transaction);
error_log($snapToken);
echo $snapToken;
}
```
if succesfully get token then this script executed, to open snap on the screen
```
success: function(data) {
//location = data;
console.log('token = '+data);
var resultType = document.getElementById('result-type');
var resultData = document.getElementById('result-data');
function changeResult(type,data){
$("#result-type").val(type);
$("#result-data").val(JSON.stringify(data));
//resultType.innerHTML = type;
//resultData.innerHTML = JSON.stringify(data);
}
snap.pay(data, {
...
```
####Open
```
<title>Checkout</title>
<head>
<script type="text/javascript"
src="https://app.sandbox.midtrans.com/snap/snap.js"
data-client-key="<CLIENT-KEY>">
```
Change `src="https://app.sandbox.midtrans.com/snap/snap.js"` into `src="https://app.midtrans.com/snap/snap.js"`
### VT-Web
You can see some VT-Web examples [here](https://github.com/harrypujianto/Veritrans-Codeigniter/blob/master/application/controllers/vtweb.php).
#### Get Redirection URL of a Charge
```php
//you don't have to use the function name 'vtweb_charge', it's just an example
public function vtweb_charge()
{
$params = array(
'transaction_details' => array(
'order_id' => rand(),
'gross_amount' => 10000,
),
'vtweb' => array()
);
try {
// Redirect to Veritrans VTWeb page
header('Location: ' . $this->veritrans->vtweb_charge($params));
}
catch (Exception $e) {
echo $e->getMessage();
}
}
```
#### Handle Notification Callback
You can see notification handler examples [here](https://github.com/harrypujianto/Veritrans-Codeigniter/blob/master/application/controllers/vtweb.php).
```php
//you don't have to use the function name 'notification', it's just an example
public function notificarion()
{
$json_result = file_get_contents('php://input');
$result = json_decode($json_result);
if($result){
$notif = $this->veritrans->status($result->order_id);
}
$transaction = $notif->transaction_status;
$type = $notif->payment_type;
$order_id = $notif->order_id;
$fraud = $notif->fraud_status;
if ($transaction == 'capture') {
// For credit card transaction, we need to check whether transaction is challenge by FDS or not
if ($type == 'credit_card'){
if($fraud == 'challenge'){
// TODO set payment status in merchant's database to 'Challenge by FDS'
// TODO merchant should decide whether this transaction is authorized or not in MAP
echo "Transaction order_id: " . $order_id ." is challenged by FDS";
}
else {
// TODO set payment status in merchant's database to 'Success'
echo "Transaction order_id: " . $order_id ." successfully captured using " . $type;
}
}
}
else if ($transaction == 'settlement' && $type != 'credit_card'){
// TODO set payment status in merchant's database to 'Settlement'
echo "Transaction order_id: " . $order_id ." successfully transfered using " . $type;
}
else if($transaction == 'pending'){
// TODO set payment status in merchant's database to 'Pending'
echo "Waiting customer to finish transaction order_id: " . $order_id . " using " . $type;
}
else if ($transaction == 'deny') {
// TODO set payment status in merchant's database to 'Denied'
echo "Payment using " . $type . " for transaction order_id: " . $order_id . " is denied.";
}
```
### VT-Direct
You can see VT-Direct form [here](https://github.com/harrypujianto/Veritrans-Codeigniter/blob/master/application/views/checkout_with_3ds.php).
you can see VT-Direct process [here](https://github.com/harrypujianto/Veritrans-Codeigniter/blob/master/application/controllers/vtdirect.php).
#### Checkout Page
```html
Checkout
Checkout
Checkout
Card Number
Expiration (MM/YYYY)
/
CVV
Save credit card
Submit Payment
$(function(){
// Sandbox URL
Veritrans.url = "https://api.sandbox.veritrans.co.id/v2/token";
// TODO: Change with your client key.
Veritrans.client_key = "<your client key>";
//Veritrans.client_key = "d4b273bc-201c-42ae-8a35-c9bf48c1152b";
var card = function(){
return { 'card_number' : $(".card-number").val(),
'card_exp_month' : $(".card-expiry-month").val(),
'card_exp_year' : $(".card-expiry-year").val(),
'card_cvv' : $(".card-cvv").val(),
'secure' : true,
'bank' : 'bni',
'gross_amount' : 10000
}
};
function callback(response) {
if (response.redirect_url) {
// 3dsecure transaction, please open this popup
openDialog(response.redirect_url);
} else if (response.status_code == '200') {
// success 3d secure or success normal
closeDialog();
// submit form
$(".submit-button").attr("disabled", "disabled");
$("#token_id").val(response.token_id);
$("#payment-form").submit();
} else {
// failed request token
console.log('Close Dialog - failed');
//closeDialog();
//$('#purchase').removeAttr('disabled');
// $('#message').show(FADE_DELAY);
// $('#message').text(response.status_message);
//alert(response.status_message);
}
}
function openDialog(url) {
$.fancybox.open({
href: url,
type: 'iframe',
autoSize: false,
width: 700,
height: 500,
closeBtn: false,
modal: true
});
}
function closeDialog() {
$.fancybox.close();
}
$('.submit-button').click(function(event){
event.preventDefault();
//$(this).attr("disabled", "disabled");
Veritrans.token(card, callback);
return false;
});
});
```
#### Checkout Process
##### 1. Create Transaction Details
```php
$transaction_details = array(
'order_id' => time(),
'gross_amount' => 10000
);
```
##### 2. Create Item Details, Billing Address, Shipping Address, and Customer Details (Optional)
```php
// Populate items
$items = array(
array(
'id' => 'item1',
'price' => 5000,
'quantity' => 1,
'name' => 'Adidas f50'
),
array(
'id' => 'item2',
'price' => 2500,
'quantity' => 2,
'name' => 'Nike N90'
));
// Populate customer's billing address
$billing_address = array(
'first_name' => "Andri",
'last_name' => "Setiawan",
'address' => "Karet Belakang 15A, Setiabudi.",
'city' => "Jakarta",
'postal_code' => "51161",
'phone' => "081322311801",
'country_code' => 'IDN'
);
// Populate customer's shipping address
$shipping_address = array(
'first_name' => "John",
'last_name' => "Watson",
'address' => "Bakerstreet 221B.",
'city' => "Jakarta",
'postal_code' => "51162",
'phone' => "081322311801",
'country_code' => 'IDN'
);
// Populate customer's info
$customer_details = array(
'first_name' => "Andri",
'last_name' => "Setiawan",
'email' => "[email protected]",
'phone' => "081322311801",
'billing_address' => $billing_address,
'shipping_address' => $shipping_address
);
```
##### 3. Get Token ID from Checkout Page
```php
// Token ID from checkout page
$token_id = $_POST['token_id'];
```
##### 4. Create Transaction Data
```php
// Transaction data to be sent
$transaction_data = array(
'payment_type' => 'credit_card',
'credit_card' => array(
'token_id' => $token_id,
'bank' => 'bni',
'save_token_id' => isset($_POST['save_cc'])
),
'transaction_details' => $transaction_details,
'item_details' => $items,
'customer_details' => $customer_details
);
```
##### 5. Charge
```php
$response= $this->veritrans->vtdirect_charge($transaction_data);
```
##### 6. Handle Transaction Status
```php
// Success
if($response->transaction_status == 'capture') {
echo "
Transaksi berhasil.
";
echo "Status transaksi untuk order id $response->order_id: " .
"$response->transaction_status
";
echo "
Detail transaksi:
";
echo "";
var_dump($response);
echo "
";
}
// Deny
else if($response->transaction_status == 'deny') {
echo "Transaksi ditolak.
";
echo "Status transaksi untuk order id .$response->order_id: " .
"$response->transaction_status
";
echo "
Detail transaksi:
";
echo "";
var_dump($response);
echo "
";
}
// Challenge
else if($response->transaction_status == 'challenge') {
echo "Transaksi challenge.
";
echo "Status transaksi untuk order id $response->order_id: " .
"$response->transaction_status
";
echo "
Detail transaksi:
";
echo "";
var_dump($response);
echo "
";
}
// Error
else {
echo "Terjadi kesalahan pada data transaksi yang dikirim.
";
echo "Status message: [$response->status_code] " .
"$response->status_message
";
echo "
";
var_dump($response);
echo "
";
}
```
#### Process Transaction
##### Get a Transaction Status
```php
$status = $this->veritrans->status($order_id);
var_dump($status);
```
##### Approve a Transaction
```php
$approve = $this->veritrans->approve($order_id);
var_dump($approve);
```
##### Cancel a Transaction
```php
$cancel = $this->veritrans->cancel($order_id);
var_dump($cancel);
```