UnivaPay

 QRコード決済 API仕様書

目次

変更履歴

1章 はじめに

1.1 本ドキュメントについて

1.2 著作権と免責事項【重要】

1.3 パラメータ表の見方

2章 導入方法

2.1 接続

2.2 ログイン&ログアウト

2.3 ジョブ種別

3章 ログイン

3.1 概要

3.2 リクエストパラメータ

3.3 処理結果

4章 ログアウト

4.1 概要

4.2 リクエストパラメータ

4.3 処理結果

5章 契約サービス取得処理

5.1 概要

5.2 リクエストパラメータ

5.3 処理結果

6章 申込(REQUEST)

6.1 概要

6.2 接続URL

6.3 リクエストパラメータ

6.4 処理結果

7章 決済完了確認(PAYCHECK)

7.1 概要

7.2 接続URL

7.3 リクエストパラメータ

7.4 処理結果

8章 返金(CANCEL

8.1 概要

8.2 接続URL

8.3 リクエストパラメータ

8.4 処理結果

9章 MPM決済無効化(INVALIDATE-PRESENTED-QR-CODE)

9.1 概要

9.2 接続URL

9.3 リクエストパラメータ

9.4 処理結果

10章 CPM決済無効化(INVALIDATE-SCANNED-QR-CODE)

10.1 概要

10.2 接続URL

10.3 リクエストパラメータ

10.4 処理結果

11章 決済ステータス確認(STATUS)

11.1 概要

11.2 接続URL

11.3 リクエストパラメータ

11.4 処理結果

12章 伝票番号更新(VOUCHERNO)

12.1 概要

12.2 接続URL

12.3 リクエストパラメータ

12.4 処理結果

13章 QRコード取得(GET-QR-CODE)

13.1 概要

13.2 接続URL

13.3 リクエストパラメータ

13.4 処理結果

14章 QRコード判定(IDENTIFY-SCANNED-QR-CODE)

14.1 概要

14.2 接続URL

14.3 リクエストパラメータ

14.4 処理結果

15章 日付指定によるトランザクション履歴取得(LIST-TRANSACTIONS-DAILY)

15.1 概要

15.2 接続URL

15.3 リクエストパラメータ

15.4 処理結果

16章 サービスID 一覧

17章 ウォレット 一覧

18章 エラー一覧

変更履歴
バージョンリリース日内容
1.4.72025/06/06サービスID一覧にAEON Payを追加
1.4.62025/04/24エラーコード一覧にEGWINP0023、EGWINP0024、EGWFMT0017、EGWUKN9999を追加
1.4.52025/04/11ログインのリクエストパラメータのosを半角数(2)から半角数(6)に変更
1.4.42024/12/10ウォレット一覧にKPlus、BigPayMy、BigPaySg、BigPayTh、KaspiKzを追加
1.4.32023/11/14ウォレット一覧にTinaba、NaverPay、TossPay、OCBCBank、 ChangiPay、HiPay、PublicBank、MPayを追加
1.4.22023/05/29ウォレット一覧にHelloMoney、Boostを追加、書式を微修正
1.4.12023/04/21申込(REQUEST)、決済完了確認(PAYCHECK)において例示した処理結果の説明を修正
1.4.02023/02/28サービスID一覧に注釈を追加
サービスID一覧、およびウォレット一覧からBarTongを削除
1.3.92022/08/24申込(REQUEST)、決済完了確認(PAYCHECK)の概要欄を修正
1.3.82022/05/02サービスID一覧、およびウォレット一覧からVIAを削除
ウォレット一覧にSMBCを追加
QRコード取得(GET-QR-CODE)のリクエストパラメータserviceの説明にDBaraiを追加
1.3.72021/07/09決済完了確認(PAYCHECK)、返金(CANCEL)、MPM決済無効化(INVALIDATE-PRESENTED-QR-CODE)、QRコード判定(IDENTIFY-SCANNED-QR-CODE)のレスポンスにおいて例示したJSONを修正
1.3.62021/06/28サービス名称の変更に対応(AlipayConnect → Alipay+)
決済ステータス確認(STATUS)のレスポンスパラメータに注釈を追加
サービスID一覧、ウォレット一覧におけるサービス内容の表記を微修正
サービスID一覧におけるサービス提供状況を最新に更新
例示したJSONを一部修正
1.3.52021/04/14ウォレット一覧に銀行Payのウォレットを追加
QRコード取得(GET-QR-CODE)の対応銘柄にAlipayConnectを追加
QRコード取得(GET-QR-CODE)のリクエストパラメータにvoucherNoを追加
1.3.42021/01/12決済完了確認(PAYCHECK)のリクエストパラメータからserviceIdを削除
エラーコード一覧からEGWINP0007を削除
1.3.32020/10/16CPM決済無効化(INVALIDATE-SCANNED-QR-CODE)のリクエストパラメータからpassCodeを削除
QRコード取得(GET-QR-CODE)の対応銘柄にPayPayを追加
1.3.22020/09/09サービスID一覧におけるサービス提供状況を最新に更新
サービスID一覧からOrigami、NETSPayを削除
サービスID一覧にau PAY、PayPay(M)、d払い(M)、LINE Pay(M)、メルペイ(M)、au PAY(M)、銀行Pay(M)、銀行Payを追加
ウォレット一覧にKplusを追加
レイアウト微修正
1.3.12020/08/21返金(CANCEL)のリクエストパラメータにtransKeyを追加
決済無効化をMPM決済無効化に変更
CPM決済無効化APIを追加
トランザクション履歴取得APIを追加
エラーコード一覧にEGWVLD0012、EGWPAY0004、EGWINP0022、 EGWFMT0014、EGWFMT0015、EGWFMT0016、EGWLNG0013、 EGWLNG0014を追加
1.3.02020/07/28サービス名の表記を修正
サービスID一覧におけるサービス提供状況を最新に更新
1.2.92020/05/14エラーコード一覧にEGWPCN0009、EGWPCN0010、EGWPCN0011、EGWPCN0012、EGWPCN0013を追加
1.2.82020/04/10返金(CANCEL)のレスポンスパラメータを変更
1.2.72020/03/09サービスID 一覧におけるサービス提供状況を最新に更新
QRコード判定の項番を修正
1.2.62020/02/25ウォレット一覧にBarTongの場合を追加
決済ステータス確認(STATUS)のレスポンスパラメータにwalletを追加、jobの内容からREQUEST、PAYCHECK、PARTCANCELを削除、CHARGEBACK、INVALIDATEを追加
決済完了確認(PAYCHECK)のレスポンスパラメータにおいてjobの内容にCHARGEBACK、INVALIDATEを追加
申込(REQUEST)のリクエストパラメータ、およびレスポンスパラメータにvoucherNoを追加
エラーコード一覧において、エラーコードERTM0018の表記が別のエラーコードになっていたのを修正
例示したJSON内の一部記号を修正
1.2.52020/01/20QRコード判定APIを追加
1.2.42020/01/06ウォレット一覧にTrueMoney、DANA、GCash、EZLinkを追加
1.2.32019/12/20ウォレット一覧にTNGを追加
1.2.22019/12/02サービスIDの説明文を追加、文章の誤字を修正
1.2.12019/11/28サービスIDにAlipayConnect(M)、RakutenPay(M)、LINE Pay、メルペイ、NETSPay、UnionPayを追加
1.2.02019/11/19ウォレット一覧にVIAの場合を追加
1.1.92019/11/11サービスIDにBarTong、VIAを追加
1.1.82019/10/28サービスIDにOrigami、JKOPAYを追加
1.1.72019/10/25決済無効化APIを追加
サービスIDにRakutenPayを追加
例示したHTMLフォームのタグの誤記を修正
1.1.62019/09/20契約サービス取得処理の送信先URLの記載を修正
サービスIDにAlipayConnectを追加
Walletの項目を追加
申込(Request)のリクエストパラメータのqrCodeを半角数(30)から半角英数(文字数制限なし)に変更
ウォレットの一覧を追加
例示したHTMLフォームのタグの誤記を修正
1.1.52019/06/13ステータスコード(statusCode)の桁数を変更
エラー一覧の見直し
1.1.42019/05/21契約サービス取得処理、ログイン、ログアウトのURLを変更
1.1.32019/02/08サービスIDにPaypayを追加
1.1.22019/02/06サービスID一覧を追加
1.1.12019/01/23仕様書名称を変更
1.1.02018/12/03決済完了確認(PAYCHECK)に説明を追加
1.0.92018/11/13返金APIを新バージョンに更新、エラーコード表を更新
1.0.82018/08/21レスポンスパラメータを変更
1.0.72018/07/26QRコード取得APIにWechatを追加
1.0.62018/04/13QRコード取得APIを追加
1.0.52018/04/11契約サービス取得処理、ログイン、ログアウトのURLを変更
1.0.42018/02/20端末のIDの名称をTIDに変更(API変更なし)
決済ステータス確認APIを新版に変更
TID桁数の修正
1.0.32018/01/22ログアウトに不要なpasswordパラメーターの削除
1.0.22017/10/04transIdの桁数の修正
1.0.12017/09/27REQUESTのqrCodeパラメーターの最大長を変更(18→30)
1.0.02017/06/08新版作成

1章 はじめに

1.1 本ドキュメントについて

本ドキュメントはHTML,HTTPプロトコルを理解する開発者を対象に作成した、株式会社ユニヴァ・ペイキャストが提供する「Univapay QR決済」のAPI仕様書です。

1.2 著作権と免責事項【重要】

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

TEL:0570-035-672
メール:ips-support@univapay.com

1.3 パラメータ表の見方

必須欄の記号の意味は以下の通りです。

●  :  必須
※  :  備考を参照
✕  :  指定不可(非推奨)

2章 導入方法

2.1 接続

加盟店側で稼働するシステムから決済システムに関連するシステムへ直接通信を行う方式です。
決済システムに関連するシステムへ直接通信を行うため、インターネットへ接続出来る環境が必要になります。
また決済システム及び関連システムはSSLで保護されているため、外部443ポートへ接続出来る環境も必要となります。

2.2 ログイン&ログアウト

端末の認証処理を行う為、端末のログイン&ログアウトが必要になります。
決済する前に必ずその端末で一回ログインしてください。

2.3 ジョブ種別

決済サービスには以下のジョブ種別があります。

以上より決済内容に合わせ、ジョブを選択してください。

3章 ログイン

3.1 概要

端末の認証処理を行います。
ログインがされていない端末からの決済要求は受け付けません。

3.2 リクエストパラメータ

送信先URL: https://bao.ccps.jp/gw/activate

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末のMACアドレスまたはユニーク番号
3password半角英数(4-12)パスワード
4os半角数(6)ユーザーエージェント
* 開発時にサポートセンターへご連絡いただきますと値をご連絡いたします。

<form action="https://bao.ccps.jp/gw/activate" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name="password" value="aaa1111" />
  <input type="hidden" name="os" value="99" />
  <input type="submit" value="ログイン" />
</form>

3.3 処理結果

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数(10)結果コード
0:処理成功 
0以外:処理失敗
2statusMessage全角(60)結果内容
3services配列サービス情報
※servicesパラメータを参照

servicesパラメータ

項目フィールド文字種(桁)説明
1id半角数 (1-2)サービスID
2name全角(80)サービス名
3wallets配列(半角英数(128))ウォレット情報(接続先の支払いサービス)
存在しない場合はnull

例:処理成功の場合

{"services":[{"name":"Alipay","wallets":null,"id":14},{"name":"Alipay(M)","wallets":null,"id":20},{"name":"WeChat Pay","wallets":null,"id":22},{"name":"WeChat Pay(M)","wallets":null,"id":23},{"name":"PayPay","wallets":null,"id":26},{"name":"Alipay+","wallets":["AlipayCN","A lipayHK","KakaoPay"],"id":56}],"statusMessage":"","statusCode":"0"}

例:処理失敗の場合

{"statusCode":"ERTM0001","statusMessage":"TIDを入力してください"}

4章 ログアウト

4.1 概要

ログアウト処理を行います。

4.2 リクエストパラメータ

送信先URL: https://bao.ccps.jp/gw/deactivate

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末のMACアドレスまたはユニーク番号

<form action="https://bao.ccps.jp/gw/deactivate" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="submit" value="ログアウト" />
</form>

4.3 処理結果

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数(10)結果コード
0:処理成功 
0以外:処理失敗
2statusMessage全角(60)結果内容

例:処理成功の場合

{"statusCode":"0","statusMessage":"ログアウト処理に成功しました。"}

例:処理失敗の場合

{"statusCode":"ERTM0001","statusMessage":"TIDを入力してください"}

5章 契約サービス取得処理

5.1 概要

契約サービス情報を取得します。

5.2 リクエストパラメータ

送信先URL: https://bao.ccps.jp/gw/listservice

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末のMACアドレスまたはユニーク番号

<form action="https://bao.ccps.jp/gw/listservice" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="submit" value="サービスリスト" />
</form>

5.3 処理結果   

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数(10)結果コード
0:処理成功
0以外:処理失敗
2statusMessage全角(60)結果内容
3services配列サービス情報
※servicesパラメータを参照

servicesパラメータ

項目フィールド文字種(桁)説明
1id半角数 (2)サービスID
2name全角(80)サービス名
3wallets配列(半角英数( 128))ウォレット情報(接続先の支払いサービス)
存在しない場合はnull

例:処理成功の場合

{"services":[{"name":"Alipay","wallets":null,"id":14},{"name":"Alipay(M)","wallets":null,"id":20},{"name":"WeChatP ay","wallets":null,"id":22},{"name":"WeChat Pay(M)","wallets":null,"id":23},{"name":"PayPay","wallets":null,"id":26},{"name":"Alipay+","wallets":["AlipayCN","A lipayHK","KakaoPay"],"id":56}],"statusMessage":"","statusCode":"0"}

例:処理失敗の場合

{"services":[],"statusCode":"ERTM0001","statusMessage":"TIDを入力してください"}

6章 申込(REQUEST)

6.1 概要

申込処理を行います。
レスポンスパラメータ「job」の値が「REQUEST」の場合は決済が処理中であるため、別途PAYCHECKを使用して決済処理の完了を確認していただく必要があります。

6.2 接続URL

https://bao.ccps.jp/gw/request

6.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3transKey半角英数(34)申請番号 (※ユニーク番号)
4amount半角数(12)決済金額
5qrCode半角英数バーコード内容
6voucherNo半角英数(40) 伝票番号

※1 端末ログイン処理のために使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい

<form action="https://bao.ccps.jp/gw/request" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name="transKey" value="87654321" />
  <input type="hidden" name="amount" value="1000" />
  <input type="hidden" name="qrCode" value="110000000000000000" />
  <input type="submit" value="申込" />
</form>

6.4 処理結果

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数 (10)結果コード
0:処理成功 
0以外:処理失敗
2statusMessage全角(60)結果内容
3transId半角数(10)決済番号
4serviceId半角数(2)サービスID
5job半角英(10)ジョブ種別
REQUEST=申込
CAPTURE=売上
6mid半角数(16-18)TID
7transKey半角英数(34)申請番号 (※ユニーク番号)
8wallet半角英数 (128)ウォレット情報(接続先の支払いサービス)
存在しない場合はnull
9voucherNo半角英数(40)伝票番号
リクエストで伝票番号を指定した場合のみ
指定しなかった場合は、フィールド自体が存在しない

例:処理成功の場合(ウォレット情報なし)

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"14","job":"CAPTURE","mid":"12345678 9012345", "transKey":"87654321", "wallet":null}

