動作要件
- PHP 8.0+
- Composer
- PHP 拡張機能: cURL、JSON、OpenSSL
インストール
composer require waffo/waffo-php
現在の最新バージョンは
v0.3.0 です。本番環境へ移行する前に Packagist で最新バージョンを確認してください。初期化
<?php
require __DIR__ . '/vendor/autoload.php';
use Waffo\Config\Environment;
use Waffo\Config\WaffoConfig;
use Waffo\Waffo;
$waffo = new Waffo(new WaffoConfig(
apiKey: 'your-api-key',
privateKey: 'your-base64-private-key',
waffoPublicKey: 'waffo-base64-public-key',
environment: Environment::Sandbox,
merchantId: 'your-merchant-id',
));
決済
<?php
$response = $waffo->order()->create([
'paymentRequestId' => bin2hex(random_bytes(16)),
'merchantOrderId' => 'ORDER-123',
'orderCurrency' => 'HKD',
'orderAmount' => '100.00',
'orderDescription' => 'Premium Plan',
'notifyUrl' => 'https://your-site.com/webhook/waffo',
'successRedirectUrl' => 'https://your-site.com/payment/success',
'failedRedirectUrl' => 'https://your-site.com/payment/failed',
'cancelRedirectUrl' => 'https://your-site.com/payment/cancel',
'userInfo' => ['userId' => 'user_123', 'userEmail' => 'user@example.com', 'userTerminal' => 'WEB'],
'paymentInfo' => ['productName' => 'ONE_TIME_PAYMENT'],
'goodsInfo' => ['goodsName' => 'Premium Plan', 'goodsUrl' => 'https://your-site.com/product/001'],
]);
if ($response->isSuccess()) {
var_dump($response->data);
}
照会
<?php
$response = $waffo->order()->inquiry(['paymentRequestId' => 'payment-request-id']);
if ($response->isSuccess()) {
var_dump($response->data);
}
サブスクリプション
<?php
$response = $waffo->subscription()->create(['subscriptionRequest' => 'sub-request-1', 'merchantSubscriptionId' => 'sub-1', 'currency' => 'USD', 'amount' => '9.99', 'notifyUrl' => 'https://example.com/webhooks/waffo', 'productInfo' => ['description' => 'Monthly plan', 'periodType' => 'MONTHLY', 'periodInterval' => '1'], 'userInfo' => ['userId' => 'user-1', 'userEmail' => 'user-1@example.com'], 'paymentInfo' => ['productName' => 'SUBSCRIPTION']]);
if ($response->isSuccess()) {
var_dump($response->data);
}
サブスクリプションの照会
<?php
$response = $waffo->subscription()->inquiry(['subscriptionRequest' => 'sub-request-1']);
if ($response->isSuccess()) {
var_dump($response->data);
}
サブスクリプションのキャンセル
<?php
$response = $waffo->subscription()->cancel(['subscriptionId' => 'subscription-id']);
if ($response->isSuccess()) {
var_dump($response->data);
}
返金
<?php
$response = $waffo->order()->refund(['refundRequestId' => 'refund-1', 'acquiringOrderId' => 'A123', 'refundAmount' => '10.00', 'refundReason' => 'Customer request']);
if ($response->isSuccess()) {
var_dump($response->data);
}
返金の照会
<?php
$response = $waffo->refund()->inquiry(['refundRequestId' => 'refund-1']);
if ($response->isSuccess()) {
var_dump($response->data);
}
Webhook 処理
<?php
$result = $waffo->webhook()
->onPayment(static function (array $event): void {})
->onRefund(static function (array $event): void {})
->onSubscriptionStatus(static function (array $event): void {})
->onSubscriptionPeriodChanged(static function (array $event): void {})
->onSubscriptionChange(static function (array $event): void {})
->handleWebhook(file_get_contents('php://input'), $_SERVER['HTTP_X_SIGNATURE'] ?? null);
header('X-SIGNATURE: ' . $result->responseSignature);
echo $result->responseBody;
X-SIGNATURE ヘッダーを SDK に渡し、SDK が生成したレスポンスボディと X-SIGNATURE を返す必要があります。
エラーハンドリング
<?php
use Waffo\Exception\WaffoUnknownStatusError;
try {
$response = $waffo->order()->create($params);
} catch (WaffoUnknownStatusError $error) {
$response = $waffo->order()->inquiry(['paymentRequestId' => $params['paymentRequestId']]);
}