インターフェース仕様
提供機能のインターフェース項目定義は以下のとおりです。
要求項目定義
機能 ID | B01-1, C01-1 |
---|---|
処理名 | B01-1:顧客決済情報登録・更新要求 C01-1:顧客決済情報削除要求 |
流れ | 加盟店→当社 |
接続先 | B01-1:サービス開始時ご案内 C01-1:サービス開始時ご案内 |
---|---|
送信メソッド | Form POST |
送信文字コード | Shift-JIS, html / text |
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)
※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義 を参照ください。
SEQ | タグエレメント名 | 項目名 | 桁数 | 型 | 必須 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|---|---|
1 | pay_method | 支払方法 | 1000 | X | 可変 | credit:クレジットカード決済 credit3d2:クレジットカード決済 (本人認証サービス (EMV 3-D セキュア)) tpoint:T ポイントプログラム (オンライン決済) accttransfer:(口座振替サービス) | 支払方法を指定します。(複数指定可) ※省略時または複数指定時は当社にて決済選択画面を表示します。 ※複数指定時はカンマ区切りでご指定下さい。 | |
2 | merchant_id | マーチャント ID | 5 | 9 | ○ | 固定 | 加盟店を識別する ID | 当社で払い出します。 |
3 | service_id | サービス ID | 3 | 9 | ○ | 固定 | 加盟店のサービスを識別する ID | 当社で払い出します。 |
4 | cust_code | 顧客 ID | 64 | X | ○ | 可変 | 加盟店にて管理されている顧客 ID | マーチャント ID とサービス ID の組み合わせに対してユニーク(一意)な値としてください。 決済情報保管時の紐付けキーとなるため、必ず顧客別に払い出してください。 |
5 | sps_cust_no | SBPS 顧客 ID | 12 | 9 | △ | 固定 | 当社で管理する顧客 ID | SBPS 支払方法管理番号が設定された場合は必須で指定となります。 |
6 | sps_payment_no | SBPS 支払方法管理番号 | 3 | 9 | △ | 固定 | 当社で管理する支払方法管理番号 | SBPS 顧客 ID が設定された場合は必須で指定となります。 |
7 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 0:PC 1:モバイル | 省略の場合”0″を設定します。(PC、携帯端末の識別) | |
8 | success_url | 登録完了時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
9 | cancel_url | 登録キャンセル時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
10 | error_url | 登録エラー時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
11 | pagecon_url | 登録通知先 CGI | 500 | X | ○ | 可変 | 結果通知先 URL | SSL 通信必須 |
12 | free1 | 自由欄1 | 20 | M | 可変 | 日本語、英数半角混在可能です。 文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
13 | free2 | 自由欄2 | 20 | M | 可変 | 日本語、英数半角混在可能です。 文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
14 | free3 | 自由欄3 | 20 | M | 可変 | 日本語、英数半角混在可能です。 文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
15 | free_csv | フリー項目 | 4000 | M | 可変 | 決済固有タグ「free_csv」についてを参照ください。 | ||
16 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | YYYYMMDDHHMISS | 本機能を加盟店がリクエストした日時です。 |
17 | limit_second | リクエスト許容時間 | 4 | 9 | 可変 | 当社サーバのタイムスタンプとリクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 | |
18 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
結果 CGI 項目定義
機能 ID | B02-1, C02-1 |
---|---|
処理名 | B02-1:顧客決済情報登録・更新結果CGI C02-1:顧客決済情報削除結果CGI |
流れ | 当社→加盟店 |
接続先 | 指定(または事前設定)された URL(結果通知用CGI) |
---|---|
送信メソッド | HTTP POST |
送信文字コード | Shift-JIS |
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)
※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義 を参照ください。
SEQ | タグエレメント名 | 項目名 | 桁数 | 型 | 必須 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|---|---|
1 | pay_method | 支払方法 | 1000 | X | 可変 | リクエスト時の内容 | ||
2 | merchant_id | マーチャント ID | 5 | 9 | ○ | 固定 | 〃 | |
3 | service_id | サービス ID | 3 | 9 | ○ | 固定 | 〃 | |
4 | cust_code | 顧客 ID | 64 | X | ○ | 可変 | 〃 | |
5 | sps_cust_no | SBPS 顧客 ID | 12 | 9 | 固定 | 〃 | ||
6 | sps_payment_no | SBPS 支払方法管理番号 | 3 | 9 | 固定 | 〃 | ||
7 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 〃 | ||
8 | free1 | 自由欄1 | 20 | M | 可変 | 〃 | ||
9 | free2 | 自由欄2 | 20 | M | 可変 | 〃 | ||
10 | free3 | 自由欄3 | 20 | M | 可変 | 〃 | ||
11 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | 〃 | |
結果返却時にセットされる項目 | ||||||||
12 | res_pay_method | 処理結果 支払方法 | 20 | X | ○ | 可変 | 顧客決済情報登録/削除要求時に 選択された支払方法です。 | |
13 | res_result | 処理結果ステータス | 2 | X | ○ | 固定 | OK:登録処理完了 CN:削除処理完了 NG:処理 NG | 顧客決済情報削除要求処理にて削除処理正常完了の場合、処 理結果ステータス=CN(削除処理完了)が返却されます。 顧客決済情報登録/削除要求時には、処理結果ステータス= NG(処理 NG)は返却されません。 |
14 | res_sps_cust_no | 処理 SBPS 顧客 ID | 12 | 9 | △ | 固定 | 当社で管理する顧客 ID | 処理 OK 時のみ返却します。 |
15 | res_sps_payment_no | 処理 SBPS 支払方法管理番号 | 3 | 9 | △ | 固定 | 当社で管理する支払方法管理番号 | 処理 OK 時のみ返却します。 |
16 | res_payinfo_key | 顧客決済情報の識別キー | 32 | X | 固定 | 顧客決済情報を識別するキー | 処理結果ステータスが OK の場合のみ、返却します。 クレジットカード決済: カード番号を元にしたSBPS独自の演算によるハッシュ値(頭0補完 16 桁) T ポイントプログラム(オンライン決済):無し | |
17 | res_err_code | エラーコード | 4 | X | 可変 | エラーコード一覧参照 | ||
18 | res_date | レスポンス日時 | 14 | 9 | ○ | 可変 | YYYYMMDDHHMISS | 当社がレスポンスした日時です。 |
19 | limit_second | レスポンス許容時間 | 4 | 9 | ○ | 可変 | 当社サーバのタイムスタンプと リクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 |
20 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
結果 CGI レスポンス項目定義
機能 ID | B02-2, C02-2 |
---|---|
処理名 | B02-2:顧客決済情報登録・更新結果 CGI レスポンス C02-2:顧客決済情報削除結果 CGI レスポンス |
流れ | 加盟店→当社 |
接続先 | 各結果CGI の通知元 |
---|---|
送信メソッド | HTTP POST |
送信文字コード | Shift-JIS, text/csv |
HTTP ステータス 200 であれば OK として、HTTP ステータス 200 以外のステータスであれば NG とします。なお、NG の場合でも、当社への処理が完了しています。画面の遷移は、指定のエラー画面へ遷移します。
加盟店からレスポンス NG が返却された場合でも HTTP ステータス 200 が優先され、処理完了としていますので、ご注意ください。
結果(画面返却)項目定義
機能 ID | B03-1, C03-1 |
---|---|
処理名 | B03-1:顧客決済情報登録・更新結果(画面返却) C03-1:顧客決済情報削除結果(画面返却) |
流れ | 当社→加盟店 |
接続先 | 指定(または事前設定)されたURL(結果通知用CGI) |
---|---|
送信メソッド | Form POST |
送信文字コード | Shift-JIS, html / text |
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)
※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義 を参照ください。
SEQ | タグエレメント名 | 項目名 | 桁数 | 型 | 必須 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|---|---|
1 | pay_method | 支払方法 | 1000 | X | 可変 | リクエスト時の内容 | ||
2 | merchant_id | マーチャント ID | 5 | 9 | ○ | 固定 | 〃 | |
3 | service_id | サービス ID | 3 | 9 | ○ | 固定 | 〃 | |
4 | cust_code | 顧客 ID | 64 | X | ○ | 可変 | 〃 | |
5 | sps_cust_no | SBPS 顧客 ID | 12 | 9 | 固定 | 〃 | ||
6 | sps_payment_no | SBPS 支払方法管理番号 | 3 | 9 | 固定 | 〃 | ||
7 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 〃 | ||
8 | free1 | 自由欄1 | 20 | M | 可変 | 〃 | ||
9 | free2 | 自由欄2 | 20 | M | 可変 | 〃 | ||
10 | free3 | 自由欄3 | 20 | M | 可変 | 〃 | ||
11 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | 〃 | |
結果返却時にセットされる項目 | ||||||||
12 | res_pay_method | 処理結果 支払方法 | 20 | X | ○ | 可変 | 決済情報登録時に選択された支払方法です。 | |
13 | res_result | 処理結果ステータス | 2 | X | ○ | 固定 | OK:登録処理完了 CN:削除処理完了 NG:処理 NG | 顧客決済情報削除要求処理にて削除処理正常完了の場合、 処理結果ステータス=CN(削除処理完了)が返却されます。 顧客決済情報登録/削除要求時には、 処理結果ステータス= NG(処理 NG)は返却されません。 |
14 | res_sps_cust_no | 処理 SBPS 顧客 ID | 12 | 9 | △ | 固定 | 当社で管理する顧客 ID | 処理 OK 時のみ返却します。 |
15 | res_sps_payment_no | 処理 SBPS 支払方法管理番号 | 3 | 9 | △ | 固定 | 当社で管理する支払方法管理番号 | 処理 OK 時のみ返却します。 |
16 | res_payinfo_key | 顧客決済情報の識別キー | 32 | X | 固定 | 顧客決済情報を識別するキー | 処理結果ステータスが OK の場合のみ、返却します。 クレジットカード決済:カード番号を元にしたSBPS独自の演算によるハッシュ値(頭0補完 16 桁) T ポイントプログラム(オンライン決済):無し | |
17 | res_err_code | エラーコード | 4 | X | 可変 | エラーコード一覧参照 | ||
18 | res_date | レスポンス日時 | 14 | 9 | ○ | 可変 | YYYYMMDDHHMISS | 当社がレスポンスした日時です。 |
19 | limit_second | レスポンス許容時間 | 4 | 9 | ○ | 可変 | 当社サーバのタイムスタンプとリクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 |
20 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
個別仕様
決済固有タグ「free_csv」について
クレジットカード決済(本人認証サービス(EMV 3-Dセキュア))
リンク型のクレジットカード決済(本人認証サービス(EMV 3-Dセキュア))で本人認証に必要な設定ができます。
使用方法
《使用API》
接続方式 | API 種別 | データの流れ |
---|---|---|
リンク型 | 購入要求 | 加盟店→当社 |
《設定エレメント》
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)※使用できる文字の詳細は、リンク型システム仕様書(基本仕様)を参照ください。
タグエレメント名 | 項目名 | 桁数 | 型 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|
free_csv | 自由欄(CSV 形式) | 4000 | M | 可変 | 以下の設定方法を参照 | ※base64 エンコード必須になります。 API 型を併用する場合は 3DES による暗号化が必要になるケースがあります。 |
設定方法
(1)項目名+(2)接続文字(=半角イコール)+(3)項目値+(4)区切文字(,半角カンマ) …を連結していきます。
《項目定義》
設定内容 | 設定値 | 説明 | 桁数 | 型 | 備考 |
---|---|---|---|---|---|
項目名 | TDS2INFO_TOKEN | カード利用者の決済情報のトークン | X | 詳細は「E003_EMV 3-D セキュア認証仕様書」を参照ください。 | |
TDS2INFO_TOKEN_KEY | カード利用者の決済情報のトークンキー | X |
《設定例》
- 設定値とその値を接続文字(半角イコール)で接続させ、区切文字(半角カンマ)で連結します。TDS2INFO_TOKEN =123456789abc, TDS2INFO_TOKEN_KEY=asdefg123
- 3DES暗号化を行い、base64方式で変換します。1BNK6NDjiRdhEN0p5rajgyp2tjEC5EEnpvbBGYO+F6fckdWWXllvDYGQ1Jq・・・
- リンク型POST項目のfree_csvに設定して、送信します。
《バリデーションについて》
購入要求リクエスト時について、項目全体のバリデーションは実施しますが、各項目別のバリデーションは実施しません(入力画面に遷移した以降は、各項目別にバリデーションを行い、エラーとなった場合はエラー場面に遷移します)。
以下が、free_csvのバリデーション内容です。
- 送信された文字列が4000byte以下であること
- エンコードフォーマットがbase64方式であること
- デコード後の文字列が2500byte以下であること
制約
《制約について》
free_csvには、以下の制約がありますので、ご注意ください。
- 文字コードはS-JIS
- 項目名の大文字小文字は区別する
- 項目名に接続文字及び区切文字を含めてはいけない
- 項目値に区切文字を含めてはいけない
- 項目順序は意識しない
- 各項目は必須ではない
- 未定義の項目を設定しても問題はないが、その場合未定義の項目は無視する入力画面に遷移した以降、エンドユーザーによる変更入力は返却されない
- 管理画面には、free_csvのデータ値自体は、表示されない
《free_csv項目内で利用できない文字》
以下の文字は、全ての項目において利用できません。
文字 | 名称 | S-JIS コード |
---|---|---|
, | 半角カンマ | 0x2C |
‘ | 半角シングルクォーテーション | 0x27 |
“ | 半角ダブルクォーテーション | 0x22 |
% | 半角パーセント | 0x25 |
| | 半角パイプ | 0x7C |
& | 半角アンパサント | 0x26 |
< | 半角小なり | 0x3C |
> | 半角大なり | 0x3E |
。「」、・ヲァィゥェォャュョッーアイウエオカキクケコサシスセソタチツテトナニヌネノハヒフヘホマミムメモヤユヨラリルレロワン゙゚ | 半角カタカナ | 0xA1~0xDF |