例:処理成功の場合(ウォレット情報あり)

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"56","job":"CAPTURE","mid":"12345678 9012345", "transKey":"87654321", "wallet":"AlipayCN"}

例:処理中の場合

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"14","job":"REQUEST","mid":"12345678 9012345", "transKey":"87654321", "wallet":null}

例:処理成功の場合(伝票番号あり)

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"14","job":"CAPTURE","mid":"12345678 9012345", "transKey":"87654321", "wallet":null, voucherNo:"0000000"}

例:処理失敗の場合

{"statusCode":"ERGW0001","statusMessage":"TIDを入力してください","serviceId":"14", "job":"REQUEST", "mid": "123456789012345", "transKey":"87654321"}

7章 決済完了確認(PAYCHECK)

7.1 概要

決済処理が完了したかどうかの確認処理です。
通常、加盟店様側で構築いただく場合には、レスポンスパラメータ「job」の値が「REQUEST」以外になるまで継続的に確認を行っていただきます。

7.2 接続URL

https://bao.ccps.jp/gw/paycheck

7.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3transId半角数(10)決済番号

※1 端末ログイン処理のために使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい。

<form action="https://bao.ccps.jp/gw/paycheck" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name="transId" value="123456789" />
  <input type="submit" value="決済完了確認" />
