インターフェース仕様
提供機能のインターフェース項目定義は以下のとおりです。
課金方式【都度課金/継続課金(定期・従量)/継続課金(簡易)】毎にインターフェース項目が異なります。
利用する課金方式のタブを選択してください。
要求項目定義
機能 ID | A01-1 |
---|---|
処理名 | 購入要求 |
流れ | 加盟店→当社 |
接続先 | サービス開始時ご案内 |
---|---|
送信メソッド | Form POST |
送信文字コード | Shift-JIS, html / text |
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)
※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義を参照ください。
SEQ | タグエレメント名 | 項目名 | 桁数 | 型 | 必須 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|---|---|
1 | pay_method | 支払方法 | 1000 | X | △ | 可変 | 詳細は決済方法タグ「pay_method」についてを参照ください | 支払方法を指定します。(複数指定可) |
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 | 当連携モデルの場合は未設定(空文字)です。 | |
6 | sps_payment_no | SBPS 支払方法管理番号 | 3 | 9 | 固定 | 当社で管理する支払方法管理番号 | 当連携モデルの場合は未設定(空文字)です。 | |
7 | order_id | 購入 ID | 38 | X | ○ | 可変 | 加盟店にて管理されている購入 ID | マーチャント ID とサービス ID の組み合わせに対してユニーク(一意)な値としてください。※継続課金(簡易)の解約の場合も一意の ID を設定してください。 |
8 | item_id | 商品 ID | 32 | X | ○ | 可変 | 加盟店にて管理されている商品 ID | |
9 | pay_item_id | 外部決済機関商品 ID | 32 | X | 可変 | 当連携モデルの場合は未設定(空文字)です。 | ||
10 | item_name | 商品名称 | 40 | M | △ | 可変 | 任意の商品名 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。※設定されない場合は、購入内容確認画面において商品名の項目自体が表示されません。 NP後払いの場合は必須項目となります。Pay-easy決済では以下の文字種は使用不可です。 *(アスタリスク)、 _(アンダーバー)、 @(アットマーク) |
11 | tax | 税額 | 7 | 9 | △ | 可変 | 課金税額 | 0 円以上を設定してください。 ※総合振込決済のみ必須です。 |
12 | amount | 金額(税込) | 7 | 9 | ○ | 可変 | 税込の課金金額 | 0 円以上を設定してください。 |
13 | pay_type | 購入タイプ | 1 | 9 | ○ | 固定 | 0:都度課金 | |
15 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 0:売上(購入) | |
20 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 0:PC 1:フィーチャーフォン | 省略の場合”0″を適用します。 ※詳細は基本仕様 要求の端末タイプの設定をご参照ください。 | |
21 | success_url | 決済完了時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
22 | cancel_url | 決済キャンセル時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
23 | error_url | エラー時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
24 | pagecon_url | 決済通知用 CGI | 500 | X | ○ | 可変 | 結果通知先 URL | SSL 通信が必須となります。 |
25 | free1 | 自由欄1 | 20 | M | 可変 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
26 | free2 | 自由欄2 | 20 | M | 可変 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
27 | free3 | 自由欄3 | 20 | M | 可変 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
28 | free_csv | フリー項目 | 4000 | M | 可変 | 決済固有タグ「free_csv」についてを参照ください。 | ||
複数購入の場合は繰り返し(画面表示用項目) | ||||||||
29 | dtl_rowno | 明細行番号 | 3 | 9 | △ | 可変 | 1、2、3、・・・明細の行番号(表示される順序) | 明細行を利用する場合は必須です。1ずつインクリメントさせてください。※明細行最大件数は 999 明細です。 |
30 | dtl_item_id | 明細商品 ID | 20 | X | △ | 可変 | 画面に表示される明細の商品 ID | 他明細内の明細商品 ID で、いずれか一つに設定されていた場合は、必須となります。 |
31 | dtl_item_name | 明細商品名称 | 40 | M | △ | 可変 | 画面に表示される明細の商品名 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。他明細内の明細商品名称で、いずれか一つに設定されていた場合は、必須となります。NP後払いの場合は明細を設定する場合には必須項目となります。Pay-easy決済では以下の文字種は使用不可です。 *(アスタリスク) _(アンダーバー) @(アットマーク) |
32 | dtl_item_count | 明細数量 | 6 | 9 | △ | 可変 | 画面に表示される明細の購入数量 | 他明細内の明細数量で、いずれか一つに設定されていた場合は、必須となります。NP後払いの場合は明細を設定する場合には必須項目となります。 |
33 | dtl_tax | 明細税額 | 8 | 9 | 可変 | 明細小計に対する税額 | ||
34 | dtl_amount | 明細金額(税込) | 8 | 9 | △ | 可変 | 画面に表示される明細の小計金額(税込) | 他明細内の明細金額(税込)で、いずれか一つに設定されていた場合は、必須となります。NP後払いの場合は明細を設定する場合には必須項目となります。 |
35 | dtl_free1 | 明細自由欄 1 | 3000 | M | 可変 | ※当社決済システムへの格納は行わない項目になります。ご利用の際は、当社営業にご確認下さい。 | ||
36 | dtl_free2 | 明細自由欄 2 | 3000 | M | 可変 | ※当社決済システムへの格納は行わない項目になります。ご利用の際は、当社営業にご確認下さい。 | ||
37 | dtl_free3 | 明細自由欄 3 | 3000 | M | 可変 | ※当社決済システムへの格納は行わない項目になります。ご利用の際は、当社営業にご確認下さい。 | ||
複数購入の場合の繰り返しここまで | ||||||||
38 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | YYYYMMDDHHMISS | 本機能を加盟店がリクエストした日時です。 |
39 | limit_second | リクエスト許容時間 | 4 | 9 | 可変 | 当社サーバのタイムスタンプとリクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 | |
40 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
SEQ | タグエレメント名 | 項目名 | 桁数 | 型 | 必須 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|---|---|
1 | pay_method | 支払方法 | 1000 | X | △ | 可変 | 詳細は決済方法タグ「pay_method」についてを参照ください | 支払方法を指定します。(複数指定可) |
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 | 当連携モデルの場合は未設定(空文字)です。 | |
6 | sps_payment_no | SBPS 支払方法管理番号 | 3 | 9 | 固定 | 当社で管理する支払方法管理番号 | 当連携モデルの場合は未設定(空文字)です。 | |
7 | order_id | 購入 ID | 38 | X | ○ | 可変 | 加盟店にて管理されている購入 ID | マーチャント ID とサービス ID の組み合わせに対してユニーク(一意)な値としてください。※継続課金(簡易)の解約の場合も一意の ID を設定してください。 |
8 | item_id | 商品 ID | 32 | X | ○ | 可変 | 加盟店にて管理されている商品 ID | |
9 | pay_item_id | 外部決済機関商品 ID | 32 | X | 可変 | 当連携モデルの場合は未設定(空文字)です。 | ||
10 | item_name | 商品名称 | 40 | M | △ | 可変 | 任意の商品名 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。※設定されない場合は、購入内容確認画面において商品名の項目自体が表示されません。NP 後払いの場合は必須項目となります。 Pay-easy 決済では以下の文字種は使用不可です。 *(アスタリスク) _(アンダーバー) @(アットマーク) |
11 | tax | 税額 | 7 | 9 | △ | 可変 | 課金税額 | 0 円以上を設定してください。※総合振込決済のみ必須です。 |
12 | amount | 金額(税込) | 7 | 9 | ○ | 可変 | 税込の課金金額 | 0 円以上を設定してください。 |
13 | pay_type | 購入タイプ | 1 | 9 | ○ | 固定 | 2:継続課金(定期・従量) | |
14 | auto_charge_type | 自動課金タイプ | 1 | 9 | △ | 固定 | 0:自動課金しない 1:自動課金する |
購入タイプが「継続課金(簡易)」または「継続課金(定期・従量)」時のみ指定可で必須となります。購入タイプが「継続課金(定期・従量)」の場合、「自動課金しない」のみ指定可です。 |
15 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 0:売上(購入) 1:取消(月額課金解約) |
購入タイプが「都度課金」または「継続課金(定期・従量)」の場合 、「売上(購入)」のみ指定可です。取消(月額課金解約)は「継続課金(簡易)」のみ指定可能です。 |
16 | div_settele | 決済区分 | 1 | 9 | △ | 固定 | 0:前払い | 購入タイプが「継続課金(簡易)」または「継続課金(定期・従量)」時のみ、必須項目となります。購入タイプが「都度課金」の場合、設定なしとなります。 |
20 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 0:PC 1:フィーチャーフォン |
省略の場合”0″を適用します。 ※詳細は基本仕様 要求の端末タイプの設定をご参照ください。 | |
21 | success_url | 決済完了時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
22 | cancel_url | 決済キャンセル時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
23 | error_url | エラー時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
24 | pagecon_url | 決済通知用 CGI | 500 | X | ○ | 可変 | 結果通知先 URL | SSL 通信が必須となります。 |
25 | free1 | 自由欄1 | 20 | M | 可変 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
26 | free2 | 自由欄2 | 20 | M | 可変 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
27 | free3 | 自由欄3 | 20 | M | 可変 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
28 | free_csv | フリー項目 | 4000 | M | 可変 | 商品名称や住所情報など | 決済固有タグ「free_csv」についてを参照ください。 | |
複数購入の場合は繰り返し(画面表示用項目) | ||||||||
29 | dtl_rowno | 明細行番号 | 3 | 9 | △ | 可変 | 1、2、3、・・・明細の行番号(表示される順序) | 明細行を利用する場合は必須です。 1 ずつインクリメントさせてください。 ※明細行最大件数は 999 明細です。 |
30 | dtl_item_id | 明細商品 ID | 20 | X | △ | 可変 | 画面に表示される明細の商品 ID | 他明細内の明細商品 ID で、いずれか一つに設定されていた場合は、必須となります。 |
31 | dtl_item_name | 明細商品名称 | 40 | M | △ | 可変 | 画面に表示される明細の商品名 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。他明細内の明細商品名称で、いずれか一つに設定されていた場合は、必須となります。NP後払いの場合は明細を設定する場合には必須項目となります。Pay-easy 決済では以下の文字種は使用不可です。 *(アスタリスク) _(アンダーバー) @(アットマーク) |
32 | dtl_item_count | 明細数量 | 6 | 9 | △ | 可変 | 画面に表示される明細の購入数量 | 他明細内の明細数量で、いずれか一つに設定されていた場合は、必須となります。NP後払いの場合は明細を設定する場合には必須項目となります。 |
33 | dtl_tax | 明細税額 | 8 | 9 | 可変 | 明細小計に対する税額 | ||
34 | dtl_amount | 明細金額(税込) | 8 | 9 | △ | 可変 | 画面に表示される明細の小計金額(税込) | 他明細内の明細金額(税込)で、いずれか一つに設定されていた場合は、必須となります。NP後払いの場合は明細を設定する場合には必須項目となります。 |
35 | dtl_free1 | 明細自由欄 1 | 3000 | M | 可変 | ※当社決済システムへの格納は行わない項目になります。 ご利用の際は、当社営業にご確認下さい。 | ||
36 | dtl_free2 | 明細自由欄 2 | 3000 | M | 可変 | ※当社決済システムへの格納は行わない項目になります。 ご利用の際は、当社営業にご確認下さい。 | ||
37 | dtl_free3 | 明細自由欄 3 | 3000 | M | 可変 | ※当社決済システムへの格納は行わない項目になります。 ご利用の際は、当社営業にご確認下さい。 | ||
複数購入の場合の繰り返しここまで | ||||||||
38 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | YYYYMMDDHHMISS | 本機能を加盟店がリクエストした日時です。 |
39 | limit_second | リクエスト許容時間 | 4 | 9 | 可変 | 当社サーバのタイムスタンプとリクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 | |
40 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
SEQ | タグエレメント名 | 項目名 | 桁数 | 型 | 必須 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|---|---|
1 | pay_method | 支払方法 | 1000 | X | △ | 可変 | 詳細は決済方法タグ「pay_method」についてを参照ください | 支払方法を指定します。(複数指定可) |
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 | 当連携モデルの場合は未設定(空文字)です。 | |
6 | sps_payment_no | SBPS 支払方法管理番号 | 3 | 9 | 固定 | 当社で管理する支払方法管理番号 | 当連携モデルの場合は未設定(空文字)です。 | |
7 | order_id | 購入 ID | 38 | X | ○ | 可変 | 加盟店にて管理されている購入 ID | マーチャント ID とサービス ID の組み合わせに対してユニーク(一意)な値としてください。※継続課金(簡易)の解約の場合も一意の ID を設定してください。 |
8 | item_id | 商品 ID | 32 | X | ○ | 可変 | 加盟店にて管理されている商品 ID | |
9 | pay_item_id | 外部決済機関商品 ID | 32 | X | 可変 | 当連携モデルの場合は未設定(空文字)です。 | ||
10 | item_name | 商品名称 | 40 | M | △ | 可変 | 任意の商品名 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。※設定されない場合は、購入内容確認画面において商品名の項目自体が表示されません。NP 後払いの場合は必須項目となります。Pay-easy 決済では以下の文字種は使用不可です。 *(アスタリスク) _(アンダーバー) @(アットマーク) |
11 | tax | 税額 | 7 | 9 | △ | 可変 | 課金税額 | 0 円以上を設定してください。※総合振込決済のみ必須です。 |
12 | amount | 金額(税込) | 7 | 9 | ○ | 可変 | 税込の課金金額 | 0 円以上を設定してください。 |
13 | pay_type | 購入タイプ | 1 | 9 | ○ | 固定 | 1:継続課金(簡易) | |
14 | auto_charge_type | 自動課金タイプ | 1 | 9 | △ | 固定 | 0:自動課金しない 1:自動課金する | 購入タイプが「継続課金(簡易)」または「継続課金(定期・従量)」時のみ指定可で必須となります。購入タイプが「継続課金(定期・従量)」の場合、「自動課金しない」のみ指定可です。 |
15 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 0:売上(購入) 1:取消(月額課金解約) | 購入タイプが「都度課金」または「継続課金(定期・従量)」の場合 、「売上(購入)」のみ指定可です。取消(月額課金解約)は「継続課金(簡易)」のみ指定可能です。 |
16 | div_settele | 決済区分 | 1 | 9 | △ | 固定 | 0:前払い | 購入タイプが「継続課金(簡易)」または「継続課金(定期・従量)」時のみ、必須項目となります。 購入タイプが「都度課金」の場合、設定なしとなります。 |
17 | last_charge_month | 最終課金月 | 6 | 9 | 固定 | YYYYMM | 設定月の次月から継続課金を行いません。購入タイプが「継続課金(簡易)」時のみ指定可です。「継続課金(定期・従量)」は設定なしとなります。 | |
18 | camp_type | キャンペーンタイプ | 1 | 9 | △ | 固定 | 0:キャンペーンなし 1:購入月無料 | 購入タイプが「継続課金(簡易)」時のみ指定可で必須となります。「継続課金(定期・従量)」は設定なしとなります。 ※2022 年 2月 1 日以降に継続課金(簡易)をお申込みの加盟店様は、クレジットカード決済においては「1:購入月無料」を使用した初月解約時有料の要求が利用できません。(リクエストした場合システムエラー画面に遷移します。) |
19 | tracking_id | トラッキング ID | 14 | X | △ | 固定 | 購入時に当社が払出す ID | サービスタイプが「取消(月額課金解約)」時のみ指定可で必須となります。 |
20 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 0:PC 1:フィーチャーフォン |
省略の場合”0″を適用します。 ※詳細は基本仕様 要求の端末タイプの設定をご参照ください。 | |
21 | success_url | 決済完了時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
22 | cancel_url | 決済キャンセル時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
23 | error_url | エラー時 URL | 500 | X | ○ | 可変 | 画面戻り先 URL | |
24 | pagecon_url | 決済通知用 CGI | 500 | X | ○ | 可変 | 結果通知先 URL | SSL 通信が必須となります。 |
25 | free1 | 自由欄1 | 20 | M | 可変 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
26 | free2 | 自由欄2 | 20 | M | 可変 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
27 | free3 | 自由欄3 | 20 | M | 可変 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。 | ||
28 | free_csv | フリー項目 | 4000 | M | 可変 | 商品名称や住所情報など | 決済固有タグ「free_csv」についてを参照ください。 | |
複数購入の場合は繰り返し(画面表示用項目) | ||||||||
29 | dtl_rowno | 明細行番号 | 3 | 9 | △ | 可変 | 1、2、3、・・・明細の行番号(表示される順序) | 明細行を利用する場合は必須です。 1 ずつインクリメントさせてください。 ※明細行最大件数は 999 明細です。 |
30 | dtl_item_id | 明細商品 ID | 20 | X | △ | 可変 | 画面に表示される明細の商品 ID | 他明細内の明細商品 ID で、いずれか一つに設定されていた場合は、必須となります。 |
31 | dtl_item_name | 明細商品名称 | 40 | M | △ | 可変 | 画面に表示される明細の商品名 | 日本語、英数半角混在可能です。文字数オーバー時は切捨します。文字化け時は「?」に置換します。他明細内の明細商品名称で、いずれか一つに設定されていた場合は、必須となります。NP後払いの場合は明細を設定する場合には必須項目となります。Pay-easy 決済では以下の文字種は使用不可です。 *(アスタリスク) _(アンダーバー) @(アットマーク) |
32 | dtl_item_count | 明細数量 | 6 | 9 | △ | 可変 | 画面に表示される明細の購入数量 | 他明細内の明細数量で、いずれか一つに設定されていた場合は、必須となります。 NP後払いの場合は明細を設定する場合には必須項目となります。 |
33 | dtl_tax | 明細税額 | 8 | 9 | 可変 | 明細小計に対する税額 | ||
34 | dtl_amount | 明細金額(税込) | 8 | 9 | △ | 可変 | 画面に表示される明細の小計金額(税込) | 他明細内の明細金額(税込)で、いずれか一つに設定されていた場合は、必須となります。NP後払いの場合は明細を設定する場合には必須項目となります。 |
35 | dtl_free1 | 明細自由欄 1 | 3000 | M | 可変 | ※当社決済システムへの格納は行わない項目になります。ご利用の際は、当社営業にご確認下さい。 | ||
36 | dtl_free2 | 明細自由欄 2 | 3000 | M | 可変 | ※当社決済システムへの格納は行わない項目になります。ご利用の際は、当社営業にご確認下さい。 | ||
37 | dtl_free3 | 明細自由欄 3 | 3000 | M | 可変 | ※当社決済システムへの格納は行わない項目になります。ご利用の際は、当社営業にご確認下さい。 | ||
複数購入の場合の繰り返しここまで | ||||||||
38 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | YYYYMMDDHHMISS | 本機能を加盟店がリクエストした日時です。 |
39 | limit_second | リクエスト許容時間 | 4 | 9 | 可変 | 当社サーバのタイムスタンプとリクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 | |
40 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
結果 CGI 項目定義
機能 ID | A02-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 | order_id | 購入 ID | 38 | X | ○ | 可変 | 〃 | |
8 | item_id | 商品 ID | 32 | X | ○ | 可変 | 〃 | |
9 | pay_item_id | 外部決済機関商品 ID | 32 | X | 可変 | 〃 | ||
10 | item_name | 商品名称 | 40 | M | 可変 | 〃 | ||
11 | tax | 税額 | 7 | 9 | 可変 | 〃 | ||
12 | amount | 金額(税込) | 7 | 9 | ○ | 可変 | 〃 | |
13 | pay_type | 購入タイプ | 1 | 9 | ○ | 固定 | 〃 | |
14 | auto_charge_type | 自動課金タイプ | 1 | 9 | △ | 固定 | 〃 | |
15 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 〃 | |
16 | div_settele | 決済区分 | 1 | 9 | △ | 固定 | 〃 | |
17 | last_charge_month | 最終課金月 | 6 | 9 | 固定 | 〃 | ||
18 | camp_type | キャンペーンタイプ | 1 | 9 | △ | 固定 | 〃 | |
19 | tracking_id | トラッキング ID | 14 | X | 固定 | 〃 | ||
20 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 〃 | ||
21 | free1 | 自由欄1 | 20 | M | 可変 | 〃 | ||
22 | free2 | 自由欄2 | 20 | M | 可変 | 〃 | ||
23 | free3 | 自由欄3 | 20 | M | 可変 | 〃 | ||
複数購入の場合は繰り返し(画面表示用項目) | ||||||||
24 | dtl_rowno | 明細行番号 | 2 | 9 | 可変 | 〃 | ||
25 | dtl_item_id | 明細商品 ID | 20 | X | 可変 | 〃 | ||
26 | dtl_item_name | 明細商品名称 | 40 | M | 可変 | 〃 | ||
27 | dtl_item_count | 明細数量 | 6 | 9 | 可変 | 〃 | ||
28 | dtl_tax | 明細税額 | 8 | 9 | 可変 | 〃 | ||
29 | dtl_amount | 明細金額(税込) | 8 | 9 | 可変 | 〃 | ||
30 | dtl_free1 | 明細自由欄 1 | 3000 | M | 可変 | 〃 | ||
31 | dtl_free2 | 明細自由欄 2 | 3000 | M | 可変 | 〃 | ||
32 | dtl_free3 | 明細自由欄 3 | 3000 | M | 可変 | 〃 | ||
複数購入の場合の繰り返しここまで | ||||||||
33 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | 〃 | |
結果返却時にセットされる項目 | ||||||||
34 | res_pay_method | 処理結果 支払方法 | 20 | X | ○ | 可変 | 購入要求時に選択された支払方法です。 | |
35 | res_result | 処理結果ステータス | 2 | X | ○ | 固定 | OK:要求処理 OK NG:要求 NG PY:入金通知 CN:期限切れキャンセル | 詳細は こちら を参照ください。 |
36 | res_tracking_id | 処理トラッキング ID | 14 | X | ○ | 固定 | 購入時に当社が払出す ID | |
37 | res_sps_cust_no | 処理 SBPS 顧客 ID | 12 | 9 | 固定 | 当社で管理する顧客 ID | ||
38 | res_sps_payment_no | 処理 SBPS 支払方法管理番号 | 3 | 9 | 固定 | 当社で管理する支払方法管理番号 | ||
39 | res_payinfo_key | 顧客決済情報 | 145 | X | 可変 | 顧客決済情報 | 処理結果ステータスが OK の場合のみ、返却します。 ・クレジットカード決済:カード番号を元にした SBPS 独自の演算によるハッシュ値(頭0補完 16 桁) ・リクルートかんたん支払い:リクルートの注文番号(固定 15 桁) ※エンドユーザー支払い方法がコンビニ決済の場合は先頭に「webcvs,」の文字列が入りますので、 後日入金通知等を受け取ってください。 ・d 払い(キャリア・ウォレット):購入タイプが「定期購入」時、ドコモの承諾番号(固定 12 桁) ・ソフトバンクまとめて支払い(A):決済機関側の注文番号 ・請求書(コンビニ決済/総合振込/Payeasy):入金種別コード、入金額、入金累計額、 メールアドレスがカンマ(,)区切りで連結した英数字 ※請求書の入金種別コードは、1 桁の固定で通知内容は下記のとおりです。 P:速報/C:速報取消/D:確報/G:確報取消 ※収納会社によって存在しない入金種別コードがあります。 例:1 万円の速報入金で1万 5 千円の累積額の場合、 P,10000,15000,aaa@aaa.com となります。 ・銀聯ネット決済:銀聯トランザクション ID ・メルペイネット決済:ユーザー確認用取引 ID ・ウォレット決済サービス(Type-Y):クレカと PayPay 内訳金額がカンマ(,)区切りで連結した数字 (500,300:クレカ 500 円、 PayPay300 円の例) ・PayPay(オンライン決済):PayPay の決済番号 ・エポスかんたん決済 購入の場合 「クレジット利用金額 + “,” + クーポン利用金額 +”,” ポイント利用金額」 ※各項目、不使用の場合は「0」として返却 ・楽天ペイ(オンライン決済)V2:charge_id | |
40 | res_payment_date | 完了処理日時 | 14 | 9 | 可変 | YYYYMMDDHHMISS | 処理結果ステータス OK の場合、外部決済期間の処理日時となります。 処理結果ステータス NG の場合、処理日時が無い場合があります。 処理結果ステータス PY の場合、通知処理日となります。 | |
41 | res_err_code | エラーコード | 4 | X | 可変 | エラーコード一覧参照 | ||
42 | res_date | レスポンス日時 | 14 | 9 | ○ | 可変 | YYYYMMDDHHMISS | 当社がレスポンスした日時です。 |
43 | limit_second | レスポンス許容時間 | 4 | 9 | ○ | 可変 | 当社サーバのタイムスタンプとリクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 |
44 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
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 | order_id | 購入 ID | 38 | X | ○ | 可変 | 〃 | |
8 | item_id | 商品 ID | 32 | X | ○ | 可変 | 〃 | |
9 | pay_item_id | 外部決済機関商品 ID | 32 | X | 可変 | 〃 | ||
10 | item_name | 商品名称 | 40 | M | 可変 | 〃 | ||
11 | tax | 税額 | 7 | 9 | 可変 | 〃 | ||
12 | amount | 金額(税込) | 7 | 9 | ○ | 可変 | 〃 | |
13 | pay_type | 購入タイプ | 1 | 9 | ○ | 固定 | 〃 | |
14 | auto_charge_type | 自動課金タイプ | 1 | 9 | △ | 固定 | 〃 | |
15 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 〃 | |
16 | div_settele | 決済区分 | 1 | 9 | △ | 固定 | 〃 | |
17 | last_charge_month | 最終課金月 | 6 | 9 | 固定 | 〃 | ||
18 | camp_type | キャンペーンタイプ | 1 | 9 | △ | 固定 | 〃 | |
19 | tracking_id | トラッキング ID | 14 | X | 固定 | 〃 | ||
20 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 〃 | ||
21 | free1 | 自由欄1 | 20 | M | 可変 | 〃 | ||
22 | free2 | 自由欄2 | 20 | M | 可変 | 〃 | ||
23 | free3 | 自由欄3 | 20 | M | 可変 | 〃 | ||
複数購入の場合は繰り返し(画面表示用項目) | ||||||||
24 | dtl_rowno | 明細行番号 | 2 | 9 | 可変 | 〃 | ||
25 | dtl_item_id | 明細商品 ID | 20 | X | 可変 | 〃 | ||
26 | dtl_item_name | 明細商品名称 | 40 | M | 可変 | 〃 | ||
27 | dtl_item_count | 明細数量 | 6 | 9 | 可変 | 〃 | ||
28 | dtl_tax | 明細税額 | 8 | 9 | 可変 | 〃 | ||
29 | dtl_amount | 明細金額(税込) | 8 | 9 | 可変 | 〃 | ||
30 | dtl_free1 | 明細自由欄 1 | 3000 | M | 可変 | 〃 | ||
31 | dtl_free2 | 明細自由欄 2 | 3000 | M | 可変 | 〃 | ||
32 | dtl_free3 | 明細自由欄 3 | 3000 | M | 可変 | 〃 | ||
複数購入の場合の繰り返しここまで | ||||||||
33 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | 〃 | |
結果返却時にセットされる項目 | ||||||||
34 | res_pay_method | 処理結果 支払方法 | 20 | X | ○ | 可変 | 購入要求時に選択された支払方法です。 | |
35 | res_result | 処理結果ステータス | 2 | X | ○ | 固定 | OK:要求処理 OK NG:要求 NG | 詳細は こちら を参照ください。 |
36 | res_tracking_id | 処理トラッキング ID | 14 | X | ○ | 固定 | 購入時に当社が払出す ID | |
37 | res_sps_cust_no | 処理 SBPS 顧客 ID | 12 | 9 | 固定 | 当社で管理する顧客 ID | ||
38 | res_sps_payment_no | 処理 SBPS 支払方法管理番号 | 3 | 9 | 固定 | 当社で管理する支払方法管理番号 | ||
39 | res_payinfo_key | 顧客決済情報 | 145 | X | 可変 | 顧客決済情報 | 処理結果ステータスが OK の場合のみ、返却します。 ・クレジットカード決済:カード番号を元にした SBPS 独自の演算によるハッシュ値(頭0補完 16 桁) ・リクルートかんたん支払い:リクルートの注文番号(固定 15 桁) ※エンドユーザー支払い方法がコンビニ決済の場合は先頭に「webcvs,」の文字列が入りますので、 後日入金通知等を受け取ってください。 ・d 払い(キャリア・ウォレット):購入タイプが「定期購入」時、ドコモの承諾番号(固定 12 桁) ・ソフトバンクまとめて支払い(A):決済機関側の注文番号 ・請求書(コンビニ決済/総合振込/Payeasy):入金種別コード、入金額、入金累計額、 メールアドレスがカンマ(,)区切りで連結した英数字 ※請求書の入金種別コードは、1 桁の固定で通知内容は下記のとおりです。 P:速報/C:速報取消/D:確報/G:確報取消 ※収納会社によって存在しない入金種別コードがあります。 例:1 万円の速報入金で1万 5 千円の累積額の場合、 P,10000,15000,aaa@aaa.com となります。 ・銀聯ネット決済:銀聯トランザクション ID ・メルペイネット決済:ユーザー確認用取引 ID ・ウォレット決済サービス(Type-Y):クレカと PayPay 内訳金額がカンマ(,)区切りで連結した数字 (500,300:クレカ 500 円、 PayPay300 円の例) ・PayPay(オンライン決済):PayPay の決済番号 ・エポスかんたん決済 購入の場合 「クレジット利用金額 + “,” + クーポン利用金額 +”,” ポイント利用金額」 ※各項目、不使用の場合は「0」として返却 ・楽天ペイ(オンライン決済)V2:charge_id | |
40 | res_payment_date | 完了処理日時 | 14 | 9 | 可変 | YYYYMMDDHHMISS | 処理結果ステータス OK の場合、外部決済期間の処理日時となります。 処理結果ステータス NG の場合、処理日時が無い場合があります。 | |
41 | res_err_code | エラーコード | 4 | X | 可変 | エラーコード一覧参照 | ||
42 | res_date | レスポンス日時 | 14 | 9 | ○ | 可変 | YYYYMMDDHHMISS | 当社がレスポンスした日時です。 |
43 | limit_second | レスポンス許容時間 | 4 | 9 | ○ | 可変 | 当社サーバのタイムスタンプと リクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 |
44 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
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 | order_id | 購入 ID | 38 | X | ○ | 可変 | 〃 | |
8 | item_id | 商品 ID | 32 | X | ○ | 可変 | 〃 | |
9 | pay_item_id | 外部決済機関商品 ID | 32 | X | 可変 | 〃 | ||
10 | item_name | 商品名称 | 40 | M | 可変 | 〃 | ||
11 | tax | 税額 | 7 | 9 | 可変 | 〃 | ||
12 | amount | 金額(税込) | 7 | 9 | ○ | 可変 | 〃 | |
13 | pay_type | 購入タイプ | 1 | 9 | ○ | 固定 | 〃 | |
14 | auto_charge_type | 自動課金タイプ | 1 | 9 | △ | 固定 | 〃 | |
15 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 〃 | |
16 | div_settele | 決済区分 | 1 | 9 | △ | 固定 | 〃 | |
17 | last_charge_month | 最終課金月 | 6 | 9 | 固定 | 〃 | ||
18 | camp_type | キャンペーンタイプ | 1 | 9 | △ | 固定 | 〃 | |
19 | tracking_id | トラッキング ID | 14 | X | 固定 | 〃 | ||
20 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 〃 | ||
21 | free1 | 自由欄1 | 20 | M | 可変 | 〃 | ||
22 | free2 | 自由欄2 | 20 | M | 可変 | 〃 | ||
23 | free3 | 自由欄3 | 20 | M | 可変 | 〃 | ||
複数購入の場合は繰り返し(画面表示用項目) | ||||||||
24 | dtl_rowno | 明細行番号 | 2 | 9 | 可変 | 〃 | ||
25 | dtl_item_id | 明細商品 ID | 20 | X | 可変 | 〃 | ||
26 | dtl_item_name | 明細商品名称 | 40 | M | 可変 | 〃 | ||
27 | dtl_item_count | 明細数量 | 6 | 9 | 可変 | 〃 | ||
28 | dtl_tax | 明細税額 | 8 | 9 | 可変 | 〃 | ||
29 | dtl_amount | 明細金額(税込) | 8 | 9 | 可変 | 〃 | ||
30 | dtl_free1 | 明細自由欄 1 | 3000 | M | 可変 | 〃 | ||
31 | dtl_free2 | 明細自由欄 2 | 3000 | M | 可変 | 〃 | ||
32 | dtl_free3 | 明細自由欄 3 | 3000 | M | 可変 | 〃 | ||
複数購入の場合の繰り返しここまで | ||||||||
33 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | 〃 | |
結果返却時にセットされる項目 | ||||||||
34 | res_pay_method | 処理結果 支払方法 | 20 | X | ○ | 可変 | 購入要求時に選択された支払方法です。 | |
35 | res_result | 処理結果ステータス | 2 | X | ○ | 固定 | OK:要求処理 OK CR:課金解約された CC:キャリア解約 CL:最終課金月による解約 | 詳細は こちら を参照ください。 |
36 | res_tracking_id | 処理トラッキング ID | 14 | X | ○ | 固定 | 購入時に当社が払出す ID | |
37 | res_sps_cust_no | 処理 SBPS 顧客 ID | 12 | 9 | 固定 | 当社で管理する顧客 ID | ||
38 | res_sps_payment_no | 処理 SBPS 支払方法管理番号 | 3 | 9 | 固定 | 当社で管理する支払方法管理番号 | ||
39 | res_payinfo_key | 顧客決済情報 | 145 | X | 可変 | 顧客決済情報 | 処理結果ステータスが OK の場合のみ、返却します。 ・クレジットカード決済:カード番号を元にした SBPS 独自の演算によるハッシュ値(頭0補完 16 桁) ・リクルートかんたん支払い:リクルートの注文番号(固定 15 桁) ※エンドユーザー支払い方法がコンビニ決済の場合は先頭に「webcvs,」の文字列が入りますので、 後日入金通知等を受け取ってください。 ・d 払い(キャリア・ウォレット):購入タイプが「定期購入」時、ドコモの承諾番号(固定 12 桁) ・ソフトバンクまとめて支払い(A):決済機関側の注文番号 ・請求書(コンビニ決済/総合振込/Payeasy):入金種別コード、入金額、入金累計額、 メールアドレスがカンマ(,)区切りで連結した英数字 ※請求書の入金種別コードは、1 桁の固定で通知内容は下記のとおりです。 P:速報/C:速報取消/D:確報/G:確報取消 ※収納会社によって存在しない入金種別コードがあります。 例:1 万円の速報入金で1万 5 千円の累積額の場合、 P,10000,15000,aaa@aaa.com となります。 ・銀聯ネット決済:銀聯トランザクション ID ・メルペイネット決済:ユーザー確認用取引 ID ・ウォレット決済サービス(Type-Y):クレカと PayPay 内訳金額がカンマ(,)区切りで連結した数字 (500,300:クレカ 500 円、 PayPay300 円の例) ・PayPay(オンライン決済):PayPay の決済番号 ・エポスかんたん決済 購入の場合 「クレジット利用金額 + “,” + クーポン利用金額 +”,” ポイント利用金額」 ※各項目、不使用の場合は「0」として返却 ・楽天ペイ(オンライン決済)V2:charge_id | |
40 | res_payment_date | 完了処理日時 | 14 | 9 | 可変 | YYYYMMDDHHMISS | 処理結果ステータス OK の場合、外部決済期間の処理日時となります。 処理結果ステータス NG の場合、処理日時が無い場合があります。 処理結果ステータス PY の場合、通知処理日となります。 | |
41 | res_err_code | エラーコード | 4 | X | 可変 | エラーコード一覧参照 | ||
42 | res_date | レスポンス日時 | 14 | 9 | ○ | 可変 | YYYYMMDDHHMISS | 当社がレスポンスした日時です。 |
43 | limit_second | レスポンス許容時間 | 4 | 9 | ○ | 可変 | 当社サーバのタイムスタンプと リクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 |
44 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
購入結果CGIにおける処理結果ステータスの種類
処理結果ステータスの種類は、以下の7種類です。
処理結果ステータス | 説明 |
---|---|
OK(決済処理 OK) | 決済処理が正常に行われた場合に通知します。 |
NG(決済処理 NG) | 決済処理が決済失敗した場合に通知します。 |
CR(継続課金(簡易)解約) | 継続課金(簡易)の月次課金処理が失敗した場合に通知します。 |
CC(キャリア解約) | 携帯の解約、継続商品の解約などにより翌月以降の継続課金(簡易)の課金が不可となった場合に通知します。 |
PY(入金通知) | オフライン決済で入金処理が実施されたことを通知します。 |
CN(期限切れ通知) | オフライン決済で払込票の支払期限が過ぎたことを通知します。 |
CL(最終課金月解約) | 最終課金月を迎えて継続課金(簡易)を停止した場合に通知します。 |
処理結果ステータスが通知されるタイミングと発生状況、および各処理結果ステータスに対する加盟店側のサービス提供の判断は、以下のとおりです。
処理結果ステータス | 通知タイミング | 加盟店側サービス提供 |
---|---|---|
OK(決済処理 OK) | 都度 | サービス提供する |
NG(決済処理 NG) | 都度 | サービス提供しない |
決済手段 | 処理結果ステータス | |
---|---|---|
OK | NG※1 | |
クレジットカード決済/ 本人認証サービス(EMV 3-Dセキュア) | ○ | - |
銀聯ネット決済 | ○ | - |
PayPay(オンライン決済) | ○ | - |
ソフトバンクまとめて支払い(A) | ○ | - |
ソフトバンクまとめて支払い(B) | ○ | - |
d払い(キャリア・ウォレット) | ○ | ○ |
auかんたん決済 | ○ | ○ |
WebMoney決済 | ○ | - |
BitCash決済 | ○ | - |
NET Cash決済 | ○ | - |
JCB PREMO決済 | ○ | - |
ウォレット決済サービス(Type-Y) | ○ | - |
楽天ペイ(オンライン決済)V2 | ○ | - |
Alipay+ | ○ | - |
PayPal決済 | ○ | - |
LINE Pay | ○ | - |
メルペイネット決済 | ○ | - |
ネットマイル決済 | ○ | - |
楽天Edy決済 | ○ | - |
モバイルSuica決済 | ○ | - |
Tポイントプログラム(オンライン決済) | ○ | - |
Apple Pay | ○ | - |
NP後払い | ○ | - |
au PAY(ネット支払い) | ○ | - |
エポスかんたん決済 | ○ | - |
WeChatPay | ○ | - |
処理結果ステータス | 通知タイミング | 加盟店側サービス提供 |
---|---|---|
OK(決済処理 OK) | 都度 | サービス提供する |
NG(決済処理 NG) | 都度 | サービス提供しない |
PY(入金通知) | 入金時 | サービス提供する |
CN(期限切れ通知) | 入金期限切れ時 | サービス提供しない |
決済手段 | 処理結果ステータス | |||
---|---|---|---|---|
OK | NG※3 | PY | CN | |
リクルートかんたん支払い | ○ | ○ | ○※2 | ○ |
コンビニ決済 | ○※1 | - | ○ | - |
Pay-easy決済 | ○※1 | - | ○ | - |
総合振込決済 | ○※1 | - | ○ | - |
※2:リクルートかんたん支払いについては、エンドユーザー支払い方法がコンビニ決済を含む場合に限ります。
※3:決済機関の仕様によっては、購入結果 CGI(A02-1)が実施されずエラー画面に遷移する場合があります。
処理結果ステータス | 通知タイミング | 加盟店側サービス提供 |
---|---|---|
OK(決済処理 OK) | 都度 | サービス提供する |
NG(決済処理 NG) | 都度 | サービス提供しない |
決済手段 | 処理結果ステータス | |
---|---|---|
OK | NG※1 | |
ソフトバンクまとめて支払い(B) | ○ | - |
d払い(キャリア・ウォレット) | ○ | ○ |
auかんたん決済 | ○ | ○ |
楽天ペイ(オンライン決済)V2 | ○ | - |
リクルートかんたん支払い | ○ | - |
処理結果ステータス | 通知タイミング | 加盟店側サービス提供 |
---|---|---|
OK(決済処理 OK) | 都度 | サービス提供する |
NG(決済処理 NG) | 都度 | サービス提供しない |
CR(継続課金(簡易)解約) | 月次(月初) | 即時サービス提供停止 |
CC(キャリア解約) | 日次 | 通知月の月末にサービス提供停止 |
CL(最終課金月解約) | 月次(月初) | サービス提供が終了していることを確認 |
決済手段 | 処理結果ステータス | ||||
---|---|---|---|---|---|
OK | NG※1 | CR | CC | CL | |
クレジットカード決済/ 本人認証サービス(EMV 3-Dセキュア) | ○ | - | ○ | - | - |
d払い(キャリア・ウォレット) | ○ | ○ | ○ | - | ○ |
auかんたん決済 | ○ | ○ | ○ | - | ○ |
リクルートかんたん支払い | ○ | - | ○ | ○※2 | ○ |
※2:リクルートかんたん支払いについては、エンドユーザー支払い方法がコンビニ決済を含む場合に限ります。
結果CGIレスポンス項目定義
機能 ID | A02-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 | A03-1 |
---|---|
処理名 | 購入結果(画面返却) |
流れ | ブラウザ→加盟店 |
接続先 | 指定された URL(完了) |
---|---|
送信メソッド | HTTP 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 | order_id | 購入 ID | 38 | X | ○ | 可変 | 〃 | |
8 | item_id | 商品 ID | 32 | X | ○ | 可変 | 〃 | |
9 | pay_item_id | 外部決済機関商品 ID | 32 | X | 可変 | 〃 | ||
10 | item_name | 商品名称 | 40 | M | 可変 | 〃 | ||
11 | tax | 税額 | 7 | 9 | 可変 | 〃 | ||
12 | amount | 金額(税込) | 7 | 9 | ○ | 可変 | 〃 | |
13 | pay_type | 購入タイプ | 1 | 9 | ○ | 固定 | 〃 | |
14 | auto_charge_type | 自動課金タイプ | 1 | 9 | △ | 固定 | 〃 | |
15 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 〃 | |
16 | div_settele | 決済区分 | 1 | 9 | △ | 固定 | 〃 | |
17 | last_charge_month | 最終課金月 | 6 | 9 | 固定 | 〃 | ||
18 | camp_type | キャンペーンタイプ | 1 | 9 | △ | 固定 | 〃 | |
19 | tracking_id | トラッキング ID | 14 | X | 固定 | 〃 | ||
20 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 〃 | ||
21 | free1 | 自由欄1 | 20 | M | 可変 | 〃 | ||
22 | free2 | 自由欄2 | 20 | M | 可変 | 〃 | ||
23 | free3 | 自由欄3 | 20 | M | 可変 | 〃 | ||
複数購入の場合は繰り返し(画面表示用項目) | ||||||||
24 | dtl_rowno | 明細行番号 | 2 | 9 | 可変 | 〃 | ||
25 | dtl_item_id | 明細商品 ID | 20 | X | 可変 | 〃 | ||
26 | dtl_item_name | 明細商品名称 | 40 | M | 可変 | 〃 | ||
27 | dtl_item_count | 明細数量 | 6 | 9 | 可変 | 〃 | ||
28 | dtl_tax | 明細税額 | 8 | 9 | 可変 | 〃 | ||
29 | dtl_amount | 明細金額(税込) | 8 | 9 | 可変 | 〃 | ||
30 | dtl_free1 | 明細自由欄 1 | 3000 | M | 可変 | 〃 | ||
31 | dtl_free2 | 明細自由欄 2 | 3000 | M | 可変 | 〃 | ||
32 | dtl_free3 | 明細自由欄 3 | 3000 | M | 可変 | 〃 | ||
複数購入の場合の繰り返しここまで | ||||||||
33 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | 〃 | |
結果返却時にセットされる項目 | ||||||||
34 | res_pay_method | 処理結果 支払方法 | 20 | X | ○ | 可変 | 購入要求時に選択された支払方法です。 | |
35 | res_result | 処理結果ステータス | 2 | X | ○ | 固定 | OK:要求処理 OK NG:要求 NG | |
36 | res_tracking_id | 処理トラッキング ID | 14 | X | 固定 | 購入時に当社が払出す ID | ||
37 | res_sps_cust_no | 処理 SBPS 顧客 ID | 12 | 9 | 固定 | 当社で管理する顧客 ID | ||
38 | res_sps_payment_no | 処理 SBPS 支払方法管理番号 | 3 | 9 | 固定 | 当社で管理する支払方法管理番号 | ||
39 | res_payinfo_key | 顧客決済情報 | 145 | X | 可変 | 顧客決済情報 | 処理結果ステータスが OK の場合のみ、返却します。 ・クレジットカード決済:カード番号を元にした SBPS 独自の演算によるハッシュ値(頭0補完 16 桁) ・リクルートかんたん支払い:リクルートの注文番号(固定 15 桁) ・d 払い(キャリア・ウォレット):購入タイプが「定期購入」時、ドコモの承諾番号(固定 12 桁) ・ソフトバンクまとめて支払い(A):決済機関側の注文番号 ・請求書:入金種別コード、入金額、入金累計額、メールアドレスがカンマ(,)区切りで連結した英数字 ※請求書の入金種別コードは、1 桁の固定で通知内容は下記のとおりです。 P:速報/C:速報取消/D:確報/G:確報取消 例:1 万円の速報入金で1万 5 千円の累積額の場合、 P,10000,15000,aaa@aaa.com となります。 ・銀聯ネット決済:銀聯トランザクション ID ・メルペイネット決済:ユーザー確認用取引 ID ・ウォレット決済サービス(Type-Y):クレカと PayPay 内訳金額がカンマ(,)区切りで連結した数字(500,300:クレカ 500 円、 PayPay300 円の例) ・PayPay(オンライン決済):PayPay の決済番号 ・楽天ペイ(オンライン決済)V2:charge_id | |
40 | res_payment_date | 完了処理日時 | 14 | 9 | 可変 | YYYYMMDDHHMISS | 処理結果ステータス OK の場合、外部決済期間の処理日時となります。 処理結果ステータス NG の場合、処理日時が無い場合があります。 処理結果ステータス PY の場合、通知処理日となります。 | |
41 | res_err_code | エラーコード | 4 | X | 可変 | エラーコード一覧参照 | ||
42 | res_date | レスポンス日時 | 14 | 9 | ○ | 可変 | YYYYMMDDHHMISS | 当社がレスポンスした日時です。 |
43 | limit_second | レスポンス許容時間 | 4 | 9 | ○ | 可変 | 当社サーバのタイムスタンプとリクエスト日時の差分許容時間 | 省略時は規定値(600)を適用します。 |
44 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
その他項目定義
確定通知(楽天ペイ(オンライン決済)、NP 後払いのみ)
※楽天ペイ(オンライン決済)V2 については確定通知機能はございません。
機能 ID | A04-1 |
---|---|
処理名 | 確定通知 |
流れ | 当社→加盟店 |
接続先 | 指定された 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 | order_id | 購入 ID | 38 | X | ○ | 可変 | 〃 | |
8 | item_id | 商品 ID | 32 | X | ○ | 可変 | 〃 | |
9 | pay_item_id | 外部決済機関商品 ID | 32 | X | 可変 | 〃 | ||
10 | item_name | 商品名称 | 40 | M | 可変 | 〃 | ||
11 | tax | 税額 | 7 | 9 | 可変 | 〃 | ||
12 | amount | 金額(税込) | 7 | 9 | ○ | 可変 | 〃 | |
13 | pay_type | 購入タイプ | 1 | 9 | ○ | 固定 | 〃 | |
14 | auto_charge_type | 自動課金タイプ | 1 | 9 | △ | 固定 | 〃 | |
15 | service_type | サービスタイプ | 1 | 9 | ○ | 固定 | 〃 | |
16 | div_settele | 決済区分 | 1 | 9 | △ | 固定 | 〃 | |
17 | last_charge_month | 最終課金月 | 6 | 9 | 固定 | 〃 | ||
18 | camp_type | キャンペーンタイプ | 1 | 9 | △ | 固定 | 〃 | |
19 | tracking_id | トラッキング ID | 14 | X | 固定 | 〃 | ||
20 | terminal_type | 顧客利用端末タイプ | 1 | 9 | 固定 | 〃 | ||
21 | free1 | 自由欄1 | 20 | M | 可変 | 〃 | ||
22 | free2 | 自由欄2 | 20 | M | 可変 | 〃 | ||
23 | free3 | 自由欄3 | 20 | M | 可変 | 〃 | ||
複数購入の場合は繰り返し(画面表示用項目) | ||||||||
24 | dtl_rowno | 明細行番号 | 2 | 9 | 可変 | 〃 | ||
25 | dtl_item_id | 明細商品 ID | 20 | X | 可変 | 〃 | ||
26 | dtl_item_name | 明細商品名称 | 40 | M | 可変 | 〃 | ||
27 | dtl_item_count | 明細数量 | 6 | 9 | 可変 | 〃 | ||
28 | dtl_tax | 明細税額 | 8 | 9 | 可変 | 〃 | ||
29 | dtl_amount | 明細金額(税込) | 8 | 9 | 可変 | 〃 | ||
30 | dtl_free1 | 明細自由欄 1 | 3000 | M | 可変 | 〃 | ||
31 | dtl_free2 | 明細自由欄 2 | 3000 | M | 可変 | 〃 | ||
32 | dtl_free3 | 明細自由欄 3 | 3000 | M | 可変 | 〃 | ||
複数購入の場合の繰り返しここまで | ||||||||
33 | request_date | リクエスト日時 | 14 | 9 | ○ | 固定 | 〃 | |
結果返却時にセットされる項目 | ||||||||
34 | res_pay_method | 処理結果 支払方法 | 20 | X | ○ | 可変 | 購入要求時に選択された支払方法です。 | |
35 | res_result | 処理結果ステータス | 2 | X | ○ | 固定 | OK:要求処理 OK NG:要求 NG | |
36 | res_tracking_id | 処理トラッキング ID | 14 | X | ○ | 固定 | 購入時に当社が払出す ID | |
37 | res_sps_cust_no | 処理 SBPS 顧客 ID | 12 | 9 | 固定 | 当社で管理する顧客 ID | ||
38 | res_sps_payment_no | 処理 SBPS 支払方法管理番号 | 3 | 9 | 固定 | 当社で管理する支払方法管理番号 | ||
39 | res_payinfo_key | 顧客決済情報 | 145 | X | 可変 | 楽天ペイ(オンライン決済) R01:与信結果 (定期・従量課金のみ) R02:金額変更結果 R03:売上結果 NP 後払い N01:取引登録結果 N02:与信結果 N03:売上結果 N04:取消結果 N05:返金結果 | 楽天ペイ(オンライン決済)、NP 後払いでの処理確定について、該当の処理区分値を設定します。 | |
40 | res_payment_date | 完了処理日時 | 14 | 9 | 可変 | YYYYMMDDHHMISS | 処理結果ステータス OK の場合、外部決済期間の処理日時となります。 処理結果ステータス NG の場合、処理日時が無い場合があります。 処理結果ステータス PY の場合、通知処理日となります。 | |
41 | res_err_code | エラーコード | 4 | X | 可変 | エラーコード一覧参照 | ||
42 | res_date | レスポンス日時 | 14 | 9 | ○ | 可変 | YYYYMMDDHHMISS | 当社がレスポンスした日時です。 |
43 | limit_second | レスポンス許容時間 | 4 | 9 | ○ | 可変 | リクエスト時の許容時間 | 省略時は規定値(600)を適用します。 |
44 | sps_hashcode | チェックサム | 40 | X | ○ | 固定 | 電文の値に対するチェックサム | 基本仕様 チェックサム値の生成方法についてをご参照ください。 |
※楽天ペイ(オンライン決済)
売上、金額変更、継続課金(定期・従量)購入については別途確定となりますので、本機能を用いて非同期で確定通知を行います。そのためサービス提供は、確定通知の受信後に実施をお願いします。
※NP 後払い
購入、売上、取消、返金については別途確定となりますので、本機能を用いて非同期で確定通知を行います。そのためサービス提供や停止は、確定通知の受信後に実施をお願いします。 購入は、取引登録結果、および与信結果の通知後に確定となります。
個別仕様
決済方法タグ「pay_method」について
pay_methodには支払方法を指定します。(複数指定可)
支払方法を選択すると、決済情報入力画面から選択された決済手段の画面へ遷移します。
省略時または複数指定時は当社にて決済選択画面を表示します。
複数指定時はカンマ区切りでご指定下さい。
※サービスタイプが「1:取消(月額課金解約)」の場合、必須でご指定ください。
※「yahoowallet:Yahoo!ウォレット決済」は 2021 年 4 月より 「yahoowallet2:ウォレット決済サービス(Type-Y)」に移管します。また、「yahoowallet:Yahoo!ウォレット決済」は 2020 年 9 月末で新規申込を終了します。
設定値一覧
設定値 | 決済方法 | 都度課金 | 継続課金(定期・従量) | 継続課金(簡易) |
---|---|---|---|---|
credit | クレジットカード決済 | ◯ | ◯ | |
credit3d2 | クレジットカード決済(本人認証サービス (EMV 3-D セキュア)) | ◯ | ◯ | |
unionpay | 銀聯ネット決済 | ◯ | ||
paypay | PayPay(オンライン決済) | ◯ | ◯ | |
webcvs | コンビニ決済 | ◯ | ||
payeasy | Pay-easy 決済 | ◯ | ||
banktransfer | 総合振込決済 | ◯ | ||
cyberedy | 楽天 Edy 決済(楽天 Edy) | ◯ | ||
mobileedy | 楽天 Edy 決済(モバイル楽天 Edy) | ◯ | ||
suica | モバイル Suica 決済 | ◯ | ||
webmoney | WebMoney 決済 | ◯ | ||
netcash | Net Cash 決済 | ◯ | ||
bitcash | BitCash 決済 | ◯ | ||
prepaid | JCB PREMO 決済 | ◯ | ||
docomo | d 払い(キャリア・ウォレット) | ◯ | ◯ | ◯ |
auone | au かんたん決済 | ◯ | ◯ | ◯ |
yahoowallet2 | ウォレット決済サービス(Type-Y) | ◯ | ||
yahoowalletdg | Yahoo!ウォレット決済(デジコン版) | ◯ | ||
rakuten | 楽天ペイ(オンライン決済) | ◯ | ◯ | |
rakutenv2 | 楽天ペイ(オンライン決済)V2 | ◯ | ◯ | |
recruit | リクルートかんたん支払い | ◯ | ◯ | ◯ |
softbank2 | ソフトバンクまとめて支払い(B) | ◯ | ◯ | |
alipay | Alipay+ | ◯ | ||
paypal | Paypal 決済 | ◯ | ||
netmile | ネットマイル決済 | ◯ | ||
mysoftbank | ソフトバンクまとめて支払い(A) | ◯ | ||
linepay | LINE Pay | ◯ | ||
merpay | メルペイネット決済 | ◯ | ||
tpoint | T ポイントプログラム(オンライン決済) | ◯ | ||
applepay | Apple Pay | ◯ | ||
nppostpay | NP 後払い | ◯ | ||
aupay | au PAY(ネット支払い) | ◯ | ||
eposeasypay | エポスかんたん決済 | ◯ | ||
wechatpay | WeChatPay | ◯ |
決済固有タグ「free_csv」について
クレジットカード決済 固有設定
リンク型のクレジットカード決済(本人認証サービス(EMV 3-Dセキュア))で本人認証に必要な設定ができます。
使用方法
《使用API》
接続方式 | API 種別 | データの流れ |
---|---|---|
リンク型 | 購入要求 | 加盟店→当社 |
《設定エレメント》
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義を参照ください。
タグエレメント名 | 項目名 | 桁数 | 型 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|
free_csv | 自由欄(CSV 形式) | 4000 | M | 可変 | 以下の設定方法を参照 | ※base64 エンコード必須になります。 API 型を併用する場合は 3DES による暗号化が必要になるケースがあります。 |
設定方法
(1)項目名+(2)接続文字(=半角イコール)+(3)項目値+(4)区切文字(,半角カンマ) …を連結していきます。
《項目定義》
設定内容 | 設定値 | 説明 | 桁数 | 型 | 備考 |
---|---|---|---|---|---|
項目名 | TDS2INFO_TOKEN | カード利用者の決済情報のトークン | X | 詳細は「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 |
PayPay(オンライン決済)固有設定
リンク型のPayPay(オンライン決済)では、指定売りのみ与信の有効期限を設定できます。 有効期限は、加盟店様が決済機関へ申し込まれた期限より短いものにしてください。
使用方法
《使用API》
接続方式 | API 種別 | データの流れ |
---|---|---|
リンク型 | 購入要求 | 加盟店→当社 |
《設定エレメント》
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義を参照ください。
タグエレメント名 | 項目名 | 桁数 | 型 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|
free_csv | 自由欄 (CSV 形式) | 4000 | M | 可変 | 以下の設定方法を参照 | ※base64 エンコード必須になります。 API 型を併用する場合は 3DES による暗号化が必要になるケースがあります。 |
設定方法
(1)項目名+(2)接続文字(=半角イコール)+(3)項目値+(4)区切文字(,半角カンマ) …を連結していきます。
《項目定義》
設定内容 | 設定値 | 説明 | 桁数 | 型 | 備考 |
---|---|---|---|---|---|
項目名 | PAYPAY_EXPIRED_DATETIME | 与信有効期限 | 20 | 9 | Epoctime で設定 |
ORDER_DESCRIPTION | 取引説明 | 255 | M | ||
TRANSITION_TYPE | 遷移種別 1 :アプリから遷移 (WebLink) / 2 :アプリから遷移 (DeepLink) | 1 | 9 | 加盟店アプリの WebView 設定が WebLink(Universal Links/App Links)の場合、設定値を「1」にしてください。 (推奨) 加盟店アプリの WebView 設定が DeepLink(Custom URL Scheme)の場合、設定値を「2」にしてください。 ※欄外の注意事項もご確認ください。 |
注意事項:TRANSITION_TYPEについて本項目についてはサービス説明資料「加盟店アプリ、PayPay アプリ連動について」もご確認ください。
PayPay(オンライン決済)において、ユーザー導線における外部ブラウザの起動を回避する目的で設置されている項目となります。ご利用の際には以下にご留意ください。
「2:アプリから遷移(DeepLink)」を設定した場合には、ユーザーのスマホにPayPayアプリがインストールされてない場合、決済が完了できません。
設定値「1:アプリから遷移(WebLink)」であればユーザーのスマホにPayPayアプリがインストールされていない場合でも
Webベースでの決済が可能のため、設定値は「1:アプリから遷移(WebLink)」が推奨となります。
「1:アプリから遷移(WebLink)」で解決出来ない問題等が発生した場合のみのご利用をお願いします。
なお、Androidにて、本機能を利用する際は、加盟店アプリのActivityの設定をlaunchModeがsingleTask または、 singleInstanceに設定していただく必要があります。通常はStandardが設定されておりますので、加盟店側アプリ実装
時には必ず本設定をお願いします。
《設定例》
- 設定値とその値を接続文字(半角イコール)で接続させ、区切文字(半角カンマ)で連結します。
PAYPAY_EXPIRED_DATETIME=1582862260,ORDER_DESCRIPTION=あいうえお
- 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 |
LINE Pay 固有設定
リンク型のLINE Payでは、LINE Pay画面において表示する商品画像URLをFreeCSV項目として連携が可能です。また、連携項目によりchannel web login画面の省略やLINE Payの処理中画面における文字言語の指定などが可能です。
使用方法
《使用API》
接続方式 | API 種別 | データの流れ |
---|---|---|
リンク型 | 購入要求 | 加盟店→当社 |
《設定エレメント》
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義を参照ください。
タグエレメント名 | 項目名 | 桁数 | 型 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|
free_csv | 自由欄(CSV 形式) | 4000 | M | 可変 | 以下の設定方法を参照 | ※base64 エンコード必須になります。 API 型を併用する場合は 3DES による暗号化が必要になるケースがあります。 |
設定方法
(1)項目名+(2)接続文字(=半角イコール)+(3)項目値+(4)区切文字(,半角カンマ) …を連結していきます。
《項目定義》
設定内容 | 設定値 | 説明 | 桁数 | 型 | 備考 | 例 |
---|---|---|---|---|---|---|
項目名 | PRODUCT_IMAGE_URL | 商品画像 URL | 500 | M | LINE Payアプリ画面にて表示する商品画像 URL※1 | https://stbfep.sps- system.com/material/spsdummy/i mg/button/bt_linepay.jpg |
LINE_MEMBER_ID | LINE 会員 ID | 50 | M | 決済を行う LINE 会員 mid※2 | LINEmid1234 | |
DELIVERY_PLACE_PHONE | 受取人連絡先 | 100 | M | LINEPay 内部の Risk Management で参照 | 0368892130 | |
LANG_CD | 決済待ち画面言語コード | 7 | X | 決済待画面の言語コード※3 | ja | |
CHECK_CONFIRM_URL_BROWS ER | 決済承認後遷移先 URL ブラウザチェック実施可否 | 5 | X | confirmUrl 遷移時の browser チェック可否※4 true:チェックを実施する/ false:チェックを実施しない | false | |
接続文字 | = | 半角イコール | – | – | – | – |
項目値 | 各項目に順ずる | 項目値毎バリデーション無し | – | – | – | – |
区切文字 | , | 半角カンマ | – | – | – | – |
※1:商品画像URLの設定がない場合は、アプリにて商品画像の表示はありません。
※2:LINE会員IDの連携がある場合、画面遷移時のchannel web login画面が省略されます。
※3:決済待ち画面言語コードは以下の6種の言語に対応しています。
- ja : 日本語
- ko : 韓国語
- en : 英語
- zh -Hans : 中国語 (簡体字 )
- zh -Hant : 中国語 (繁体字 )
- th : タイ語
※4:設定のない場合は初期値としてfalseの設定となります。
《設定例》
- 設定方法に則って連結文字を作成します。
PRODUCT_IMAGE_URL=https://stbfep.spssystem.com/material/spsdummy/img/button/bt_linepay.jpg,LANG_CD=ko
- 作成された連携文字をbase64方式にてエンコードします。
UFJPRFVDVF9JTUFHRV9VUkw9aHR0cHM6Ly9zdGJmZXAuc3BzLXN5c3RlbS5jb20vbWF0ZXJpYWw
vc3BzZHVtbXkvaW1nL2J1dHRvbi9idF9saW5lcGF5LmpwZyxMQU5HX0NEPWtv
- リンク型POST項目のfree_csvにセットし、送信します。
※API型を併用している場合は、(1)の後に3DES暗号化をし、(2)のエンコードが必要となります。詳細は、API型システム仕様書(基本仕様)を参照ください。
《バリデーションについて》
購入要求リクエスト時について、項目全体のバリデーションは実施しますが、各項目別のバリデーションは実施しません(入力画面に遷移した以降は、各項目別にバリデーションを行い、エラーとなった場合はエラー場面に遷移します)。
以下が、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 |
画面イメージ
上記例で送信された場合の画面イメージです。
《PCブラウザ画面(LINE Pay処理中画面)》
設定内容 | 設定値 | 説明 | 桁数 | 型 | 備考 | 例 |
---|---|---|---|---|---|---|
項目名 | PRODUCT_IMAGE_URL | 商品画像 URL | 500 | M | LINE Payアプリ画面にて表示する商品画像 URL※1 | https://stbfep.sps- system.com/material/spsdummy/i mg/button/bt_linepay.jpg |
LINE_MEMBER_ID | LINE 会員 ID | 50 | M | 決済を行う LINE 会員 mid※2 | LINEmid1234 | |
DELIVERY_PLACE_PHONE | 受取人連絡先 | 100 | M | LINEPay 内部の Risk Management で参照 | 0368892130 | |
LANG_CD | 決済待ち画面言語コード | 7 | X | 決済待画面の言語コード※3 | ja | |
CHECK_CONFIRM_URL_BROWS ER | 決済承認後遷移先 URL ブラウザチェック実施可否 | 5 | X | confirmUrl 遷移時の browser チェック可否※4 true:チェックを実施する/ false:チェックを実施しない | false | |
接続文字 | = | 半角イコール | – | – | – | – |
項目値 | 各項目に順ずる | 項目値毎バリデーション無し | – | – | – | – |
区切文字 | , | 半角カンマ | – | – | – | – |
※1:商品画像URLの設定がない場合は、アプリにて商品画像の表示はありません。
※2:LINE会員IDの連携がある場合、画面遷移時のchannel web login画面が省略されます。
※3:決済待ち画面言語コードは以下の6種の言語に対応しています。
- ja : 日本語
- ko : 韓国語
- en : 英語
- zh -Hans : 中国語 (簡体字 )
- zh -Hant : 中国語 (繁体字 )
- th : タイ語
※4:設定のない場合は初期値としてfalseの設定となります。
《設定例》
- 設定方法に則って連結文字を作成します。
PRODUCT_IMAGE_URL=https://stbfep.spssystem.com/material/spsdummy/img/button/bt_linepay.jpg,LANG_CD=ko
- 作成された連携文字をbase64方式にてエンコードします。
UFJPRFVDVF9JTUFHRV9VUkw9aHR0cHM6Ly9zdGJmZXAuc3BzLXN5c3RlbS5jb20vbWF0ZXJpYWw
vc3BzZHVtbXkvaW1nL2J1dHRvbi9idF9saW5lcGF5LmpwZyxMQU5HX0NEPWtv
- リンク型POST項目のfree_csvにセットし、送信します。
※API型を併用している場合は、(1)の後に3DES暗号化をし、(2)のエンコードが必要となります。詳細は、API型シス
テム仕様書(基本仕様)を参照ください。
《バリデーションについて》
購入要求リクエスト時について、項目全体のバリデーションは実施しますが、各項目別のバリデーションは実施しません(入力画面に遷移した以降は、各項目別にバリデーションを行い、エラーとなった場合はエラー場面に遷移します)。
以下が、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 |
画面イメージ
上記例で送信された場合の画面イメージです。
《PCブラウザ画面(LINE Pay処理中画面)》
《LINE Payアプリ画面》
オフライン決済 固有設定
オフライン決済(コンビニ決済、Pay-easy決済、総合振込決済)をリンク型で利用する場合、「free_csv」を利用することで以下のことが可能です。
- 電話番号やメールアドレスなどの決済に必要な情報やを初期入力値として画面に表示
- 支払期日をトランザクションごとに指定
使用方法
《使用API》
接続方式 | API 種別 | データの流れ |
---|---|---|
リンク型 | 購入要求 | 加盟店→当社 |
《設定エレメント》
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義を参照ください。
タグエレメント名 | 項目名 | 桁数 | 型 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|
free_csv | 自由欄(CSV 形式) | 4000 | M | 可変 | 以下の設定方法を参照 | ※base64 エンコード必須になります。 API 型を併用する場合は 3DES による暗号化が必要になるケースがあります。 |
設定方法
(1)項目名+(2)接続文字(=半角イコール)+(3)項目値+(4)区切文字(,半角カンマ) …を連結していきます。
《項目定義》
設定内容 | 設定値 | 説明 | 桁数 | 型 | 決済手段別の必須入力項目※1 | 備考 | ||
---|---|---|---|---|---|---|---|---|
コンビニ決済 | Pay-easy 決済 | 総合振込決済 | ||||||
項目名 | LAST_NAME | 姓 | 20 | M | ○ | ○ | ○ | 全角 |
FIRST_NAME | 名 | 20 | M | ○ | ○ | ○ | 全角 | |
LAST_NAME_KANA | 姓(カナ) | 20 | M | – | – | ○ | 全角カナ | |
FIRST_NAME_KANA | 名(カナ) | 20 | M | – | – | – | 全角カナ | |
FIRST_ZIP | 郵便番号(3 桁) | 3 | 9 | – | – | ○ | – | |
SECOND_ZIP | 郵便番号(4 桁) | 4 | 9 | – | – | ○ | – | |
ADD1 | 都道府県 | 50 | M | – | – | ○ | – | |
ADD2 | 市区町村・番地 | 50 | M | – | – | ○ | – | |
ADD3 | マンション・ビル名等 | 100※4 | M | – | – | – | – | |
TEL | 電話番号(ハイフン無し) | 11 | 9 | ○ | ○ | ○ | – | |
E-mail アドレス | 128 | X | ○ | ○ | ○ | 半角英数※3 | ||
BILL_DATE※5 | 支払期日(YYYYMMDD) | 8 | 9 | ○ | ○ | – | 半角数字 | |
BILL_DATE_TIME※ | 支払期日時間(YYYYMMDDHHMI) | 12 | 9 | ○ | ○ | – | 半角数字 | |
接続文字 | = | 半角イコール | – | – | – | – | – | – |
項目値 | 各項目に順ずる | 項目値毎バリデーション無し | – | – | – | – | – | – |
区切文字 | , | 半角カンマ | – | – | – | – | – | – |
※1:連携時の必須項目ではなく、連携後の決済情報入力画面での必須項目です。
※2:本節「free_csv項目内の、全角カナ指定項目で利用できる文字」を参照ください。
※3:本節「E-mailアドレス指定項目で利用できる文字」を参照ください。
※4:決済手段が総合振込の場合は、200バイトとなります。後述の印刷用制約にて、デリミタを使用する場合は、各項目
で100バイト以下かつデリミタ含めた合計値が200バイト以下である必要があります。
※5:BILL_DATEならびにBILL_DATE_TIMEについては、指定可能な決済手段・収納会社が限定され対象外の決済
手段については指定しても使われません。指定可否については、各決済手段のサービス仕様書を確認ください。
《設定例》
- 設定値とその値を接続文字(半角イコール)で接続させ、区切文字(半角カンマ)で連結します。
LAST_NAME=鈴木,FIRST_NAME=太郎,MAIL=test@ps.softbank.co.jp,・・・
- base64方式で変換します。
TEFTVF9OQU1FPZfpltgsRklSU1RfTkFNRT2RvphZLE1BSUw9dGVzdEBwc・・・
- リンク型POST項目のfree_csvに設定して、送信します。
※API型を併用している場合は、(1)の後に3DES暗号化をし、(2)のエンコードが必要となります。詳細は、API型シス
テム仕様書(基本仕様)を参照ください。
《バリデーションについて》
購入要求リクエスト時について、項目全体のバリデーションは実施しますが、各項目別のバリデーションは実施しません(入力画面に遷移した以降は、各項目別にバリデーションを行い、エラーとなった場合はエラー場面に遷移します)。
以下が、free_csvのバリデーション内容です。
- 送信された文字列が4000byte以下であること
- エンコードフォーマットがbase64方式であること
デコード後の文字列が2500byte以下であること
- リンク型POST項目のfree_csvに設定して、送信します。
※API型を併用している場合は、(1)の後に3DES暗号化をし、(2)のエンコードが必要となります。詳細は、API型シス
テム仕様書(基本仕様)を参照ください。
《バリデーションについて》
購入要求リクエスト時について、項目全体のバリデーションは実施しますが、各項目別のバリデーションは実施しません(入力画面に遷移した以降は、各項目別にバリデーションを行い、エラーとなった場合はエラー場面に遷移します)。
以下が、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 |
《free_csv項目内の、全角カナ指定項目で利用できる文字》以下は、姓(カナ) 名(カナ)項目で利用可能な文字です。
文字 | S-JIS コード |
---|---|
ァアィイゥウェエォオカガキギクグケゲコゴサザシジスズセゼソゾタダチヂッツヅテデトドナニヌネノハバパヒビピフブプヘベペホボポマミムメモャヤュユョヨラリルレロヮワヰヱヲンヴヵヶー | 8340~8396, 815B |
《free_csv 項目内の、E-mail アドレス指定項目で利用できる文字》以下は、E-mail アドレス項目で利用可能な文字です。
文字 | 名称 | S-JIS コード |
---|---|---|
ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz | 半角英字 | 0x41~0x5A 0x61~0x7A |
0123456789 | 半角数字 | 0x30~0x39 |
@ | 半角アットマーク | 0x40 |
. | 半角ピリオド | 0x2E |
_ | 半角アンダーバー | 0x5F |
– | 半角ハイフン | 0x2D |
画面イメージ
《連携時の画面イメージ》
コンビニ決済の場合は、以下の決済画面イメージとなります。
《紙払込票における制約》
紙払込票での受付の場合、ADD2とADD3が一行に連結されますが、ADD3にデリミタを用いることで会社名・部署名を
分け改行を入れて印刷することが可能です。
例: 住所 東京都港区東新橋1-9-2汐留住友ビル25F会社名 SBペイメントサービス株式会社
部署名 サービス本部サービス部
上記のように印刷したい場合、free_csvを以下のように設定します。
- ADD1=東京都
- ADD2=港区東新橋1-9-2
- ADD3=汐留住友ビル25F□□□SBペイメントサービス株式会社□□□サービス本部サービス部 ※□=全角スペース
※ADD3は200バイトまでとなりますが、デリミタを用いて建物名、会社名、部署名に分けた場合は、建物名100バイト、会社名60バイト、部署名100バイトとなります。 ※紙払込票の場合は、ADD1、ADD2、ADD3には半角文字は使用できません。
リクルートかんたん支払い 固有設定
リクルートかんたん支払いをリンク型で利用する場合、「free_csv」を利用することで以下のことが可能です。
- 支払期日をトランザクションごとに指定
使用方法
《使用API》
接続方式 | API 種別 | データの流れ |
---|---|---|
リンク型 | 購入要求 | 加盟店→当社 |
《設定エレメント》
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義を参照ください。
タグエレメント名 | 項目名 | 桁数 | 型 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|
free_csv | 自由欄(CSV 形式) | 4000 | M | 可変 | 以下の設定方法を参照 | ※base64 エンコード必須になります。 API 型を併用する場合は 3DES による暗号化が必要になるケースがあります。 |
設定方法
(1)項目名+(2)接続文字(=半角イコール)+(3)項目値+(4)区切文字(,半角カンマ) …を連結していきます。
《項目定義》
設定内容 | 設定値 | 説明 | 桁数 | 型 | 備考 |
---|---|---|---|---|---|
項目名 | BILL_DATE※ | 支払期日(YYYYMMDD) | 8 | 9 | 半角数字 |
BILL_DATE_TIME※ | 支払期日時間(YYYYMMDDHHMI) | 12 | 9 | 半角数字 |
※:BILL_DATEならびにBILL_DATE_TIMEについては、指定可能な決済手段・収納会社が限定され対象外の決済手段については指定しても使われません。指定可否については、各決済手段のサービス仕様書を確認ください。
エンドユーザー支払い方法がコンビニ決済を含む場合に限ります。
《設定例》
- 設定値とその値を接続文字(半角イコール)で接続させ、区切文字(半角カンマ)で連結します。
BILL_DATE =20170201
- base64方式で変換します。
TEFTVF9OQU1FPZfpltgsRklSU1RfTkFNRT2RvphZLE1BSUw9dGVzdEBwc・・・
- リンク型POST項目のfree_csvに設定して、送信します。
《バリデーションについて》
購入要求リクエスト時について、項目全体のバリデーションは実施しますが、各項目別のバリデーションは実施しません(入力画面に遷移した以降は、各項目別にバリデーションを行い、エラーとなった場合はエラー場面に遷移します)。
以下が、free_csvのバリデーション内容です。
- 送信された文字列が4000byte以下であること
- エンコードフォーマットがbase64方式であること
- デコード後の文字列が2500byte以下であること
制約
《制約について》
free_csvには、以下の制約がありますので、ご注意ください。
- 文字コードはS-JIS
- 項目名の大文字小文字は区別する
- 項目名に接続文字及び区切文字を含めてはいけない
- 項目値に区切文字を含めてはいけない
- 項目順序は意識しない
- 各項目は必須ではない
- 未定義の項目を設定しても問題はないが、その場合未定義の項目は無視する
- 入力画面に遷移した以降、エンドユーザーによる変更入力は返却されない
- 管理画面には、free_csvのデータ値自体は、表示されない
NP後払い 固有設定
リンク型のNP後払いでは、注文日やお客様情報をFreeCSV項目として連携する必要があります。
使用方法
《使用API》
接続方式 | API 種別 | データの流れ |
---|---|---|
リンク型 | 購入要求 | 加盟店→当社 |
《設定エレメント》
(型の凡例 X:シングルバイト文字型 M:ダブルバイト混在文字型 9:数値型)※使用できる文字の詳細は、基本仕様 使用可能なデータ型の定義を参照ください。
タグエレメント名 | 項目名 | 桁数 | 型 | タイプ | 設定内容 | 備考 |
---|---|---|---|---|---|---|
free_csv | 自由欄(CSV 形式) | 4000 | M | 可変 | 以下の設定方法を参照 | ※base64 エンコード必須になります。 API 型を併用する場合は 3DES による暗号化が必要になるケースがあります。 |
設定方法
(1)項目名+(2)接続文字(=半角イコール)+(3)項目値+(4)区切文字(,半角カンマ) …を連結していきます。
《項目定義》
設定内容 | 設定値 | 説明 | 桁数 | 型 | 備考 |
---|---|---|---|---|---|
項目名 | NP_ORDER_DATE | 加盟店注文日 | 8 | 9 | YYYYMMDD |
NP_COMPANY_NAME | 購入者会社名 | 60 | M | 全角文字のみを設定してください。 | |
NP_DEPARTMENT | 購入者部署名 | 60 | M | 全角文字のみを設定してください。 | |
NP_CUSTOMER_NAME | 購入者氏名 | 42 | M | 全角文字のみを設定してください。 | |
NP_CUSTOMER_NAME_KANA | 購入者氏名(カナ) | 50 | M | 全角カナのみを設定してください。 | |
NP_ZIP | 購入者郵便番号 | 7 | 9 | ||
NP_ADDRESS | 購入者住所 | 110 | M | 全角文字のみを設定してください。 | |
NP_TEL | 購入者電話番号 | 11 | 9 | ||
NP_EMAIL | 購入者メールアドレス | 100 | X | ||
NP_DEST_COMPANY_NAME | 配送先会社名 | 60 | M | 全角文字のみを設定してください。 | |
NP_DEST_DEPARTMENT | 配送先部署名 | 60 | M | 全角文字のみを設定してください。 | |
NP_DEST_CUSTOMER_NAME | 配送先氏名 | 42 | M | 全角文字のみを設定してください。 配送先郵便番号、配送先住所、配送先電話番号のいずれかが設定されている場合のみ必須です。 | |
NP_DEST_CUSTOMER_NAME_KA NA | 配送先氏名(カナ) | 50 | M | 全角カナのみを設定してください。 | |
NP_DEST_ZIP | 配送先郵便番号 | 7 | 9 | 配送先氏名、配送先住所、配送先電話番号のいずれかが設定されている場合のみ必須です。 | |
NP_DEST_ADDRESS | 配送先住所 | 110 | M | 全角文字のみを設定してください。 配送先氏名、配送先郵便番号、配送先電話番号のいずれかが設定されている場合のみ必須です。 | |
NP_DEST_TEL | 配送先電話番号 | 11 | 9 | 配送先氏名、配送先郵便番号、配送先住所のいずれかが設定されている場合のみ必須です。 |
《設定例》
- 設定値とその値を接続文字(半角イコール)で接続させ、区切文字(半角カンマ)で連結します。
NP_ORDER_DATE=20180901,NP_COMPANY_NAME=会社名・・・
- 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 |
特記事項
リンク型における Apple Pay 決済について
当社のリンク型における Apple Pay 決済は Apple Pay on the Web を利用しております。動作環境や制約につきましては、こちらを参照ください。