Skip to main content
API統合は、決済フローを完全に制御したい場合に適しています。Waffo REST APIを直接呼び出し、決済、サブスクリプション、返金、Webhook処理を自社システムに接続します。

​
適用シナリオ

  • サーバー間での決済処理
  • 独自のホスト型チェックアウトページや決済フォームをすでに保有している場合
  • 最大限の柔軟性が求められるカスタム統合

​
統合ロードマップ

1

プロダクトを選択する

単発課金にはワンタイム決済、継続課金にはサブスクリプション決済を選択します。
2

必須APIを連携する

ワンタイム決済ではオーダー作成、オーダー照会、決済通知が必須です。サブスクリプション決済ではサブスクリプション作成、照会、ステータス通知、決済通知が必須です。
3

必要な条件付きAPIを追加する

キャンセル、返金、返金照会、返金通知、サブスクリプション管理、サブスクリプション変更は、業務フローで必要な場合のみ追加します。
4

API Referenceで項目詳細を確認する

リクエスト項目、レスポンス項目、列挙値、署名ルールは API Reference を確認してください。オフラインPDFから項目定義をコピーしないでください。
5

サンドボックスでテストする

サンドボックスとテスト を使用します。Apple Pay または Google Pay が必要な場合は、追加チェックも完了してください。
6

受け入れ資料を提出する

初回連携では、ワンタイム決済受け入れテンプレート または サブスクリプション受け入れテンプレート を選択します。初回ではないワンタイム決済の追加連携の場合にのみ、ワンタイム決済の追加連携受け入れテンプレート を使用します。実行済みケースを記入し、Waffo の技術連携グループへ提出します。

​
ベースURL

​
リクエスト形式

  • Content-Type: application/json(UTF-8エンコーディング)
  • すべてのリクエストはHTTP POSTを使用
  • リクエストヘッダーに X-API-KEY と X-SIGNATURE を必ず含める
  • 生 HTTP リクエストでは X-API-VERSION: 1.0.0 を明示的に送信する必要があります。SDK を使用する場合、このヘッダーは SDK が自動的に管理するため、手動で設定または上書きしないでください。API バージョン履歴の v1.3 はドキュメントと外部契約の改訂系列を示すため、このリクエストヘッダーには使用しないでください
  • すべての /api/v1/subscription/create リクエストで subscriptionManagementUrl が必須です

​
レスポンス形式

  • code が "0" の場合は成功を示します
  • 失敗時は code がエラーコード(例: "A0003")となり、data は空になります
  • レスポンスヘッダーの X-SIGNATURE にはWaffoの署名が含まれており、必ず検証してください

​
主要API

​
ワンタイム決済

​
サブスクリプション決済

​
設定照会

​
受け入れテンプレート

API統合とサンドボックステストの完了後、連携段階に応じたテンプレートをダウンロードして記入してください：
このテンプレートは ONE_TIME_PAYMENT に適用されます。少なくとも1回の連携受け入れを完了しており、今回が初回ではない追加連携の場合にのみ使用してください。初回連携では使用しないでください。
記入済みの受け入れ結果を Waffo の技術連携グループへ提出してください。本番移行前に 統合受け入れ基準 を確認してください。