</form>

7.4 処理結果

処理結果はJSON形式です。

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数 (10)結果コード
0:処理成功
0以外:処理失敗
2statusMessage全角(60)結果内容
3transId半角数(10)決済番号
4serviceId半角数(2)サービスID
5job半角英(10)ジョブ種別
REQUEST=申込
CAPTURE=売上
CANCEL=返金
CHARGEBACK= チャージバック
INVALIDATE=無効化
6mid半角数(16-18)TID
7wallet半角英数 (10)ウォレット情報

例:処理成功の場合(ウォレット情報なし)

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"14","job":"CAPTURE","mid":"12345678 9012345","wallet":null}

例:処理成功の場合(ウォレット情報あり)

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"56","job":"CAPTURE","mid":"12345678 9012345","wallet":"KakaoPay"}

例:処理中の場合

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"14","job":"REQUEST","mid":"12345678 9012345","wallet":null}

例:処理失敗の場合

{"statusCode":"ERGW0001","statusMessage":"TIDを入力してください","serviceId":"14","job":"PAYCHECK", "mid": "123456789012345"}

8章 返金(CANCEL)

8.1 概要

返金処理を行います。

8.2 接続URL

https://bao.ccps.jp/gw/cancel2

8.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3transId半角数(10)決済番号※ [transKey]が空白の場合、必須になります
4transKey半角英数(34)申請番号※ [transId]が空白の場合、必須になります
5passCode半角数(4)返金パスワード

