移行に関してのご案内・参考資料
新システムにおいての決済フローを簡単にまとめた資料となります。
移行手続きの参考としてご確認ください。
決済リクエスト方法や各パラメータなどが大幅に変更になっております。
ドキュメンテーションのご確認をお願い致します。
一部開発中、開発待ちのサービスや機能がございますが、可能な範囲で新システムをお使いいただき、移行できる決済方法については現在ある機能にて移行準備を進めていただくようお願い致します。システム移行をスムーズにおこなうためのご協力をお願い致します。
また、移行期間中において現行システムと新システムの併用は可能でございます。(明細書は別々となります)
旧システムと新システムにおける類似の各決済方式
旧システム | 新システム |
リンク方式 ※判断基準 ・弊社の決済ページ ・ptype「3」or「8」 | ウィジェット方式 |
ゲートウェイ方式・トークン方式 ※判断基準 ・加盟店様独自の決済ページ ・ptype「1」 | インラインフォーム・API方式・SDK方式 |
かんたんリンク・越境リンク・えらべる決済 | リンクフォーム(メールリンク) |
ワンタッチ課金(ゲートウェイ) | リカーリングトークンを用いたAPI |
ワンタッチCSV課金 | リカーリングトークンを用いたCSV課金 |
ワンタッチバーチャル(管理画面) | 開発未定。リカーリングトークンを用いたCSV課金にて応用。 |
新システムでの主な決済方法は以下となります。
初回課金
・ウィジェット方式……旧システムのリンク方式に類似。弊社の決済フォーム。ホームページ上などに決済リンク(ウィジェット)を設置されたい方向け。
・インラインフォーム……加盟店独自の決済フォームをご利用されたい方向け。ある程度のシステム構築の知識を要します。
・リンクフォーム(メールリンク)……旧システムのかんたんリンク決済/越境リンク決済/えらべる決済に類似。システム構築の知識がない方向け。
・API方式、SDK方式……システム構築可能な方向け
※初回課金時にカード情報通過をおこなう場合はPCI DSSに準拠が必須。SDK方式は開発言語が対応している場合に推奨。
※SDK方式:API方式の一連の処理を簡易的におこなえるパッケージツールです。
それぞれの概要などはドキュメンテーションのタイプ別実装ガイドをご参照ください。
2回目以降の決済
加盟店様側による2回目以降の決済方法は主に以下となります。
・定期課金による決済……旧システムの自動課金に類似。初回決済時に定期課金としてのコード設定が必要です。設定した金額や周期で自動的に課金がされていきます。
・CSV課金……旧システムのワンタッチCSV決済に類似。リカーリングトークンに対して加盟店様の任意のタイミングで課金が可能。初回決済時にリカーリングトークンとしてのコード設定が必要です。
CSV課金
・API方式(課金: Create)……旧システムのゲートウェイ(トークン)方式に類似。リカーリングトークンに対して課金リクエストをおこなう。初回決済時にリカーリングトークンとしてのコード設定が必要です。旧システムのワンタッチAPIの処理の類似もこちらとなります。
課金リクエスト
※旧システムにおけるワンタッチバーチャル機能は現在ございません。上記CSV課金をご利用ください。CSV課金をおこなうには初回決済時にリカーリングトークンとしての処理が必須となりますのでご注意ください。
※定期課金以外は初回課金時にリカーリングトークン(token-type=”recurring”)としての処理が必要になります。
リカーリングトークンの注意点
リカーリングトークンのセキュリティコード認証
事前におこなうこと
●どの決済方法においても必ずアプリトークンの登録が必要となります。
管理画面>アプリトークン>新規作成>利用店舗を指定するにチェック>店舗を指定>本番決済用かテスト決済用を選択>ドメインの追加>作成
※ドメインの追加はウィジェット方式もしくはインラインフォーム方式の場合必須です。
※2回目以降の課金でAPI方式を用いる場合は、登録時に発行されるシークレットトークンが必須です。保存をお願い致します。
※テストのアプリトークンを設定しておこなった課金はすべてテスト課金扱いとなりますので請求などは発生致しません。
※テスト課金時はテストアプリトークンを、本番課金時は本番アプリトークンを設定ください。
各決済方式について
●ウィジェット方式
サンプルコードを参考にしてHP内に記述してください。
ウィジェット:HTML
なお、以下より簡単にコード作成が可能です。
店舗>店舗名クリック>決済フォーム>ウィジェット>HTML
この画面にて各種入力や設定いただくと画面上部のHTMLコードが更新されますので、そのコードをコピーしてご利用ください。
●インラインフォーム
サンプルコードを参考にしてHP内に記述してください。
インラインフォームのセットアップ
なお、以下より簡単にコード作成が可能です。
店舗>店舗名クリック>決済フォーム>インラインフォーム
この画面にて各種入力や設定いただくと画面上部のHTMLコードが更新されますので、そのコードをコピーしてご利用ください。
※決済コード以外のレイアウトやデザインの変更については上記ドキュメントをご確認ください。
●リンクフォーム(メールリンク)
リンクフォームマニュアル
・設定画面
店舗>店舗名クリック>決済フォーム>リンクフォーム設定
この画面ではリンクフォームにおける共有の設定がおこなえます。
※この画面で指定したアプリトークンがテスト用の場合は、リンクフォームでおこなう決済はすべてテスト扱いとなります。本番運用開始の際は必ず本番トークンで設定しているかご確認ください。
・リンク発行画面
リンクフォーム>新規作成
こちらより決済リンクのURL、QRの作成が可能です。
作成後、メール等でユーザー様へご案内ください。
オプション設定で管理画面からのメール送信も可能です。
●API方式
仕様書をご確認ください。
APIリファレンス
●SDK方式
仕様書、GitHubに公開している情報をご確認ください。
SDK概要
サポートしている開発言語のリンク先よりGitHubへ遷移します。
SDKについての問い合わせは「Issues」から「New Issues」を押して当社エンジニアに質問・要望を日本語または英語でお送りください。
https://github.com/univapay/univapay-php-sdk/issues
テスト決済について
テスト用のアプリトークンを登録し、そのアプリトークンをコード設定の際に指定してください。
テストカードは、管理画面>テスト課金>カード番号 のプルダウンに表示される情報をご利用ください。
※カード情報以外は自由に変更してテスト可能です。有効期限は未来すぎるとエラーとなりますので、数年以内の値を指定してください。
テスト課金
もしくは以下にもテストカード情報の記載がございます。
課金
テストトークンによる決済情報は1ヵ月で消去されます。1日で1440件という制限があります。
本番運用する際は、アプリトークンを本番用に変更して開始してください。テストトークンで決済をおこなっても売上扱いとはなりませんのでご注意ください。
その他
・用語や一部機能の対比表
旧システムと新システムの用語・機能の対比表
・各パラメータの対比表
旧システムと新システムのパラメータ対比表
・ワンタッチ課金データの移行について
データ移行のタイミングは加盟店様と確認したうえで実施致します。
移行した際はマッピングデータをお送り致します。
決済情報の移行ではなく、ワンタッチ決済に必要なデータ(リカーリングトークン)を移行します。
※データ移行はできるだけ一度で完了したいため、新規決済を新システムで運用開始(準備完了)されていることを条件と致します。ワンタッチ課金の既存データは過去18ヵ月以内の直近データのみとなります。
データ移行ご希望日の際はワンタッチ課金を以下のどの情報をキーにしておこなっているかも
合わせてお知らせくださいませ。
・店舗オーダー番号
・電話番号
・決済番号
開発中もしくは開発予定の主な決済サービス・機能
・口座振替サービス※2023年3月以降に延期。口座振替サービスに関しては2023年3月以降も現システムで引き続きご利用可。別途ご案内予定。
・Wechat決済のウィジェット方式 → 2023/02/28に実装
・定期課金の停止URL、カード情報変更URL機能
・自動課金データの移行機能(現行システムの既存決済データを新システムへ移行。加盟店様と確認のうえ弊社側で対応予定)
・ワンタッチ更新機能(リカーリングトークンの再取得で運用ください)
・ワンタッチバーチャル機能
・クレジット専用レンタル端末機能
・管理画面上での定期課金の課金日変更機能
・決済情報CSVダウンロード → 2023/02/20に実装
・ウィジェット方式やAPI方式の商品登録(リンクフォームのみ対応済)
・商品別決済完了メール
・リンクフォームでの回数(金額)指定の定期課金 → 2023/02/13に実装
・回数指定の定期課金とカード会社分割機能の併用(現在併用不可)
・定期課金の回数によってカード会社分割になる仕様の修正
ECCUBEをご利用の加盟店様
新システムではECCUBEのバージョンは4.1以降のみとなります。
EC-CUBE 4.0.6-p1より以前のバージョンは危険な脆弱性が存在するため
本プラグインのご利用はお控えください。
現在4.1以上ではない加盟店様はバージョンのアップデートや
それに伴う運用の見直しなどもお願い致します。
※推奨動作環境はバージョン4.1、4.2となります。
4.1と4.2は互換性がないためそれぞれプラグインが異なります。
EC-CUBE決済モジュールに関しまして、
以下のURLよりプラグインのダウンロードをお願い致します。
バージョン4.1用
https://github.com/univapay/UnivaPay-for-EC-CUBE4/releases
バージョン4.2用
https://github.com/univapay/UnivaPay-for-EC-CUBE42/releases
導入手順書はこちらよりダウンロードお願い致します。
https://link.upc-app.com/plugin_donyutejunsyo.pdf
WooCommerceをご利用の加盟店様
導入手順書はこちらよりダウンロードお願い致します。
https://link.upc-app.com/UnivaPayPlugin_WooCommercedonyutejunsyo.pdf
ウィジェット決済におけるパラメータのサンプル
※API方式の場合はパラメータが少し異なります。詳細は仕様書をご確認ください。
●カードの登録処理(金額0円)
<script src="https://widget.univapay.com/client/checkout.js"></script>
<span data-app-id="アプリトークンを入れてください"
data-checkout="token"
data-token-type="recurring"
data-payment-type="card"
data-cvv-authorize="true"
data-text="カード登録">
</span>
※「data-cvv-authorize=”true”」を記述することで、1円オーソリ処理をおこないカード認証と登録をおこないます。旧システムにおける有効性チェックのような処理となります。「data-cvv-authorize=”true”」の指定が無い場合、リカーリングトークン処理はされますが、セキュリティコードが5分で削除されるため、5分以内に課金処理が必要となります。
●課金とリカーリングトークン処理(以降、data-app-idなど一部省略しております。)
data-checkout="payment"
data-amount="100"
data-currency="jpy"
data-payment-type="card"
data-token-type="recurring"
data-text="100円課金とカード登録"
●初回0円の定期課金について
初回処理はセキュリティコード認証「data-cvv-authorize=”true”」と開始日の指定をおこなう必要がございます。
①開始日を日付(yyyymmdd形式)で指定する
data-checkout="payment"
data-amount="100"
data-currency="jpy"
data-text="定期課金初回0円、10月14日から毎週支払い"
data-token-type="subscription"
data-subscription-period="weekly"
data-cvv-authorize="true"
data-subscription-start="2022-10-14"
data-subscription-initial-amount="0"
②開始日を翌月の日付で指定する
data-checkout="payment"
data-amount="100"
data-currency="jpy"
data-text="定期課金初回0円、翌月10日から毎月支払い"
data-token-type="subscription"
data-subscription-period="monthly"
data-cvv-authorize="true"
data-subscription-start-in="P1M"
data-subscription-start-day-of-month="10"
data-subscription-initial-amount="0"
※当月の日付指定は”P1M”を”P0M”としてください。
●定期課金で支払い回数を設定する(課金毎の金額を指定する)
※カード会社分割をご契約の場合はご利用できません。
data-checkout="payment"
data-amount="360"
data-currency="jpy"
data-token-type="subscription"
data-subscription-period="monthly"
data-installment-plan="fixed_cycle_amount"
data-installment-qty="120"
data-text="定期課金120円3回払い
※data-amountにて合計金額を決め、data-installment-qtyで課金毎の金額を指定。
360円の決済を120円を3回に分けて課金をするようになります。
初回120円→次月の同日120円→次々月同日に120円→課金終了。
旧システムの回数制限付き自動課金のような処理となります。
●分割のプルダウンを表示させる(カード会社分割利用が可能な契約の場合のみ)
data-checkout="payment"
data-amount="100"
data-currency="jpy"
data-payment-type="card"
data-allow-card-installments="true"
data-text="100円分割払い有り"
※data-allow-card-installments=”true”を記述することでウィジェット上で分割のプルダウンが表示されます。
※支払い回数指定の定期課金と併用不可。
<2023/02/12時点の情報>