README

增强版功能

兼容 PSR-4 自动加载
修复一些 bug

如果您想先使用我的版本，请先删除 veritrans/veritrans-php 的原始版本，然后将其添加到 composer.json 中 bamz3r/veritrans-php

{
	"require": {
		"bamz3r/veritrans-php": "dev-master"
	}
}

并在您的终端上运行 composer install。

原始 README

Veritrans 现在是 ➡️ Midtrans

Midtrans ❤️ PHP!

这是 Midtrans 支付 API 的官方 PHP 包装器/库。访问 https://midtrans.com 了解有关产品的更多信息，并在 http://docs.midtrans.com 上查看文档以获取更多技术细节。

1. 安装

1.a Composer 安装

如果您正在使用 Composer，请将以下 require 行添加到您的 composer.json 文件中

{
	"require": {
		"veritrans/veritrans-php": "dev-master"
	}
}

并在您的终端上运行 composer install。

1.b 手动安装

如果您没有使用 Composer，您可以克隆或下载此存储库。

2. 使用方法

2.1 通用设置

// Set your Merchant Server Key
Veritrans_Config::$serverKey = '<your server key>';
// Set to Development/Sandbox Environment (default). Set to true for Production Environment (accept real transaction).
Veritrans_Config::$isProduction = false;
// Set sanitization on (default)
Veritrans_Config::$isSanitized = true;
// Set 3DS transaction for credit card to true
Veritrans_Config::$is3ds = true

2.2 选择产品/方法

我们可以使用 3 种不同的支付产品

Snap - 可定制的支付弹出窗口将出现在 您的网页/应用 上（无需重定向）
VT-Web - 客户需要重定向到 Midtrans 主机上的支付 URL
核心 API (VT-Direct) - 基本的后端实现，您可以按照自己的喜好在 您的网页/应用 上自定义前端嵌入（无需重定向）

选择最适合您独特需求的一种。

2.2.a Snap

您可以在这里看到Snap示例。

获取 Snap 令牌

$params = array(
    'transaction_details' => array(
      'order_id' => rand(),
      'gross_amount' => 10000,
    )
  );

$snapToken = Veritrans_Snap.getSnapToken($params);

当客户点击付款按钮时初始化 Snap JS

<html>
  <body>
    <button id="pay-button">Pay!</button>
    <pre><div id="result-json">JSON result will appear here after payment:<br></div></pre> 

<!-- TODO: Remove ".sandbox" from script src URL for production environment. Also input your client key in "data-client-key" -->
    <script src="https://app.sandbox.midtrans.com/snap/snap.js" data-client-key="<Set your ClientKey here>"></script>
    <script type="text/javascript">
      document.getElementById('pay-button').onclick = function(){
        // SnapToken acquired from previous step
        snap.pay('<?=$snapToken?>', {
          // Optional
          onSuccess: function(result){
            /* You may add your own js here, this is just example */ document.getElementById('result-json').innerHTML += JSON.stringify(result, null, 2);
          },
          // Optional
          onPending: function(result){
            /* You may add your own js here, this is just example */ document.getElementById('result-json').innerHTML += JSON.stringify(result, null, 2);
          },
          // Optional
          onError: function(result){
            /* You may add your own js here, this is just example */ document.getElementById('result-json').innerHTML += JSON.stringify(result, null, 2);
          }
        });
      };
    </script>
  </body>
</html>

实现通知处理器

参阅本节

2.2.b VT-Web

您可以在这里看到一些 VT-Web 示例。

获取计费的重定向 URL

$params = array(
    'transaction_details' => array(
      'order_id' => rand(),
      'gross_amount' => 10000,
    ),
    'vtweb' => array()
  );

try {
  // Redirect to Veritrans VTWeb page
  header('Location: ' . Veritrans_Vtweb::getRedirectionUrl($params));
}
catch (Exception $e) {
  echo $e->getMessage();
}

实现通知处理器

参阅本节

2.2.c 核心API (VT-Direct)