※1 端末ログイン処理のために使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい。

<form action=" https://bao.ccps.jp/gw/cancel2" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name="transId" value="123456789" />
  <input type="hidden" name="passCode" value="0000" />
  <input type="submit" value="返金" />
</form>

8.4 処理結果

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数 (10)結果コード
0:処理成功
0以外:処理失敗
2statusMessage全角(60)結果内容
3transId半角数(10)決済番号
4job半角英(10)ジョブ種別
CANCEL=返金
5mid半角数(16-18)TID
6serviceId半角数(2)サービスID
7wallet半角英数(128)ウォレット情報(接続先の支払いサービス)
存在しない場合はnull

例:処理成功の場合(ウォレット情報なし)

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"14","job":"CANCEL","mid":"123456789 012345",”wallet”:null}

例:処理成功の場合(ウォレット情報あり)

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"62","job":"CANCEL","mid":"123456789 012345",”wallet”:”Liiv”}

例:処理失敗の場合

{"statusCode":"ERGW0001","statusMessage":"TIDを入力してください","serviceId":"14","job":"CANCEL",	"mid": "123456789012345","wallet":null}

9章 MPM決済無効化(INVALIDATE-PRESENTED-QR-CODE)

9.1 概要

決済の無効化を行います。
このAPIは、店舗側がQRコードを表示する決済に限り使用可能です。
また、処理が未完了の決済にのみ使用可能です。処理が完了した決済には使用できません。

9.2 接続URL

https://bao.ccps.jp/gw/invalidate-presented-qr-code

9.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3transId半角数(10)決済番号

※1 端末ログイン処理のために使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい。

<form action=" https://bao.ccps.jp/gw/invalidate-presented-qr-code" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name="transId" value="123456789" />
  <input type="submit" value="無効化" />
</form>

9.4 処理結果

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数 (10)結果コード
0:処理成功
0以外:処理失敗
2statusMessage全角(60)結果内容
3transId半角数(10)決済番号
4job半角英(10)ジョブ種別
INVALIDATE=無効化
5mid半角数(16-18)TID
6serviceId半角数(2)サービスID

例:処理成功の場合

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"20","job":"INVALIDATE","mid":"123456789012345"}

例:処理失敗の場合

{"statusCode":"EGWPAY0001","statusMessage":"決済状態エラー","serviceId":"20","job":"INVALIDATE",	"mid": "123456789012345"}

10章 CPM決済無効化(INVALIDATE-SCANNED-QR-CODE)

10.1 概要

