Coupon は環境ごとに Waffo による有効化が必要です。連携を始める前に、Waffo の営業担当またはテクニカルサポートへ Merchant ID と対象環境を連絡してください。
仕組み
対応範囲
Merchant Portal で設定する
1
Coupon を有効化する
Sandbox または Production の Merchant に対して Coupon を有効化するよう Waffo に依頼します。各環境を個別に確認してください。
2
Coupon を作成する
Merchant Portal にログインして Marketing → Coupons を開き、次の表に従って割引ルールと適用範囲を設定します。
3
Promotion Code を作成する
ユーザーに引換コードを入力させる場合は、Promotion Code を作成して Coupon に紐づけます。Coupon 詳細ページから作成するか、Marketing → Promotion Codes で 1 件または複数件を作成できます。
4
利用条件を設定する
必要に応じて利用回数、初回取引限定、最低注文金額、有効期限を設定して保存します。
Coupon の作成後は、割引タイプ、割引額、適用期間を変更できません。作成前に設定を確認してください。Coupon Name と Metadata は引き続き編集できます。利用を停止する場合は Coupon を無効化またはアーカイブします。

対応する通貨ごとに固定割引額を設定します。

適用期間によって、割引を 1 回、指定した請求期間、またはすべての Subscription 請求期間に適用します。
API から Coupon を適用する
promotionInfo では、次の相互排他的な 2 つのフィールドを使用できます。
1 回のリクエストでは一方だけを指定してください。
promotionCode と couponId を同時に送信しないでください。
1 回払い
POST /api/v1/order/create リクエストに promotionInfo を追加し、promotionCode または couponId のどちらか一方を指定します。
- promotionCode
- couponId
orderAmount は割引適用前の注文金額です。Coupon の検証後、Waffo が支払金額を再計算します。POST /api/v1/order/inquiry のレスポンスでは、originalAmount が割引前の金額、orderAmount が割引後の Merchant 注文金額です。
Subscription
POST /api/v1/subscription/create または POST /api/v1/subscription/change リクエストに promotionInfo を追加し、promotionCode または couponId のどちらか一方を指定します。
- promotionCode
- couponId
promotionInfo を指定してください。
Waffo Checkout で Promotion Code を入力させる
ユーザー自身にコードを適用させる場合は、1 回払い注文の作成時にpromotionInfo を省略します。ユーザーは orderAction.webUrl を開いた後、Checkout で Promotion Code を入力できます。
- Waffo は、Merchant で Coupon が有効で、注文作成時に割引が適用されていない場合にのみ入力欄を表示します。
- Checkout で入力できるのは Promotion Code です。
couponIdは入力できません。 - Waffo は Promotion Code を検証し、支払金額を再計算して表示します。
- 無効、期限切れ、利用条件外、または利用上限に達した Promotion Code は拒否されます。注文が通知なく定価で続行されることはありません。
- Merchant が API から Coupon を適用済みの場合、Checkout は割引後の金額を表示し、Promotion Code 入力欄を表示しません。
返金と決済結果
- 返金可能額の上限は割引後の Merchant 注文金額です。割引前の金額ではありません。
- Webhook または照会 API が返す最終ステータスを決済結果として扱ってください。ブラウザーのリダイレクトを決済成功の証明にしないでください。
promotionCodeまたはcouponIdを業務注文または Subscription とともに保存し、割引結果の照合と調査に利用してください。
受け入れチェックリスト
- Sandbox と対象 Production Merchant の両方で Coupon が有効になっています。
- 権限のあるアカウントで Merchant Portal の Coupons と Promotion Codes を開き、レコードを作成、表示できます。
- 1 回払いで
promotionCodeとcouponIdをそれぞれ使用した注文が成功し、各リクエストには一方のフィールドだけが含まれています。 - 割引を事前適用していない 1 回払い注文では、Checkout に有効な Promotion Code を入力でき、再計算後の金額が表示されます。
- 無効、期限切れ、または利用条件外の Promotion Code ではエラーが表示され、定価で続行されません。
- Subscription の作成または変更リクエストで Coupon が適用され、後続の請求期間は Coupon の適用期間設定に従います。
- Webhook または照会レスポンスで決済の最終ステータスを確認できます。1 回払いでは、
originalAmountとorderAmountがそれぞれ割引前と割引後の金額に一致します。 - 返金額が割引後の Merchant 注文金額を超えていません。