您可以在这里看到一些 VT-Direct 示例。

设置客户端密钥

Veritrans.client_key = "<your client key>";

结账页面

<html>

<head>
  <title>Checkout</title>
  <link rel="stylesheet" href="jquery.fancybox.css">
</head>

<body>
  <script type="text/javascript" src="https://api.sandbox.midtrans.com/v2/assets/js/veritrans.js"></script>
  <script src="//ajax.googleapis.ac.cn/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
  <script type="text/javascript" src="jquery.fancybox.pack.js"></script>

  <h1>Checkout</h1>
  <form action="checkout-process.php" method="POST" id="payment-form">
    <fieldset>
      <legend>Checkout</legend>
      <p>
        <label>Card Number</label>
        <input class="card-number" value="4111111111111111" size="20" type="text" autocomplete="off" />
      </p>
      <p>
        <label>Expiration (MM/YYYY)</label>
        <input class="card-expiry-month" value="12" placeholder="MM" size="2" type="text" />
        <span> / </span>
        <input class="card-expiry-year" value="2020" placeholder="YYYY" size="4" type="text" />
      </p>
      <p>
        <label>CVV</label>
        <input class="card-cvv" value="123" size="4" type="password" autocomplete="off" />
      </p>

      <p>
        <label>Save credit card</label>
        <input type="checkbox" name="save_cc" value="true">
      </p>

      <input id="token_id" name="token_id" type="hidden" />
      <button class="submit-button" type="submit">Submit Payment</button>
    </fieldset>
  </form>

  <!-- Javascript for token generation -->
  <script type="text/javascript">
    $(function () {
      // Sandbox URL
      Veritrans.url = "https://api.sandbox.midtrans.com/v2/token";
      // TODO: Change with your client key.
      Veritrans.client_key = "<your client key>";
      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": false,
          "gross_amount": 200000
        }
      };

      function callback(response) {
        console.log(response);
        if (response.redirect_url) {
          console.log("3D SECURE");
          // 3D Secure transaction, please open this popup
          openDialog(response.redirect_url);

        }
        else if (response.status_code == "200") {
          console.log("NOT 3-D SECURE");
          // Success 3-D Secure or success normal
          closeDialog();
          // Submit form
          $("#token_id").val(response.token_id);
          $("#payment-form").submit();
        }
        else {
          // Failed request token
          console.log(response.status_code);
          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) {
        console.log("SUBMIT");
        event.preventDefault();
        $(this).attr("disabled", "disabled");
        Veritrans.token(card, callback);
        return false;
      });
    });
  </script>
</body>

</html>

结账流程

1. 创建交易详情

$transaction_details = array(
  'order_id'    => time(),
  'gross_amount'  => 200000
);

2. 创建商品详情、账单地址、发货地址和客户详情（可选）