決済の無効化を行います。
このAPIは、エンドユーザー側がQRコードを表示する決済(CPM)に限り使用可能です。
また、このAPIはCANCELとは異なり、対象決済のステータス(処理中、成功、失敗)に関わらず使用することができます。
処理中の決済に対してこのAPIを呼び出し、その後に決済処理が完了してステータスが成功になった場合、その決済は自動的に返金されます。
そのため、REQUESTの結果が不明な場合にこのAPIを使用し、その後にあらためてREQUESTを使用するといった使い方が可能です。

決済は[transId]または[transKey]によって無効化できます。[transId]の代わりに[transKey]が送信された場合、[transKey]は使用済みとして登録され、後続のREQUESTはEGWVLD0005として失敗します。

無効化の制限時間はREQUESTを呼び出してから10分間です。
制限時間を超えた決済に対してこのAPIを使用することはできません。
制限時間を超え、かつ成功している決済に対しては、CANCELを使用して通常の返金処理をしてください。

10.2 接続URL

https://bao.ccps.jp/gw/invalidate-scanned-qr-code

10.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3transId半角数(10)決済番号※ [transKey]が空白の場合、必須になります
4transKey半角英数(34)申請番号※ [transId]が空白の場合、必須になります

※1 端末ログイン処理のために使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい。

<form action="https://bao.ccps.jp/gw/invalidate-scanned-qr-code" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name="transId" value="87654321" />
  <input type="submit" value="無効化" />
</form>

10.4 処理結果

処理結果はJSON形式です

レスポンスの形式

項目フィールド文字種説明
1statusCode半角英数 (10)結果コード
0:処理成功
0以外:処理失敗
2statusMessage全角(60)結果内容
3mid半角数(16-18)TID
4exists論理値送信された[transId]または[transKey]による決済があるかどうか
5transId半角数(18)決済番号
6serviceId半角数(2)サービスID
7wallet半角英数 (10)ウォレット情報

例:決済が登録されている、処理成功の場合

{
  "statusMessage": "",
  "statusCode": "0", "exists": true, "transId": 250,
  "mid": 10000,
  "serviceId": 99, "wallet": null,
  "job": "INVALIDATE"
}

例:決済が登録されてない、「決済番号」を送信の場合

{
  "statusMessage": "決済番号が存在していません。", "statusCode": "EGWVLD0009"
}

例:決済が登録されてない、「申請番号」を送信の場合

{
  "statusMessage": "",
  "statusCode": "0", "exists": false, "transId": null,
  "mid": 982000000041041066,
  "serviceId": null, "wallet": null,
  "job": "INVALIDATE"
}

11章 決済ステータス確認(STATUS)

11.1 概要

決済状態の確認を行います。

11.2 接続URL

https://bao.ccps.jp/gw/statusquery2

11.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3transKey半角英数(34)申請番号

※1 端末ログイン処理のために使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい。

<input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name="transKey" value="87654321" />
  <input type="submit" value="決済ステータス確認" />
</form>

11.4 処理結果

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数 (10)結果コード
0:処理成功
0以外:処理失敗  ※処理結果の成否です。
2statusMessage全角(60)結果内容
3transId半角数(10)決済番号
4serviceId半角数(2)サービスID
5wallet半角英数(128)ウォレット情報(接続先の支払いサービス)
存在しない場合はnull
6job半角英(10)ジョブ種別
CAPTURE=売上
CANCEL=返金
CHARGEBACK=チャージバック
INVALIDATE=無効化
7mid半角数(16-18)TID
8jobStatusCode半角英数 (10)0:決済成功
1:処理中
それ以外: 決済失敗
※決済状態の結果取得処理です。

例:ステータス成功の場合(ウォレット情報なし)

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"14","wallet":null,"job":"CAPTURE","mid":"123456789012345", "jobStatusCode":"0"}

例:ステータス成功の場合(ウォレット情報あり)

{"statusCode":"0","statusMessage":"","transId":"123456789","serviceId":"62","wallet":"Liiv","job":"CAPTURE","mi d":"123456789012345", "jobStatusCode":"0"}

例:ステータス失敗の場合

{"statusCode":"0","statusMessage":"","serviceId":"14","wallet":null,"job":"CAPTURE","mid":"123456789012345"," jobStatusCode":"ERGW0010"}

12章 伝票番号更新(VOUCHERNO)

12.1 概要

伝票番号の更新を行います。

12.2 接続URL

https://bao.ccps.jp/gw/voucherno

12.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3transId半角数(10)決済番号
4voucherNo半角英数(40)伝票番号

※1 端末ログイン処理のために使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい。

<form action="https://bao.ccps.jp/gw/voucherno" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name=" transId" value="1234567" />
  <input type="hidden" name=" voucherNo" value="V1234567" />
  <input type="submit" value="伝票番号更新" />
</form>

12.4 処理結果

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数 (10)結果コード
0:処理成功 
0 以外:処理失敗
2statusMessage全角(60)結果内容

例:処理成功の場合

{"statusCode":"0","statusMessage":""}

例:処理失敗の場合

{"statusCode":"EGWINP0001","statusMessage":" TIDを入力してください"}

13章 QRコード取得(GET-QR-CODE)

13.1 概要

店舗側がQRコードを表示して決済する場合のQRコードを取得します。決済結果の取得はPAYCHECKを利用してください。

13.2 接続URL

https://bao.ccps.jp/gw/get-qr-code

