第 5 章 / 全 27 章
加盟店管理
加盟店(EC サイト運営者)のアカウントを発行・管理します。
一覧
加盟店 ID・サイト名・会社名・担当者名・担当代理店・メール通知設定・登録日を表示します。行をクリックすると詳細画面へ移動します。20 件ごとにページ送りされます。
加盟店の追加
右上の + 加盟店追加 から登録します。
| 項目 | 説明 |
|---|---|
| 加盟店 ID | MER-00001 形式で自動採番。変更できません |
| 加盟店パスワード | 登録時に自動生成され、暗号化して保存されます。画面では常に ******** |
| サイト名 / ふりがな | ふりがなは 全角カタカナのみ |
| 会社名 / 担当者名 | 必須 |
| 担当代理店 | 任意。代理店管理に登録済みの代理店から選択 |
| メールアドレス / 明細送付先 | 形式を検証。「メールアドレスと同じ」で複製できます |
| システム通知先 URL | 決済結果を送る加盟店側エンドポイント。https のみ |
| 通知パラメータ設定 | 通知の型 / 送信パラメータセット / 決済識別子の形式(詳細は「通知パラメータ仕様」) |
| メール通知設定 | 決済ごと(取引が完了するたびに担当者メールへ「決済完了通知」)/ 1 日まとめて通知(毎朝 9 時に前日分の件数・金額・決済種別別内訳・失敗・期限切れ件数を「日次サマリー」として送信。前日の取引が 0 件なら送らない)/ メール通知無し。宛先は担当者のメールアドレスで、明細送付先メールは精算関連にのみ使います |
必須項目が揃うまで「登録する」は押せません。エラーがある場合は該当項目の下にメッセージが表示され、最初のエラー項目までスクロールします。
登録が完了すると テスト環境の署名シークレット が自動発行され、完了画面に 1 回だけ 平文で表示されます(API キーの発行と同じ扱い。画面を離れると再表示できず、API キータブから再発行 / ローテーションします)。本番環境の署名シークレットは API キータブから発行してください。署名シークレットの無い環境への Webhook は送信されません(Webhook 送信ログ)。
詳細と編集
詳細画面は 閲覧モード で開きます。右上の 編集 を押すと編集モードになり、最下部の 更新 で保存します。保存後は自動で閲覧モードに戻ります。
- 加盟店 ID とパスワードは編集できません。
- パスワードの表示(目のアイコン)と再発行 はマスター権限のみ使えます。一般権限ではボタンが無効になり、API も 403 を返します。
- 再発行すると旧パスワードは無効になります。表示された新しい値を加盟店に連携してください。
利用可能な決済手段
「利用可能な決済手段」と「振込IDの桁数」は加盟店フォームの 決済設定 で編集します。振込IDの桁数(7 桁または 8 桁)は、この加盟店の銀行振込の取引に発行される振込IDの長さです。
タブ構成
詳細画面は 7 つのタブに分かれています。基本情報 と 通知設定 は右上の「編集」で加盟店フォームを開き、他のタブはそれぞれ専用の入力欄を持ちます。
| タブ | 内容 |
|---|---|
| 基本情報 | 加盟店 ID・パスワード・サイト / 会社 / 担当者・担当代理店・利用可能な決済手段・振込IDの桁数・連絡先 |
| 契約・手数料 | 契約プランと決済手段ごとの手数料率、適用開始日、契約履歴、振込期限・返金可能期限 |
| 限度額 | 決済手段ごとの 1 回 / 1 日 / 1 か月の限度額と、本日・今月の利用状況 |
| APIキー | 加盟店サイトが決済 API を呼ぶための API キーと、通知の署名シークレット |
| 通知設定 | システム通知先 URL・通知の型・パラメータセット・識別子と通知サンプル |
| 精算設定 | 締めサイクル・支払サイト・振込先口座・精算手数料と、この加盟店の精算バッチ(精算管理) |
| Webhook送信ログ | この加盟店への直近の通知と結果(Webhook 送信ログ) |
契約・手数料
| 項目 | 説明 |
|---|---|
| 契約プラン | スタンダード / プレミアム は既定の料率が自動で入り、カスタム は決済手段(クレジット / QR / コンビニ / 銀行振込)ごとに料率(%・小数 2 桁)と固定手数料(円/件)を入力します |
| 適用開始日 | 指定日の 0:00(日本時間)から新しい料率が適用されます。未来日を指定すると 適用予定 として登録され、当日まで現在の契約が有効です |
| 契約履歴 | 過去の契約は削除せず履歴として残り、適用中 / 適用予定 / 終了のバッジで区別します |
| 振込期限(日) | 銀行振込の申請から振込期限までの日数(1〜60、既定 7)。新しく作成する取引 に適用されます |
| 返金可能期限(日) | 完了日からこの日数以内であれば返金できます(0〜365、既定 180)。取引詳細に 返金可能期限 として表示します |
契約の登録・期限の変更はすべて 操作ログ に変更前後の値とともに記録されます。
限度額
決済手段ごとに 1 回あたり / 1 日あたり / 1 か月あたり の上限金額を設定します(空欄は無制限)。上部のカードには表示中のモード(テスト / 本番)での本日・今月の取扱高と消化率を表示します。
限度額を超える取引は加盟店サイトからの申請時に 失敗 として記録され、取引詳細の「失敗理由」に「1 回あたり / 1 日あたり / 1 か月あたりの限度額を超過」と表示されます(一覧では「限度額超過」バッジ)。失敗・キャンセル・期限切れの取引は限度額の消化に含めません。
APIキー
| 項目 | 説明 |
|---|---|
| モード | テスト / 本番。キーの先頭(wp_test_… / wp_live_…)で見分けられます |
| 種別 | API キー(加盟店サイトから決済 API を呼ぶ Bearer トークン)/ 署名シークレット(通知の署名検証に使う共有鍵) |
| 発行 | 発行直後の画面で 1 回だけ 平文を表示します。DB には SHA-256 ハッシュのみ保存するため、閉じると再表示できません |
| ローテーション | 同じモード・種別・ラベルで新しいキーを発行し、旧キーは 猶予期間(既定 7 日、0〜90 日)の間だけ併用できます。期限が来ると自動的に 期限切れ になります |
| 失効 | 直ちに無効化します。失効したキーはローテーションできません |
| 最終利用 | 加盟店 API がキーを受け付けた最終日時 |
疎通確認には GET /api/merchant-api/ping を使います。Authorization: Bearer <API キー> で呼ぶと加盟店 ID・モード・ステータスを返し、その加盟店向けの IP制限(加盟店 API・ブロック)にも従います。
テスト / 本番の切替
ヘッダーの テスト / 本番 スイッチは、決済一覧・決済申請一覧・ダッシュボード・限度額の利用状況が参照するデータモードを切り替えます(選択は Cookie に保存)。取引はプロバイダのモードを作成時にスナップショットしており、テストモードでは本番の取引は表示されません。
加盟店 API リファレンス
加盟店サイトが Wire Pay を呼ぶ 加盟店 API(/api/merchant-api/*)の共通仕様です。管理画面のセッションは不要で、API キーで認証します。
| 項目 | 内容 |
|---|---|
| 認証 | Authorization: Bearer wp_<test または live>_ak_<32 文字>(API キー。署名シークレット wp_…_ss_… は通知の検証専用で、認証には使えません) |
| キーの判定 | SHA-256 ハッシュで検索し、失効済み・期限切れ(ローテーション猶予の終了)は拒否。成功すると最終利用日時を更新 |
| モード | キーのモード(テスト / 本番)がそのまま応答データのモードになります |
| IP 制限 | その加盟店向けの IP制限(対象 = 加盟店 API・ブロック)に一致すると拒否 |
| 応答形式 | 成功 { "ok": true, "data": … } / 失敗 { "ok": false, "error": { "code", "message" } }。message は Accept-Language または x-lang ヘッダーの言語 |
| レート制限 | 公開 API /api/v1 と同じく加盟店 × 環境で 60 回 / 分(同じバケットを共有)。超過は 429 rate_limited と Retry-After、成功応答には X-RateLimit-Limit / X-RateLimit-Remaining |
| エラー | HTTP | 意味 |
|---|---|---|
invalid_api_key | 401 | ヘッダーが無い・形式が違う・不明・失効・期限切れ |
ip_blocked | 403 | 加盟店 API 向けのブロックルールに一致 |
not_found | 404 | 他社のリソース、別モードのリソース、存在しない ID |
| エンドポイント | 用途 | 応答 data |
|---|---|---|
GET /api/merchant-api/ping | 疎通確認・キーの検証 | { merchantCode, siteName, mode, kind, keyPrefix, status } |
GET /api/merchant-api/settlements[?id=] | 精算バッチの一覧 / 明細(精算管理) | 一覧: { merchantCode, mode, settlements: [...] } / 1 件: { batch, lines } |
GET /api/merchant-api/announcements | 自分が対象のお知らせ(お知らせ配信) | { merchantCode, announcements: [ { id, kind, title, body, publishFrom, publishUntil, updates } ] } |
curl https://<host>/api/merchant-api/ping \ -H 'Authorization: Bearer wp_test_ak_KotoriDemoTestKey000000000000001'
seed の加盟店 MER-00001 には上記のテストキーが発行済みです。加盟店サイトからの決済作成は同じキーで呼ぶ 公開 API v1(POST /api/v1/transactions。公開 API と API ドキュメント)で行います。管理画面の「決済を作成」と POST /api/payments(管理者セッション)は PSP 側の操作用です。