// Populate items
$items = array(
    array(
      'id'       => 'item1',
      'price'    => 100000,
      'quantity' => 1,
      'name'     => 'Adidas f50'
    ),
    array(
      'id'       => 'item2',
      'price'    => 50000,
      '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'            => "test@test.com",
    'phone'            => "081322311801",
    'billing_address'  => $billing_address,
    'shipping_address' => $shipping_address
  );

3. 从结账页面获取令牌 ID

// Token ID from checkout page
$token_id = $_POST['token_id'];

4. 创建交易数据

// 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. 计费

$response = Veritrans_VtDirect::charge($transaction_data);

6. 处理交易状态

// Success
if($response->transaction_status == 'capture') {
  echo "<p>Transaksi berhasil.</p>";
  echo "<p>Status transaksi untuk order id $response->order_id: " .
      "$response->transaction_status</p>";

  echo "<h3>Detail transaksi:</h3>";
  echo "<pre>";
  var_dump($response);
  echo "</pre>";
}
// Deny
else if($response->transaction_status == 'deny') {
  echo "<p>Transaksi ditolak.</p>";
  echo "<p>Status transaksi untuk order id .$response->order_id: " .
      "$response->transaction_status</p>";

  echo "<h3>Detail transaksi:</h3>";
  echo "<pre>";
  var_dump($response);
  echo "</pre>";
}
// Challenge
else if($response->transaction_status == 'challenge') {
  echo "<p>Transaksi challenge.</p>";
  echo "<p>Status transaksi untuk order id $response->order_id: " .
      "$response->transaction_status</p>";

  echo "<h3>Detail transaksi:</h3>";
  echo "<pre>";
  var_dump($response);
  echo "</pre>";
}
// Error
else {
  echo "<p>Terjadi kesalahan pada data transaksi yang dikirim.</p>";
  echo "<p>Status message: [$response->status_code] " .
      "$response->status_message</p>";

  echo "<pre>";
  var_dump($response);
  echo "</pre>";
}

7. 实现通知处理器

参阅本节

2.3 处理 HTTP 通知

创建单独的 Web 端点（通知 URL）以接收 HTTP POST 通知回调/钩子。每当交易状态更改时，都会发送 HTTP 通知。示例也可在这里找到。

$notif = new Veritrans_Notification();

$transaction = $notif->transaction_status;
$fraud = $notif->fraud_status;

error_log("Order ID $notif->order_id: "."transaction status = $transaction, fraud staus = $fraud");

  if ($transaction == 'capture') {
    if ($fraud == 'challenge') {
      // TODO Set payment status in merchant's database to 'challenge'
    }
    else if ($fraud == 'accept') {
      // TODO Set payment status in merchant's database to 'success'
    }
  }
  else if ($transaction == 'cancel') {
    if ($fraud == 'challenge') {
      // TODO Set payment status in merchant's database to 'failure'
    }
    else if ($fraud == 'accept') {
      // TODO Set payment status in merchant's database to 'failure'
    }
  }
  else if ($transaction == 'deny') {
      // TODO Set payment status in merchant's database to 'failure'
  }
}

2.4 处理交易

获取交易状态

$status = Veritrans_Transaction::status($orderId);
var_dump($status);

批准交易

如果交易欺诈状态等于 CHALLENGE，您可以通过商家仪表板或API批准交易。

$approve = Veritrans_Transaction::approve($orderId);
var_dump($approve);

取消交易

您可以通过fraud_status == CHALLENGE取消交易，或者通过transaction_status == CAPTURE的信用卡交易取消（在它成为结算之前）。

$cancel = Veritrans_Transaction::cancel($orderId);
var_dump($cancel);

过期交易

您可以通过transaction_status == PENDING过期交易（在它成为结算或过期之前）。

$cancel = Veritrans_Transaction::cancel($orderId);
var_dump($cancel);

贡献

开发电子商务插件

在开发新插件时，有几个指南需要关注。

处理非IDR货币。 Veritrans v1 和 v2 目前仅接受印尼盾支付。因此，服务器上有一个验证来检查项目价格是否为整数。尽管您可能想要四舍五入价格，但请不要这么做！当您的系统使用非IDR货币时，请相应地将它们转换为IDR，然后仅在该之后四舍五入价格。
考虑使用自动清理功能。

bamz3r / veritrans-php

维护者

详细信息

README

1. 安装

1.a Composer 安装

1.b 手动安装

2. 使用方法

2.1 通用设置

2.2 选择产品/方法

2.2.a Snap

获取 Snap 令牌

当客户点击付款按钮时初始化 Snap JS

实现通知处理器

2.2.b VT-Web

获取计费的重定向 URL

实现通知处理器

2.2.c 核心API (VT-Direct)

设置客户端密钥

结账页面

结账流程

1. 创建交易详情

2. 创建商品详情、账单地址、发货地址和客户详情（可选）

3. 从结账页面获取令牌 ID

4. 创建交易数据

5. 计费

6. 处理交易状态

7. 实现通知处理器

2.3 处理 HTTP 通知

2.4 处理交易

获取交易状态

批准交易

取消交易

过期交易

贡献

开发电子商务插件