13.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3amount半角数(12)決済金額
4service半角英(128)決済種別 Alipay/Wechat/PayPay/Alipay+
5voucherNo半角英数(40) 伝票番号

※1 端末ログイン処理に使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい。

<form action="https://bao.ccps.jp/gw/get-qr-code" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name=" amount" value="100" />
  <input type="hidden" name=" service" value="Alipay" />
  <input type="submit" value="QRコード取得" />
</form>

13.4 処理結果

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1statusCode半角英数 (10)結果コード
0:処理成功
0以外:処理失敗
2statusMessage全角(60)結果内容
3transId半角数(10)決済番号。PAYCHECK等で使用。
4qrCodeValue半角(100)QRコードを自身で生成する場合は、この文字列をQRコードにする。
5imageUrl半角(100)QRコードを自身で生成しない場合は、この画像を利用する。
6serviceId半角数(2)サービスID。PAYCHECK等で使用。

例:処理成功の場合

{"statusCode":"0","statusMessage":"","transId":12345678,"qrCodeValue":"https://qr.alipay.com/abcdefghijklmn1234567890","imageUrl":"https://mobilecodec.alipay.com/show.htm?code=abcdefghijklmn1234567890"}

例:処理失敗の場合

{"statusCode":"EGWINP0001","statusMessage":" TIDを入力してください"}

14章 QRコード判定(IDENTIFY-SCANNED-QR-CODE)

14.1 概要

QRコードがどのサービスのものであるかを判別します。
サービスに応じてUnivapay利用の要否が変わるなどの場合は、まずこのAPIを使用してサービスを判定してください。
なお、AlipayとAlipay+のQRコード形式は同一であるため、店舗の設定によって結果が異なります。Alipay+t設定が有効の場合はAlipay+、無効の場合はAlipayと判定されます。

14.2 接続URL

https://bao.ccps.jp/gw/identify-scanned-qr-code

14.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3qrCode半角英数QRコード内容

※1 端末ログイン処理に使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい。

<form action="https://bao.ccps.jp/gw/identify-scanned-qr-code" method="post">
  <input type="hidden" name="mid" value="123456789012345" />
  <input type="hidden" name="key" value="12345678" />
  <input type="hidden" name="qrCode" value="110000000000000000" />
  <input type="submit" value="QRコード判定" />
</form>

14.4 処理結果

処理結果はJSON形式です

レスポンスパラメータ

項目フィールド文字種(桁)説明
1mid半角数(16-18)TID
2serviceId半角数(2)サービスID
3wallet半角英数(128)ウォレット情報(接続先の支払いサービス)
存在しない場合はnull

例:ウォレット情報がある場合

{"statusCode":"0","statusMessage":"","wallet":"Dash","serviceId":66,"mid":10000000}

例:ウォレット情報がない場合

{"statusCode":"0","statusMessage":"","wallet":null,"serviceId":14,"mid":10000000}

例:不明なQRコードの場合

{"statusMessage":"QRコード自動判別出来ません。","statusCode":"EGWRQT0001"}

15章 日付指定によるトランザクション履歴取得(LIST-TRANSACTIONS-DAILY)

15.1 概要

指定した日付のトランザクション履歴を取得します。
ページネーションにより、件数が多い場合は分割して取得されます。

15.2 接続URL

https://bao.ccps.jp/gw/list-transactions/daily

15.3 リクエストパラメータ

HTTP GETまたはPOST方式で以下を送信

項目フィールド文字種(桁)必須説 明
1mid半角数(16-18)TID
2key半角英数(50)端末キー ※1
3date日付 (10)取得対象の日付
パータン YYYY-MM-DD
4pageSize半角数 1ページあたりの取得件数
最大値は250、デフォルトは100です。
5page半角数 取得対象のページ
デフォルトは1

※1 端末ログイン処理のために使用した、端末のMAC アドレスまたはユニーク番号を指定してく ださい。

curl --location --request POST 'https://bao.ccps.jp/gw/list-transactions/daily' \
--form 'mid=TERMINAL_ID' \
--form 'key=TERMINAL_KEY' \
--form 'date=2020-06-24' \
--form 'pageSize=250' \
--form 'page=1'

15.4 処理結果

処理結果はJSON形式です

4.1 レスポンスの形式

項目フィールド文字種(桁)説明
1statusCode半角英数 (10)結果コード
0:処理成功
0以外:処理失敗
2statusMessage全角(60)結果内容
3totalPages半角数 (18)総ページ数
4currentPage半角数 (18)現在の取得のページ
5records配列※4.2 「records」を参照

4.2「records」のオブジェクト形式

項目フィールド文字種説明
1transId半角数(10)決済番号
2transKey半角英数(34)申請番号
3job半角英(10)ジョブ種別
CAPTURE=売上
CANCEL=返金
CHARGEBACK=チャージバック
INVALIDATE=無効化
4amount半角数(12)決済金額
5statusCode半角英数 (10)トランザクションの結果コード
0:決済成功 
1:処理中
それ以外:決済失敗
6serviceId半角数(2)サービスID
7wallet半角英数 (128)ウォレット情報(接続先の支払いサービス)
存在しない場合はnull
8transDateTime日付時刻 (27)決済日時
パータン YYYY-MM-DDTHH:mm:ss.sssZ

