インターフェース仕様
提供機能のインターフェース項目定義は以下のとおりです。
要求項目定義
機能 ID | D01-1 |
---|---|
処理名 | 継続課金(定期・従量)申込要求 |
流れ | 加盟店→当社 |
接続先 | サービス開始時ご案内 |
---|---|
送信メソッド | Form POST |
送信文字コード | Shift-JIS, html / text |
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)
※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義 を参照ください。
SEQ | タグエレメント名 | 項目名 | 桁数 | 型 | 必須 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|---|---|
1 | pay_method | 支払方法 | 1000 | X | △ | 可変 | docomo:d 払い(キャリア・ウォレット) auone:au かんたん決済 softbank2:ソフトバンクまとめて支払いB rakuten: 楽天ペイ(オンライン決済) rakutenv2:楽天ペイ V2(オンライン決済) recruit:リクルートかんたん支払い paypay:PayPay(オンライン決済) 省略された場合は ASP 画面にて選択、複数指定時はカンマ区切りで指定 | 支払方法を指定します。(複数指定可) ※サービスタイプが 「1:解約」または「2:再申込」または「3:特殊連携」 の場合、必須指定 ※複数指定時はカンマ区切りでご指定ください。 |
2 | merchant_id | マーチャント ID | 5 | 9 | ○ | 固定 | 加盟店を識別する ID | 当社で指定します。 |
3 | service_id | サービス ID | 3 | 9 | ○ | 固定 | 加盟店のサービスを識別する ID | 当社で指定します。 |
4 | cust_code | 顧客 ID | 64 | X | ○ | 可変 | 加盟店にて管理されている顧客 ID | マーチャント ID とサービス ID の組み合わせに対してユニーク(一意)な値としてください。 決済情報保管時の紐付けキーとなるため、必ず顧客別に払い出してください。 |
5 | order_id | 購入 ID | 38 | X | ○ | 可変 | 加盟店にて管理されている購入 ID | マーチャントID とサービスID の組み合わせに対してユニーク(一意)な値としてください。 |
6 | item_id | 商品 ID | 32 | X | ○ | 可変 | 加盟店にて管理されている商品 ID | |
7 | item_name | 商品名称 | 40 | M | 可変 | 任意の商品名 | 日本語、英数半角混在可能です。 文字数オーバー時は切捨します。文字化け時は「?」に置換します。 ※設定されない場合は、確認画面において商品名の項目自体が表示されません。 | |
8 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 0:申込 1:解約 2:再申込 3:特殊連携 4:ユーザーアカウントリンク | 「2:再申込」は au かんたん決済のみ指定可能 「3:特殊連携」「4:ユーザーアカウントリンク」は PayPay(オンライン決済)のみ指定可能 「4:ユーザーアカウントリンク」を設定すると、PayPay アプリがインストールされたスマートフォンから継続課金(定期・従量)の申込を頂く際、PayPay アプリが自動的に立ち上がり、アプリでの申込となります ※「3:特殊連携」はサービス提供開始前のためご利用になれません |
9 | tracking_id | トラッキング ID | 14 | X | △ | 可変 | 申込時に SBPS が払出す ID | サービスタイプが「1:解約」または「2:再申込」時のみ指定可で、必須 |
10 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 0:PC 1:モバイル | 省略の場合”0″を適用します。 ※詳細は基本仕様 要求の端末タイプの設定をご参照ください。 | |
11 | success_url | 登録完了時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
12 | cancel_url | 登録キャンセル時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
13 | error_url | 登録エラー時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
14 | pagecon_url | 登録通知先 CGI | 500 | X | ○ | 可変 | 結果通知先 URL | SSL 通信必須 |
15 | free1 | 自由欄1 | 20 | M | 可変 | 日本語、英数半角混在可能です。 文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
16 | free2 | 自由欄2 | 20 | M | 可変 | 日本語、英数半角混在可能です。 文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
17 | free3 | 自由欄3 | 20 | M | 可変 | 日本語、英数半角混在可能です。 文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
18 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | YYYYMMDDHHMISS | 本機能を加盟店がリクエストした日時です。 |
19 | limit_second | リクエスト許容時間 | 4 | 9 | 可変 | リクエスト有効期限秒数を設定 | 省略時は規定値(600)を適用します。 | |
20 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法について をご参照ください。 |
結果 CGI 項目定義
機能 ID | D02-1 |
---|---|
処理名 | 継続課金(定期・従量)申込結果 CGI |
流れ | 当社→加盟店 |
接続先 | 指定された URL(結果通知用 CGI) |
---|---|
送信メソッド | Form 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 | order_id | 購入 ID | 38 | X | ○ | 可変 | 〃 | |
6 | item_id | 商品 ID | 32 | X | ○ | 可変 | 〃 | |
7 | item_name | 商品名称 | 40 | M | 可変 | 〃 | ||
8 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 〃 | |
9 | tracking_id | トラッキング ID | 14 | X | 固定 | 〃 | ||
10 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 〃 | ||
11 | free1 | 自由欄1 | 20 | M | 可変 | 〃 | ||
12 | free2 | 自由欄2 | 20 | M | 可変 | 〃 | ||
13 | free3 | 自由欄3 | 20 | M | 可変 | 〃 | ||
14 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | 〃 | |
結果返却時にセットされる項目 | ||||||||
15 | res_pay_method | 処理結果 支払方法 | 20 | X | ○ | 可変 | 申込時に選択された支払方法です。 | |
16 | res_result | 処理結果ステータス | 2 | X | ○ | 固定 | OK:要求処理 OK NG:要求 NG | |
17 | res_tracking_id | 処理トラッキング ID | 14 | X | ○ | 固定 | 申込時に当社が払出すID | |
18 | res_payinfo_key | 顧客決済情報 | 32 | X | 可変 | 顧客決済情報 | 処理結果ステータスが OK の場合のみ、返却します。 au かんたん支払い:OpenID の MD5 値 d 払い(キャリア・ウォレット):OpenID の MD5 値 ソフトバンクまとめて支払い:中間 ID の MD5 値 楽天ペイ(オンライン決済):中間 ID の MD5 値 楽天ペイ(オンライン決済)V2:OpenID の MD5 値 リクルートかんたん支払い:認証番号の MD5 値 PayPay(オンライン決済):userAuthorizationId の MD5 値 | |
19 | res_payment_date | 完了処理日時 | 14 | 9 | 可変 | YYYYMMDDHHMISS | 処理結果ステータス OK の場合、外部決済期間の処理日時となります。 処理結果ステータス NG の場合、処理日時が無い場合があります。 | |
20 | res_err_code | エラーコード | 4 | X | 可変 | エラーコード一覧参照 | ||
21 | res_date | レスポンス日時 | 14 | 9 | ○ | 可変 | YYYYMMDDHHMISS | 当社がレスポンスした日時です。 |
22 | limit_second | レスポンス許容時間 | 4 | 9 | ○ | 可変 | リクエスト時の許容時間 | 省略時は規定値(600)を適用します。 |
23 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対する チェックサム | 基本仕様 チェックサム値の生成方法について をご参照ください。 |
結果 CGI レスポンス項目定義
機能 ID | D02-2 |
---|---|
処理名 | 継続課金(定期・従量)申込結果 CGI |
流れ | レスポンス加盟店→当社 |
接続先 | 継続課金(定期・従量)申込結果 CGI の通知元 |
---|---|
送信メソッド | HTTP POST |
送信文字コード | Shift-JIS, text / csv |
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)
※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義 を参照ください。
SEQ | 項目名 | 桁数 | 型 | 必須 | 設定内容 | 備考 |
---|---|---|---|---|---|---|
1 | 処理結果 | 2 | X | ○ | OK/NG | 加盟店様側での処理結果 ※結果 CGI の「res_result」が NG の場合には必ず OK を返却してください |
2 | エラーメッセージ | 100 | M | 加盟店様側でエラーと なった時のメッセージ | 処理「OK」の時は不要 |
結果(画面返却)項目定義
機能 ID | D03-1 |
---|---|
処理名 | 継続課金(定期・従量)申込結果(画面返却) |
流れ | 当社→加盟店 |
接続先 | 指定された URL(完了) |
---|---|
送信メソッド | 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 | order_id | 購入 ID | 38 | X | ○ | 可変 | 〃 | |
6 | item_id | 商品 ID | 32 | X | ○ | 可変 | 〃 | |
7 | item_name | 商品名称 | 40 | M | 可変 | 〃 | ||
8 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 〃 | |
9 | tracking_id | トラッキング ID | 14 | X | 固定 | 〃 | ||
10 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 〃 | ||
11 | free1 | 自由欄1 | 20 | M | 可変 | 〃 | ||
12 | free2 | 自由欄2 | 20 | M | 可変 | 〃 | ||
13 | free3 | 自由欄3 | 20 | M | 可変 | 〃 | ||
14 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | 〃 | |
結果返却時にセットされる項目 | ||||||||
15 | res_pay_method | 処理結果 支払方法 | 20 | X | ○ | 可変 | 申込時に選択された支払方法です。 | |
16 | res_result | 処理結果ステータス | 2 | X | ○ | 固定 | OK:要求処理 OK NG:要求 NG | |
17 | res_tracking_id | 処理トラッキング ID | 14 | X | ○ | 固定 | 申込時に当社が払出すID | |
18 | res_payinfo_key | 顧客決済情報 | 32 | X | 可変 | 顧客決済情報 | 処理結果ステータスが OK の場合のみ、返却します。 au かんたん支払い:OpenID の MD5 値 d 払い(キャリア・ウォレット):OpenID の MD5 値 ソフトバンクまとめて支払い:中間 ID の MD5 値 楽天ペイ(オンライン決済):中間 ID の MD5 値 楽天ペイ(オンライン決済)V2:OpenID の MD5 値 リクルートかんたん支払い:認証番号の MD5 値 PayPay(オンライン決済):userAuthorizationId の MD5 値 | |
19 | res_payment_date | 完了処理日時 | 14 | 9 | 可変 | YYYYMMDDHHMISS | 処理結果ステータス OK の場合、外部決済期間の処理日時となります。 処理結果ステータス NG の場合、処理日時が無い場合があります。 | |
20 | res_err_code | エラーコード | 4 | X | 可変 | エラーコード一覧参照 | ||
21 | res_date | レスポンス日時 | 14 | 9 | ○ | 可変 | YYYYMMDDHHMISS | 当社がレスポンスした日時です。 |
22 | limit_second | レスポンス許容時間 | 4 | 9 | ○ | 可変 | リクエスト時の許容時間 | 省略時は規定値(600)を適用します。 |
23 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対する チェックサム | 基本仕様 チェックサム値の生成方法について をご参照ください。 |
このページは役に立ちましたか?