UnivaPay

QR決済API連携ガイド

バージョン履歴

2017/10/03 初版

2018/07/26 第2版

2020/03/18 第3版

2024/03/18 第4版

0. はじめに

本ドキュメントは HTML,HTTP プロトコルを理解する開発者を対象に作成した、株式会社ユニヴァ・ペイキャストが提供する「Univapay」でのAPI連携ガイドです。
弊社加盟店様サポートサイト内”各種資料ダウンロード”ページで公開中の「Univapay QR決済API仕様書」をあわせてご参照ください。
各処理の詳細な仕様に関しては、本ドキュメントではなくAPI仕様書に記載しております。

各種資料ダウンロードページURL
https://upc-app.com/credit/linksample_v2/document.html

本ドキュメントの内容は著作権で保護されており、本書の内容の一部または全部を株式会社ユニヴァ・ペイキャストの同意なしに複写、複製および転載することを禁じます。
本書の内容は予告なしに随時更新されることがあります。
本書の内容については万全を期していますが、記入漏れ等お気づきの点は、弊社サポートデスクへご連絡ください。

サポートデスク:お問い合わせ先

TEL:0570-200-866 (9:30~18:30)
※IP電話・PHSの方は 06-6538-1181 へおかけください

MAIL:ips-support@univapay.com
お問い合わせいただく際は、「契約名もしくは 店舗名」を最初にお伝えください

1 保存/必要情報

端末側もしくは実際に弊社へ接続を行うサーバーが保存しておいた方が良い情報を記載します。

マスタデータ

フィールド文字種(桁)説明
mid半角数字( 16)弊社が発行する端末識別番号
key半角英数( 50)端末のMACアドレスまたはユニークな ID
password半角英数( 12)弊社が発行するログイン用パスワード
passCode半角数字( 4)弊社が発行 or 御社にて設定可能な返金用パスワード

トランザクションデータ

フィールド文字種(桁)説明
transKey半角英数( 34)御社が生成し申込時に利用するユニークな ID
transId半角数字( 10)弊社が発番する決済番号
serviceId半角数字(2)決済を行ったサービスを表す ID

定数

フィールド字種(桁)説明
os半角数字(6)弊社が発行する識別子

2 処理フロー

本API連携は、大きく分けると4つのフローがございます。

  1. 決済処理を行う
    ログイン → 申込 → (決済完了確認) → ログアウト
  2. QRコード取得を行う
    ログイン → QRコード取得 → (決済完了確認) → ログアウト
  3. 返金処理を行う
    ログイン → 返金 → ログアウト
  4. 決済と伝票を紐付け(任意)
    ログイン → 伝票番号更新 → ログアウト

ログイン/ログアウトについては、API仕様書内の”3章 ログイン“・”4章 ログアウト“をご参照ください。

  • ログイン処理は、毎回必要ではなく初回のみで構いません。
  • 同一の端末識別番号を使用し、複数の端末から重複してログインすることはできません。

2-1 決済処理フロー

API仕様書内の”6章 申込(REQUEST)“・”7章 決済完了確認(PAYCHECK)“・”11章 決済ステータス確認(STATUS)“・”14章 QRコード判定(IDENTIFY-SCANNED-QR-CODE)“をご参照ください。

決済処理フローのイメージ

“決済完了確認”は、エンドユーザーにパスワードが求められた場合など、即決済結果が得られない場合に利用いただくAPIです。
また弊社発行決済番号を使わずに決済の状況を確認される場合は、 “7章 決済完了確認(PAYCHECK)”ではなく”11章 決済 ステータス確認(STATUS)”をご利用ください。
QRコード判定(IDENTIFY-SCANNED-QR-CODE)でスキャンしたQRコードのサービスIDを取得できます。

2-2 QRコード取得処理フロー

API仕様書内の”13章 QRコード取得(GET-QR-CODE)“・”7章 決済完了確認(PAYCHECK)“・”11章 決済ステータス確認(STATUS)“をご参照ください。

QRコード取得処理フローのイメージ

“決済完了確認”は、エンドユーザーにパスワードが求められた場合など、即決済結果が得られない場合に利用いただくAPIです。
また弊社発行決済番号を使わずに決済の状況を確認される場合は、 “7章 決済完了確認(PAYCHECK)”ではなく”11章 決済 ステータス確認(STATUS)”をご利用ください。

2-3 返金処理フロー

API仕様書内の”8章 返金(CANCEL)” をご参照ください。

返金処理フローのイメージ

返金処理には弊社発行の決済番号が必要なため、決済処理フロー内で発行された決済番号を保存していただくことをお勧め いたします。
(別途、弊社提供の管理画面より返金処理を行うことが可能です)

2-4 伝票番号更新処理フロー

API仕様書内の”12章 伝票番号更新(VOUCHERNO)” をご参照ください。

伝票番号更新処理フローのイメージ

伝票番号更新処理には弊社発行の決済番号が必要なため、決済処理フロー内で発行された決済番号を保存していただくこと をお勧めいたします。

3 特筆事項

2-4 伝票番号更新処理 は、必ずしも必要ではありません。