例:処理成功の場合

{
  "records": [
    {
    "transKey": "1592991393Wtyz", "transId": 20039679,
    "amount": 1,
    "job": "CAPTURE",
    "statusCode": "0",
    "serviceId": 66, "wallet": "GlobalPay",
    "transDateTime": "2020-06-24T18:37:20+09:00"
    },
    {
    "transKey": "1592987700z26i", "transId": 20039678,
    "amount": 1, "job": "CANCEL",
    "statusCode": "0",
    "serviceId": 99, "wallet": null,
    "transDateTime": "2020-06-24T17:35:34+09:00"
    },
    {
    "transKey": "1592987695xpqo",
    "transId": 20039677,
    "amount": 1,
    "job": "CAPTURE",
    "statusCode": "0",
    "serviceId": 99, "wallet": null,
    "transDateTime": "2020-06-24T17:34:56+09:00"
    }
  ],
  "totalPages": 4,
  "currentPage": 1, "statusMessage": "",
  "statusCode": "0"
}

例:処理失敗の場合

{
  "statusMessage": "端末IDが見つかりません。",
  "statusCode": "EGWVLD0001"
}

16章 サービスID 一覧

サービスIDサービス内容
14Alipay決済
20Alipay(M)決済
22WeChat Pay決済
23WeChat Pay(M)決済
24d払い決済
26PayPay決済
56Alipay+決済
57JKOPAY決済
58RakutenPay決済
59Alipay+(M)決済
60RakutenPay(M)決済 ※1
61LINE Pay決済 ※2
63メルペイ決済
65UnionPay決済 ※1
67au PAY決済
68PayPay(M)決済
69d払い(M)決済 ※1
70LINE Pay(M)決済 ※1
71メルペイ(M)決済 ※1
72au PAY(M)決済 ※1
73銀行Pay(M)決済 ※1
74銀行Pay決済
75AEON Pay決済
99テスト決済 ※3

※1 現在準備中の銘柄で、決済サービスの開始が、各銘柄側都合により遅延・中止される可能性があります。システム連携をされる場合はその旨をご承知おきの上、仕様をご検討ください。
なお、その場合、当社では一切の責任を負いかねます。

※2 LINE Payは2025年4月30日をもってサービスを終了しております。

※3 管理画面に掲載しているテストQRコードは利用可能な状態で提供しております。
受付拒否へ変更を希望する場合は弊社へご連絡ください。

17章 ウォレット 一覧

Alipay+の場合

Walletサービス内容
AlipayCNAlipay(中国)
AlipayHKAlipay(香港)
AlipaySGAlipay(シンガポール)
KakaoPayKakaoPay
TNGTouch ’n Go
TrueMoneyTrueMoney
DANADANA
GCashGCash
EZLinkEZ-Link
HelloMoneyHelloMoney
BoostBoost
TinabaTinaba
NaverPayNaverPay
TossPayTossPay
OCBCBankOCBC Bank
ChangiPayChangiPay
HiPayHiPay
PublicBankPublic Bank
MPayMPay
KPlusK PLUS
BigPayMyBigPay(マレーシア)
BigPaySgBigPay(シンガポール)
BigPayThBigPay(タイ)
KaspiKzKaspi.kz

銀行Payの場合

Walletサービス内容
YuchoPayゆうちょPay(ゆうちょ銀行)
HamaPayはまPay(横浜銀行)
OKI PayOKI Pay(沖縄銀行)
YOKA!Pay (Fukuoka)YOKA!Pay(福岡銀行)
YOKA!Pay (Kumamoto)YOKA!Pay(熊本銀行)
YOKA!Pay (Shinwa)YOKA!Pay(親和銀行)
HokuHokuPay (Hokkaido)ほくほくPay(北海道銀行)
HokuHokuPay (Hokuriku)ほくほくPay(北陸銀行)
COIPAY (Hiroshima)こいPay(広島銀行)
SMBCSMBC(三井住友銀行)

18章 エラー一覧

エラーコードエラー内容
EGWINP0001TIDを入力してください
EGWINP0002キーを入力してください
EGWINP0003申請番号を入力してください
EGWINP0004金額を入力してください
EGWINP0005QRコードを入力してください
EGWINP0006決済番号を入力してください
EGWINP0008伝票番号を入力してください
EGWINP0009返金パスワードを入力してください
EGWINP0010開始日時を入力してください
EGWINP0011終了日時を入力してください
EGWINP0012クライアントログを入力してください
EGWINP0013パスワードを入力してください
EGWINP0014OS値を設定してください
EGWINP0015ショップIDを設定してください
EGWINP0016サービスを入力してください
EGWINP0017pidを入力してください
EGWINP0018rstを入力してください
EGWINP0019ecを入力してください
EGWINP0020taを入力してください
EGWINP0021jobを入力してください
EGWINP0022dateを入力してください
EGWINP0023startTimeを入力してください
EGWINP0024デバイストークンを入力してください
EGWVLD0001TIDが見つかりません
EGWVLD0002キーは一致しません
EGWVLD0003端末のステータスは停止中です
EGWVLD0004ジョブタイプ名(店舗送信名)関連エラー
EGWVLD0005申請番号が存在しています
EGWVLD0006申請番号が存在していません
EGWVLD0007決済IDが空です
EGWVLD0008ジョブ名が空です
EGWVLD0009決済IDが存在していません
EGWVLD0010決済詳細データが存在しています
EGWVLD0011返金の認証処理に失敗しました
EGWVLD0012無効化不可能、時間制限を超えました
EGWRDB0001「GW」申請番号登録処理に失敗しました
EGWPCN0003決済サーバー応答不正
EGWPCN0004決済状態確認エラー
EGWPCN0005その他決済サーバーからのエラー
EGWPCN0009身分証が未登録のため海外決済できません。
EGWPCN0010電話番号が未登録のため海外決済ができません。
EGWPCN0011 お客様が該当の銘柄で紐づけされている支払・チャージ方法では決済できません
EGWPCN0012接続先リスク拒否エラー
EGWPCN0013 時間内にユーザーの承認が得られませんでした。再度お手続きください。
EGWPCN0099決済サーバー通信エラー
EGWMID0001MIDが登録されていません
EGWMCC0001MCCが登録されていません
EGWSID0001未対応操作
EGWRDB0099データベース処理に失敗しました
EGWCON0001契約なし
EGWRQT0001QRコード自動判別出来ません
EGWRQT0002QRコード期限切れ
EGWRQT0003QRコード使用済み
EGWAPI0001APIバージョンエラー
EGWPAY0001重複返金要求等の決済状態エラー
EGWPAY0002店舗の金額制限エラー
EGWPAY0003重複決済
EGWPAY0004決済が無効化されました
EGWCRD0001クレジットカードエラー(カード番号)
EGWCRD0002クレジットカードエラー(有効期限)
EGWCRD0004クレジットカードエラー(有効期限切れ)
EGWCRD0005クレジットカードエラー(セキュリティコード)
EGWCRD0006クレジットカードエラー(カード拒否)
EGWCRD0007クレジットカードエラー(カード)
EGWCRD0008クレジットカードエラー(カードデータ)
EGWCRD0009クレジットカードエラー(ユーザーデータ)
EGWCRD0010クレジットカードエラー(課金過多)
EGWCRD0011クレジットカードエラー(盗難)
EGWCRD0012クレジットカードエラー(要カード発行会社へ問い合わせ)
EGWCRD0013クレジットカードエラー(姓)
EGWCRD0014クレジットカードエラー(カードロック)
EGWCRD0015クレジットカードエラー(セキュリティコード不足)
EGWCRD0016クレジットカードエラー(カードブランド未対応)
EGWCRD0017クレジットカードエラー(カード発行国未対応)
EGWCRD0018クレジットカードエラー(電話番号)
EGWCRD0019クレジットカード/銀行エラー
EGWUSR0001ユーザー残高不足
EGWFMT0001端末IDの入力に誤りがあります
EGWFMT0002金額の入力に誤りがあります
EGWFMT0004決済番号の入力に誤りがあります
EGWFMT0005サービスIDの入力に誤りがあります
EGWFMT0006返金パスワードの入力に誤りがあります
EGWFMT0007開始日時の入力に誤りがあります
EGWFMT0008終了日時の入力に誤りがあります
EGWFMT0009ステータスの入力に誤りがあります
EGWFMT0010最大取得件数の入力に誤りがあります
EGWFMT0011処理の入力に誤りがあります
EGWFMT0012OSの入力に誤りがあります
EGWFMT0013サービスの入力に誤りがあります
EGWFMT0014dateの入力に誤りがあります
EGWFMT0015pageSizeの入力に誤りがあります
EGWFMT0016pageの入力に誤りがあります
EGWFMT0017startTimeの入力に誤りがあります
EGWLNG0001[端末ID]最大文字数を超過しています
EGWLNG0002[キー]最大文字数を超過しています
EGWLNG0003[申請番号]最大文字数を超過しています
EGWLNG0004[金額]最大文字数を超過しています
EGWLNG0006[決済番号]最大文字数を超過しています
EGWLNG0007[サービスID]最大文字数を超過しています
EGWLNG0008[伝票番号]最大文字数を超過しています
EGWLNG0009[返金パスワード]最大文字数を超過しています
EGWLNG0010[最大取得件数]最大文字数を超過しています
EGWLNG0011[OS]値が不正です
EGWLNG0012[パスワード]最大文字数を超過しています
EGWLNG0013[pageSize]が値が許容範囲外です。確認してください。
EGWLNG0014[page]が値が許容範囲外です。確認してください
EGWPCN0002決済システムのエラー
EGWPCN0006接続先での通信エラー
EGWPCN0007接続先のパラメーターエラー
EGWPCN0008接続先のパラメーターエラー
ERTM0001TIDを入力してください
ERTM0002キーを入力してください
ERTM0003パスワードを入力してください
ERTM0004OS値を設定してください
ERTM0005TIDが見つけられません
ERTM0006パスワードは一致しません
ERTM0007キーは使用中です
ERTM0008TIDは使用中です
ERTM0009ステータスは停止中です
ERTM0010データベース処理に失敗しました
ERTM0011キーは一致しません
ERTM0012TIDは英数入力項目です
ERTM0013OSは英数入力項目です
ERTM0014端末は未使用です
ERTM0016[TID]最大文字数を超過しています
ERTM0017[キー]最大文字数を超過しています
ERTM0018[OS]最大文字数を超過しています
EGWUKN9999システムエラー