検索機能(Search)
本ドキュメントについて
本ガイドの内容
本ガイドは、株式会社DGフィナンシャルテクノロジーが提供するVeriTrans4Gを利用するための専用ソフトウェアMDK（Merchant Development Kit）をインターネット店舗などに導入する開発者向けのガイドです。VeriTrans4G検索機能にて使用する電文のインターフェース詳細について記載しています。
VeriTrans4Gの詳細については、『VeriTrans4G 開発ガイド』を参照して下さい。
尚、インターフェース詳細は、決済サービス毎に提供していますので、当該決済サービスのインターフェース詳細を参照して下さい。
（クレジットカード決済 インターフェース詳細 / ワンクリック継続課金(サブスクリプション)インターフェース詳細）
インターフェース詳細 ～検索～
本章では、検索機能で使用する電文（Dto）について説明します。以下の表に記載されているフィールドは、店舗様にて利用可能なフィールドです。
各電文（Dto）には、以下の表に記載されていないフィールドが定義されている場合がありますが、以下の表に記載されていないフィールドは店舗様では使用することはできません。
共通
-
「設定」欄の内容は以下の通りです。
- 要求電文 ...
- 必須項目：○ 任意項目：△ 設定不可：× その他条件付：※、※n（条件は説明欄、または欄外に記入）
- 応答電文 ...
- 必ず返戻：○ 処理成功時のみ返戻：△ 返戻なし：× その他条件付：※
-
複数指定は0～の添字を指定します。
例：exparam.serviceTypeCd[0]=card&exparam.serviceTypeCd[1]=paypal -
ワイルドカードは値の一部と"*"を組み合わせて検索します。"*"のみの指定はできません。
例：exparam.searchParameters.common.orderId=123*注） ワイルドカード検索につきましては、処理時間（応答時間）が非常に長くなる可能性がございますので、後方一致や中間一致のご指定は控えて頂きますようお願いいたします。また、他の検索条件と組み合わせることで対象範囲が限定されるような検索条件をご検討下さい。
-
FROM～TOの指定を行った際の検索はfromで指定した値以上、toで指定した値未満となります。
例：paidDatetime.from <=入 金日時 < paidDatetime.to
（重要）
検索条件は、決済サービス毎に様々な条件を指定可能ですが、原則として必ず「取引ID」を条件に含めた検索を行って頂きますようお願いします。取引IDを条件に含まない検索を実施された場合、データ量によってはレスポンス遅延や、想定外の結果が返戻される場合がございます。取引IDを含まない、複雑な条件での検索を実施される場合は、事前にテクニカルサポートまでご相談下さい。
検索
要求電文 ： SearchRequestDto
| 要求電文 ： SearchRequestDto | ||||||
|---|---|---|---|---|---|---|
| 検索フィールド名 | 検索項目名 | 書式・制限 | 複数 指定 |
ﾜｲﾙﾄﾞ ｶｰﾄﾞ |
説明 | 設定 |
| requestId | リクエストID | 半角英数字記号128文字以内 | リクエストIDを指定します。指定した場合は、それ以外のパラメータは指定できません。 | △ | ||
| serviceTypeCd | 決済サービスタイプ | 右記参照 | ○ | 検索対象の決済を指定 未指定の場合は、全決済が検索対象です。 "card"： カード決済 "cvs"： コンビニ決済 "em"： 電子マネー決済 "bank"：銀行決済 "upop"： 銀聯ネット決済（UPOP） "paypal"： PayPal決済 "alipay"：Alipay決済 "carrier"： キャリア決済 "oricosc"： ショッピングクレジット決済 |
△ | |
| newerFlag | 最新トランザクションフラグ | 右記参照 | 成功、失敗に関係なく、最新トランザクションのみを検索する場合に使用 "true"： 1取引内の最新トランザクションのみ検索 "false"： 全てのトランザクションを検索 ※指定しない場合は"false"になります。 |
△ | ||
| containDummyFlag | ダミー決済対象フラグ | 右記参照 | ダミー取引も検索する場合に使用 "true"： ダミー取引も検索する "false"： ダミー取引は検索しない ※指定しない場合は"false"になります。 |
△ | ||
| maxCount | 検索最大件数 | 1～1000 | 取得したい検索結果の最大件数 未指定の場合、最大値となります。 ※短時間で大量の検索を繰り返すような処理はサーバに負荷が掛かりますのでご遠慮頂けますようお願いします。 |
△ | ||
| common 共通 | |||||||
|---|---|---|---|---|---|---|---|
| orderId | 取引ID | 半角英数字100桁以内 | ○ | 検索したい取引IDを指定 | △ | ||
| orderStatus | 取引決済状態 | 右記参照 | ○ | 以下のいずれかを指定 " initial "：初期状態 " end "：終了 " end_presentation "：画面遷移正常終了 " pending "：保留 " validation_error "：検証エラー " expired "：期限切れ " error "：エラー |
△ | ||
| command | コマンド | 右記参照 | ○ | 決済で使用するコマンドを指定
※指定可能なコマンドは、決済サービス毎に異なります。 『VeriTrans4G 開発ガイド』の「利用可能なMDKコマンド」を参照して下さい。 |
△ | ||
| mstatus | ステータスコード | 右記参照 | ○ | 決済結果として返戻されるステータスコードを指定 " success "：成功 " failure "：失敗 " pending "：保留 |
△ | ||
| txnDatetime.from | 取引日（From） | 文字列12桁 | 取引日時の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| txnDatetime.to | 取引日（To） | 文字列12桁 | 取引日時の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| amount.from | 金額（From） | 数字12桁以内 | 決済金額の範囲（From）を指定 | △ | |||
| amount.to | 金額（To） | 数字12桁以内 | 決済金額の範囲（To）を指定 | △ | |||
| card クレジットカード決済 | |||||||
|---|---|---|---|---|---|---|---|
| detailOrderType | 詳細取引決済状態 | 右記参照 | ○ | 決済個別の詳細ステータスを指定 "a"：与信 "ax"：与信（期限切れ） "ap"：与信（保留） "ac"：与信売上 "acp"：与信売上（保留） "pa"：売上 "rn"：新規返品 "rnp"：新規返品（保留） "va"、"rad"、"rae"：与信→取消 "vap"、"rap"：与信→取消（保留） "vac"、"racd"、"race"：与信売上→取消 "vacp"、"racp"：与信売上→取消（保留） "vpa"、"rpad"、"rpae"：売上→取消 "vpap"、"rpap"：売上→取消（保留） |
△ | ||
| dddTransactionId | 3DトランザクションID | 半角英数字、"+"、"-"、"=" 28文字 or 0文字 |
3DトランザクションID（3d-xid）を指定 | △ | |||
| dddDsTransactionId | 3DDSトランザクションID | 半角英数字 36文字 or 0文字 |
3DDSトランザクションIDを指定 | △ | |||
| dddServerTransactionId | 3DサーバトランザクションID | 半角英数字 36文字 or 0文字 |
3DサーバトランザクションIDを指定 | △ | |||
| cvs コンビニ決済 | |||||||
|---|---|---|---|---|---|---|---|
| detailOrderType | 詳細取引決済状態 | 右記参照 | ○ | 決済個別の詳細ステータスを指定 "authorize"：決済請求 "cancel_authorize"：決済請求取消 "capture"：決済完了（入金済） "fix_capture"：決済完了（入金確定） "cancel_capture"：決済完了（入金取消） |
△ | ||
| cvsType | コンビニタイプ | 右記参照 | ○ | コンビニを指定 "sej"：セブン－イレブン "econ"：イーコン（ローソン、ファミリーマート、ミニストップ、セイコーマート） "other"：その他（デイリーヤマザキ） "famima"：ファミリーマート "lawson"：ローソン(ローソン、ミニストップ、セイコーマート) |
△ | ||
| payLimit.from | 支払期限（From） | 文字列12桁 | 支払期限の範囲（From）を指定 YYYYMMDDhhmm形式 ※支払期限日時(From)を指定している場合は、当項目の指定は不要 |
△ | |||
| payLimit.to | 支払期限（To） | 文字列12桁 | 支払期限の範囲（To）を指定 YYYYMMDDhhmm形式 ※支払期限日時(To)を指定している場合は、当項目の指定は不要 |
△ | |||
| payLimitDatetime.from | 支払期限日時（From） | 文字列12桁 | 支払期限日時の範囲（From）を指定 YYYYMMDDhhmm形式 ※決済申込時に支払期限時分を指定している場合は、指定した時分単位での絞り込みが可能 ※支払期限(From)を指定している場合は、当項目の指定は不要 |
△ | |||
| payLimitDatetime.to | 支払期限日時（To） | 文字列12桁 | 支払期限日時の範囲（To）を指定 YYYYMMDDhhmm形式 ※決済申込時に支払期限時分を指定している場合は、指定した時分単位での絞り込みが可能 ※支払期限(To)を指定している場合は、当項目の指定は不要 |
△ | |||
| paidDatetime.from | 入金受付日（From） | 文字列12桁 | 入金受付日の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| paidDatetime.to | 入金受付日（To） | 文字列12桁 | 入金受付日の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| em 電子マネー決済 | |||||||
|---|---|---|---|---|---|---|---|
| detailOrderType | 詳細取引決済状態 | 右記参照 | ○ | 決済個別の詳細ステータスを指定 "authorize"：決済請求 "refund"：返金請求 "refund_new"：新規返金請求 "cancel_authorize"：決済請求取消 "cancel_refund"：返金請求取消 "cancel_refund_new"：新規返金請求取消 "capture"：決済完了 "part_refund"：一部返金完了 "fix_refund"：返金完了 "fix_refund_new"：新規返金完了 |
△ | ||
| emType | 電子マネー種別 | 右記参照 | ○ | 電子マネーの種別を指定 "edy "： Edy決済 "suica "：Suica決済 "waon"：WAON決済 "tcc"：nanaco決済 |
△ | ||
| optionType | 支払い種別 | 右記参照 | ○ | 電子マネーの支払い種別を指定 "edy-mobile"：モバイルEdy "edy-pc"：Cybey Edy "edy-direct"： Edyダイレクト "suica-mobile-mail"：モバイル-メール決済 "suica-mobile-app"：モバイル-アプリ決済 "suica-pc-mail"：インターネット-メール決済 "suica-pc-app"：インターネット-アプリ決済 "waon-mobile"：モバイルアプリ決済 "waon-pc"：Pasori決済 "tcc-redirect"：nanaco決済 |
△ | ||
| settlementLimit.from | 支払/受取期限（From） | 文字列12桁 | 支払/受取期限の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| settlementLimit.to | 支払/受取期限（To） | 文字列12桁 | 支払/受取期限の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| completeDatetime.from | 支払完了日時（From） | 文字列12桁 | 支払完了日時の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| completeDatetime.to | 支払完了日時（To） | 文字列12桁 | 支払完了日時の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| receiptNo | 受付番号 | 文字列32文字以内 | 受付番号を指定 | △ | |||
| bank 銀行決済 | |||||||
|---|---|---|---|---|---|---|---|
| detailOrderType | 詳細取引決済状態 | 右記参照 | ○ | 決済個別の詳細ステータスを指定 "authorize"：決済請求 "bank_select"：金融機関選択 "paid_confirm"：入金確認 "capture"：収納情報通知 |
△ | ||
| optionType | 支払い種別 | 右記参照 | ○ | 銀行毎の決済方式を指定 "atm"：ATM決済 "netbank"：ネットバンク決済 |
△ | ||
| payLimit.from | 支払期限（From） | 文字列12桁 | 支払期限の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| payLimit.to | 支払期限（To） | 文字列12桁 | 支払期限の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| receivedDatetime.from | 収納日時（From） | 文字列12桁 | 収納日時の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| receivedDatetime.to | 収納日時（To） | 文字列12桁 | 収納日時の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| shunoKikanNo | 収納機関番号 | 半角英数字8桁以内 | ○ | 収納機関番号を指定 | △ | ||
| customerNo | お客様番号 | 半角英数字20桁以内 | ○ | お客様番号を指定 | △ | ||
| confirmNo | 確認番号 | 半角英数字6桁以内 | ○ | 確認番号を指定 | △ | ||
| upop 銀聯ネット決済（UPOP） | |||||||
| detailOrderType | 詳細取引決済状態 | 右記参照 | ○ | 決済個別の詳細ステータスを指定 "a0" : 与信請求 "a": 与信請求成功 "ax": 与信請求失敗 "av": 与信請求の取消 "pa": 売上 "pav": 売上の取消 "par": 返金(売上の返金，残りの返金可能金額は1円以上の場合) "pard": 返金(売上の返金，残りの返金可能金額は0円になった場合) "ac0": 与信売上請求 "ac": 与信売上請求成功 "acx": 与信売上請求失敗 "acv": 与信売上請求の取消 "acr": 返金(与信売上の返金，残りの返金可能金額は1円以上の場合) "acrd": 返金(与信売上の返金，残りの返金可能金額は0円になった場合) |
△ | ||
| settleDatetimeJp.from | 決済日時（From） ★日本時間 |
文字列12桁 | 決済日時の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| settleDatetimeJp.to | 決済日時（To) ★日本時間 |
文字列12桁 | 決済日時の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| settleDatetimeCn.from | 決済日時（From） ★中国時間 |
文字列12桁 | 決済日時の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| settleDatetimeCn.to | 決済日時（To) ★中国時間 |
文字列12桁 | 決済日時の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| paypal PayPal決済 | |||||||
| detailOrderType | 詳細取引決済状態 | 右記参照 | ○ | 決済個別の詳細ステータスを指定 "set_authorize"：決済請求(Authorize：Set) "get_authorize"：決済請求(Authorize：Get) "do_authorize"：決済請求(Authorize：Do) "set _capture"：決済請求(Capture：Set) "get_capture"：決済請求(Capture：Get) "do_capture"：決済請求(Capture：Do) "cancel_authorize"：取消 "do_capture"：売上 "reauthorize"：再与信 "refund"：返金 |
△ | ||
| paymentDatetime.from | 支払日時（From） | 文字列12桁 | 支払日時の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| paymentDatetime.to | 支払日時（To) | 文字列12桁 | 支払日時の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| invoiceId | 請求番号 | 半角英数字127文字以内 | ○ | 請求番号を指定 | △ | ||
| payerId | 顧客番号 | 半角英数字13文字以内 | ○ | 顧客番号を指定 | △ | ||
| alipay Alipay決済 | |||||||
| detailOrderType | 詳細取引決済状態 | 右記参照 | ○ | 決済個別の詳細ステータスを指定 "payment_request"：決済請求 "payment"：決済請求成功 "refund_request"：返金申込み請求 "refund"：返金成功（オンライン決済） 返金成功（バーコード決済：残りの返金可能金額が1円以上の場合） "void"：返金成功（バーコード決済：残りの返金可能金額が0円の場合） |
△ | ||
| centerTradeId | 決済センターとの取引ID | 文字列64文字以内 | 決済センターとの取引IDを指定 | △ | |||
| paymentTime.from | 支払日時（From） | 半角数字12桁以内 | 支払日時の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| paymentTime.to | 支払日時（To） | 半角数字12桁以内 | 支払日時の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| settlementTime.from | 清算日時(From) | 半角数字12桁以内 | 清算日時の範囲（From）を指定 YYYYMMDDhhmm形式 |
△ | |||
| settlementTime.to | 清算日時(To) | 半角数字12桁以内 | 清算日時の範囲（To）を指定 YYYYMMDDhhmm形式 |
△ | |||
| payType | 決済種別 | 半角数字 | 決済種別を指定 "0"：オンライン決済 "1"：バーコード決済（店舗スキャン型） "2"：バーコード決済（消費者スキャン型） |
△ | |||
| carrier キャリア決済 | |||||||
| detailOrderType | 詳細オーダー決済状態 | 右記参照 | ○ | 決済個別の詳細ステータスを指定 "Init"：決済申込 "Auth"：与信 "Deregistration"：抹消 "Terminate"：継続終了 "PostAuth"：売上 "VoidPostAuth"：取消(売上) "VoidAuth"：取消(与信) "AuthCapture"：与信売上 "VoidAuthCapture"：取消(与信売上) ※「detailOrderType」の詳細については、『キャリア決済サービス 補足資料』を参照 |
△ | ||
| crServiceType | キャリアサービスタイプ | 右記参照 | ○ | 決済申込時に指定したキャリア決済のタイプ（serviceOptionType） | △ | ||
| accountingType | 都度/継続区分 | 半角数字1桁 | 決済申込時に指定した都度/継続区分 | △ | |||
| itemType | 商品タイプ | 半角数字1桁 | ○ | 決済申込時に指定した商品タイプ | △ | ||
| mpStatus | 継続状態フラグ (月額課金状態フラグ) |
半角数字1桁 | ○ | 以下のいずれかを指定 "1"：継続中 "8"：抹消 "9"：終了 |
△ | ||
| terminalKind | 端末種別 | 半角数字1桁 | ○ | 決済申込時に指定した端末種別 | △ | ||
| detailCommandType | 詳細コマンドタイプ | 右記参照 | ○ | キャリア決済の詳細コマンドを指定 "PreOpenId"：OpenID事前認証 "PostOpenId"：OpenID認証 "PreAuth"：決済認可 "Auth"：与信 "MAuth"：与信(継続) "Deregistration"：抹消 "UserTerminatePreOpenId"：OpenID事前認証(継続終了) "UserTerminatePostOpenId"：OpenID認証(継続終了) "UserTerminatePreAuth"：決済認可(継続終了) "UserTerminate"：継続終了 "TerminateReq"：継続終了要求(強制) "Terminate"：継続終了(強制) "PostAuthReq"：売上要求 "PostAuth"：売上 "VoidPostAuthReq"：取消要求(売上) "VoidPostAuth"：取消(売上) "VoidAuthReq"：取消要求(与信) "VoidAuth"：取消(与信) "AuthCapture"：与信売上 "EmuAuth"：与信(与信売上エミュレート) "EmuPostAuthReq"：売上要求(与信売上エミュレート) "EmuPostAuth"：売上(与信売上エミュレート) "VoidAuthCaptureReq"：取消要求(与信売上) "VoidAuthCapture"：取消(与信売上) ※「detailCommandType」の詳細については、『キャリア決済サービス 補足資料』を参照 |
△ | ||
| mpFirstDate | 初回課金年月日 | 文字列8桁 | 決済申込時に指定した初回課金年月 | △ | |||
| mpDay | 継続課金日 | 文字列2桁以内 | 決済申込時に指定した継続課金日 | △ | |||
| itemId | 商品番号 | 半角英数字18桁以内 | ○ | 決済申込時に指定した商品番号 | △ | ||
| oricosc ショッピングクレジット決済 | |||||||
|---|---|---|---|---|---|---|---|
| detailOrderType | 詳細オーダー決済状態 | 右記参照 | ○ | 決済個別の詳細ステータスを指定 "authorize"：画面表示 "verify"：決済結果取得 "capture"：審査結果通知 "cancel"：途中キャンセル |
△ | ||
| oricoOrderNo | 注文番号 | 文字列20桁以内 | ○ | 画面表示要求時に指定した注文番号 | △ | ||
| amount. from | 支払金額合計 （from） |
文字列8桁以内 | 支払金額合計（from）を指定 0以上で指定します。 |
△ | |||
| amount.to | 支払金額合計 （to） |
文字列8桁以内 | 支払金額合計（to）を指定 99999999以下で指定します。 |
△ | |||
| totalItemAmount.from | 商品価格合計(税込)（from） | 文字列8桁以内 | 商品価格合計(税込)（from）を指定 0以上で指定します。 |
△ | |||
| totalItemAmount.to | 商品価格合計(税込)（to） | 文字列8桁以内 | 商品価格合計(税込)（to）を指定 99999999以下で指定します。 |
△ | |||
応答電文 ： SearchResponseDto
| 応答電文 ： SearchResponseDto | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 検索フィールド名 | 検索項目名 | 書式・制限 | 説明 | 設定 | ||||||||
| result | 処理結果 | － | ○ | |||||||||
| serviceType | サービスタイプ | 右記参照 | "search" | ○ | ||||||||
| mstatus | 処理結果コード | 半角英数字32 文字以内 | "success"：正常終了 "failure"：異常終了 |
○ | ||||||||
| vResultCode | 詳細結果コード | 半角英数字16 文字 | 処理の結果を詳細に表すコード 詳細は別途『結果コード一覧』を参照下さい。 |
○ | ||||||||
| merrMsg | エラーメッセージ | 文字列1024 バイト以内 | 処理結果を日本語で表示します。 | △ | ||||||||
| overMaxCountFlag | 最大件数超えフラグ | 右記参照 | 検索対象データが要求電文で指定した検索最大件数より多いかどうかを表示 "true"： 最大件数以上 "false"： 最大件数未満 |
△ | ||||||||
| searchCount | 検索結果件数 | 0～1000 | 検索結果件数（オーダー件数）が格納されます。 | △ | ||||||||
| orderInfos | オーダー情報リスト | 複数のオーダー情報（orderInfo）が格納されます。 | △ | |||||||||
| orderInfo | オーダー情報 | － | 検索条件に該当した取引の情報が該当件数分繰り返されます。0～1000件（要求電文で指定した検索最大件数まで）です。 | △ | ||||||||
| index | インデックス | 0～999 | 検索された情報のインデックス | △ | ||||||||
| serviceTypeCd | 決済サービスタイプ | 右記参照 | "card"： カード決済 "cvs"： コンビニ決済 "em"： 電子マネー決済 "bank"：銀行決済 "upop"： 銀聯ネット決済（UPOP） "paypal"： PayPal決済 "alipay"：Alipay決済 "carrier"： キャリア決済 "oricosc"： ショッピングクレジット決済 |
△ | ||||||||
| orderId | 取引ID | 文字列 | 取引の取引ID | △ | ||||||||
| orderStatus | 取引決済状態 | 右記参照 | " initial "：初期状態 " end "：終了 " end_presentation "：画面遷移正常終了 " pending "：保留 " validation_error "：検証エラー " expired "：期限切れ " error "：エラー ※このフィールドは、取引IDに関連する注文データの状態を完全に表現するものではありません。サービスタイプによっては詳細な状態遷移を別のフィールドに保持している場合がありますので、店舗側システムの用途に合わせてsuccessDetailTxnTypeや、決済固有の状態フィールドを参照してください。 |
△ | ||||||||
| lastSuccessTxnType | 最終成功トランザクションタイプ | 文字列 | 直近の成功したコマンド名 | △ | ||||||||
| successDetailTxnType | 詳細トランザクションタイプ | 文字列 | 取引の詳細な状態 検索要求電文の各決済の detailOrderType参照。 |
△ | ||||||||
| accountId | 会員ID | 半角英数字100桁以内 | 検索条件に該当した取引の会員ID | △ | ||||||||
| memo1 | 取引メモ1 | 文字列100文字以内 | 検索条件に該当した取引の取引に関するメモ情報
※最新のトランザクションで指定された値が返戻されます。 |
△ | ||||||||
| freeKey | キー情報 | 半角英数字256桁以内 | 検索条件に該当した取引の取引に関するキー情報
※最新のトランザクションで指定された値が返戻されます。 |
△ | ||||||||
| properOrderInfo | 固有オーダー情報 | － | 各決済サービスの固有オーダー情報 後述の一覧参照。 |
△ | ||||||||
| transactionInfos | 決済トランザクションリスト | － | 複数の決済トランザクション情報（transactionInfo） | △ | ||||||||
| transactionInfo | 決済トランザクション情報 | － | 検索条件に該当した取引の情報が該当件数分繰り返されます。 | △ | ||||||||
| txnId | トランザクション管理ID | 文字列 | 決済サーバーが採番する管理ID | △ | ||||||||
| command | コマンド | 文字列 | 実行されたコマンド名
※MDKで要求したコマンドだけではなく、決済サーバーの内部処理コマンドも含まれます。 |
△ | ||||||||
| mstatus | 処理結果コード | 半角英数字32 文字以内 | "success"：正常終了 "failure"：異常終了 "pending"：保留 |
△ | ||||||||
| vResultCode | 詳細結果コード | 文字列16桁 | 処理の結果を詳細に表すコード 詳細は別途『結果コード一覧』を参照下さい。 |
△ | ||||||||
| txnDatetime | 取引日時 | 文字列23桁 | YYYY-MM-DD hh:mm:ss.mmm形式 | △ | ||||||||
| amount | 金額 | 半角数字12桁以内 | 決済した金額 | △ | ||||||||
| properTransactionInfo | 固有トランザクション情報 | － | 各決済サービスの固有トランザクション情報 後述の一覧参照。 |
△ | ||||||||
| ☆ 以下の情報は、上記 「固有オーダー情報」 「固有トランザクション情報」 内の階層にセットされます。 | ||||||||||||
| properOrderInfo | クレジットカード決済 固有オーダー情報 | |||||||||||
| startTxn | 電文ID | 文字列 | △ | |||||||||
| requestCurrencyUnit | 要求通貨単位 | 半角英数字4桁以内 | △ | |||||||||
| cardExpire | カード有効期限 | 文字列5桁以内 | 有効期限（全桁平文） | △ | ||||||||
| properTransactionInfo | クレジットカード決済 固有トランザクション情報 | |||||||||||
| txnKind | トランザクション種類 | 文字列 | △ | |||||||||
| cardTransactionType | カードトランザクションタイプ | 文字列6桁以内 | 取引の詳細な状態 検索要求電文の各決済の detailOrderType参照。 |
△ | ||||||||
| gatewayRequestDate | ゲートウェイ要求日時 | 文字列14桁以内 | 決済サーバーが要求電文を受け取った日時 YYYYMMDDhhmmss形式 |
△ | ||||||||
| gatewayResponseDate | ゲートウェイ応答日時 | 文字列14桁以内 | 決済サーバーが応答電文を返した日時 YYYYMMDDhhmmss形式 |
△ | ||||||||
| centerRequestDate | センター要求日時 | 文字列14桁以内 | カード決済センターが要求電文を受け取った日時。YYYYMMDDhhmmss形式 | △ | ||||||||
| centerResponseDate | センター応答日時 | 文字列14桁以内 | カード決済センターが応答電文を返した日時。YYYYMMDDhhmmss形式 | △ | ||||||||
| centerRequestNumber | センター要求番号 | 文字列7桁以内 | △ | |||||||||
| centerReferenceNumber | センターリファレンス番号 | 文字列7桁以内 | △ | |||||||||
| reqItemCode | 要求商品コード | 文字列7桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| resItemCode | 応答商品コード | 文字列7桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqReturnReferenceNumber | 要求リターン参照番号 | 文字列12桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| responsedata | 応答データ | 文字列20桁以内 | △ | |||||||||
| pending | ペンディング | 文字列1桁以内 | "0"：なし "1"：あり | △ | ||||||||
| loopback | ループバック | 文字列1桁以内 | "0"：なし "1"：あり | △ | ||||||||
| connectedCenterId | 接続先カード接続センター | 文字列5桁以内 | △ | |||||||||
| reqCardNumber | 要求カード番号 | 文字列16桁以内 | 上6桁下2桁のみ数字表示され、その他は "*"（アスタリスク）１つに変換されます。 （例 "411111*11"） |
△ | ||||||||
| reqCardExpire | 要求カード有効期限 | 文字列5桁以内 | 全桁"*"（アスタリスク）に変換されます。 "*****" |
△ | ||||||||
| reqAmount | 要求取引金額 | 文字列12桁以内 | △ | |||||||||
| reqCardOptionType | 要求カードオプションタイプ | 文字列5桁以内 | △ | |||||||||
| reqMerchantTransaction | 要求マーチャントトランザクション番号 | 文字列9桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqAuthCode | 要求承認番号 | 文字列7桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqAcquirerCode | 要求仕向け先コード | 文字列2桁以内 | △ | |||||||||
| reqCardCenter | 要求カードセンター | 文字列7桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqJpoInformation | 要求支払種別情報 | 半角英数字83桁以内 | △ | |||||||||
| reqSalesDay | 要求売上日 | 文字列8桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqCancelDay | 要求取消日 | 文字列8桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqWithCapture | 要求同時売上 | 文字列5桁以内 | △ | |||||||||
| reqWithDirect | 要求同時直接 | 文字列5桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| req3dMessageVersion | 要求3Dメッセージバージョン | 文字列10桁以内 | △ | |||||||||
| req3dTransactionId | 要求3DトランザクションID | 文字列28桁以内 | △ | |||||||||
| req3dTransactionStatus | 要求3Dトランザクションステータス | 文字列1桁以内 | △ | |||||||||
| req3dCavvAlgorithm | 要求3D CAVVアルゴリズム | 文字列1桁以内 | △ | |||||||||
| req3dCavv | 要求3D CAVV | 文字列28桁以内 | △ | |||||||||
| req3dEci | 要求3D ECI | 文字列2桁以内 | △ | |||||||||
| req3dDsTransactionId | 要求3D DSトランザクションID | 文字列36桁以内 | △ | |||||||||
| req3dServerTransactionId | 要求3DサーバトランザクションID | 文字列36桁以内 | △ | |||||||||
| reqSecurityCode | 要求セキュリティコード | 文字列4桁以内 | 全桁"0"（ゼロ）に変換されます。 （例 "0000"） |
△ | ||||||||
| reqAuthFlag | 要求認証番号 | 文字列7桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqBirthday | 要求誕生日 | 文字列4桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqTel | 要求電話番号 | 文字列4桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqFirstKanaName | 要求カナ名前（名） | 文字列15桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reqLastKanaName | 要求カナ名前（姓） | 文字列15桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| resMerchantTransaction | 応答マーチャントトランザクション番号 | 文字列9桁以内 | △ | |||||||||
| resReturnReferenceNumber | 応答リターン参照番号 | 文字列12桁以内 | カード会社との通信時にシステム内部で利用する番号 通常、店舗様が意識する必要はありません。 |
△ | ||||||||
| resAuthCode | 応答承認番号 | 半角英数字スペース7桁以内 | カード会社が発行する承認番号 | △ | ||||||||
| resActionCode | アクションコード | 文字列3桁以内 | カード会社との通信時に返戻されたコード値 通常、店舗様が意識する必要はありません。 |
△ | ||||||||
| resCenterErrorCode | 応答センターエラーコード | 文字列3桁以内 | カード会社における結果コード(例 "G12") | △ | ||||||||
| resAuthTerm | 応答与信期間 | 文字列3桁以内 | △ | |||||||||
| reqWithNew | 要求新規返品 | 右記参照 | "true"： 新規返品 "false"： 取消・返品 ※現在はご利用いただくことはできません。 |
△ | ||||||||
| properOrderInfo | コンビニ決済 固有オーダー情報 | |||||||||||
| cvsType | 決済サービスオプション | 右記参照 | 決済されたコンビニの種別。 "sej"：セブン－イレブン "econ"：イーコン（ローソン、ファミリーマート、ミニストップ、セイコーマート） "other"：その他（デイリーヤマザキ） "famima"：ファミリーマート "lawson"：ローソン(ローソン、ミニストップ、セイコーマート) |
△ | ||||||||
| amount | 決済金額 | 半角数字6桁以内 | 支払金額 | △ | ||||||||
| name1 | 氏名１ | 全角20バイト以内 | 顧客姓
※全角ハイフン、全角スペース、外字は、文字化けする可能性があります |
△ | ||||||||
| name2 | 氏名２ | 全角20バイト以内 | 顧客名
※全角ハイフン、全角スペース、外字は、文字化けする可能性があります |
△ | ||||||||
| telNo | 電話番号 | 半角数字13桁以内 右記参照 |
顧客電話番号、数字のみ11桁以内、ハイフン含み13桁以内 例） 0311112222、03-1111-2222、09011112222、090-1111-2222 |
△ | ||||||||
| free1 | 備考１ | 文字列50バイト以内 | 備考欄（商品詳細などに利用する） | △ | ||||||||
| free2 | 備考２ | 文字列50バイト以内 | 備考欄（商品詳細などに利用する） | △ | ||||||||
| payLimit | 支払期限 | 半角数字10桁 右記参照 |
支払期限（YYYY/MM/DDの形式） | △ | ||||||||
| receiptNo | 受付番号 | 半角英数字32 文字以内 | コンビニへ正常に決済請求が完了した際に配布される受付番号 | △ | ||||||||
| paidDatetime | 入金受付日 | 文字列14桁以内 | 入金を受け付けた日（YYYYMMDDhhmmss形式） | △ | ||||||||
| properTransactionInfo | コンビニ決済 固有トランザクション情報 | |||||||||||
| cvsTxnType | 取引対象タイプ | 文字列 | 取引の詳細な状態 検索要求電文の各決済の detailOrderType参照。 |
△ | ||||||||
| startDatetime | 取引日時 | 文字列 | △ | |||||||||
| properOrderInfo | 電子マネー決済 固有オーダー情報 | |||||||||||
| settlementMethod | 決済方式 | 文字列 | △ | |||||||||
| settlementType | 決済タイプ | 文字列 | △ | |||||||||
| amount | 決済金額 | 半角数字5桁以内 | Edy、WAON、nanaco：￥50,000以下 Suica：￥20,000以下 |
△ | ||||||||
| settlementLimit | 決済期限 | 半角数字14桁 | 支払期限 （YYYYMMDDhhmmss） | △ | ||||||||
| mailAddr | メールアドレス | 半角英数字256桁以内 | 決済依頼メールの携帯電話メールアドレス CyberEdy ：未使用 |
△ | ||||||||
| forwardMailFlag | 転送メール送信要否 | 半角数字1桁 右記参照 |
決済依頼メール、決済完了メールのコピーメール又はBCC メールをマーチャントメールアドレス（merchantMailAddr）に送信するか否かの設定 "0"： 送信不要 "1"： 送信要 |
△ | ||||||||
| merchantMailAddr | マーチャントメールアドレス | 半角英数字256桁以内 | 決済依頼メール、決済完了メールのコピーメール又はBCC メール先マーチャントメールアドレス | △ | ||||||||
| cancelMailAddr | 取消返金通知メールアドレス | 半角英数字256文字以内 | 決済の取消完了を利用者に通知するためのメールアドレス | △ | ||||||||
| requestMailAddInfo | 依頼メール付加情報 | 半角英数字256桁以内 | 返金通知メールに追加される文字列（返金情報等） | △ | ||||||||
| completeMailAddInfo | 完了メール付加情報 | 文字列300バイト以内 | 決済完了メールに追加される文字列 | △ | ||||||||
| shopName | ショップ名 | 文字列48バイト以内 | Edy で使用する店舗名 | △ | ||||||||
| completeMailFlag | 完了メール送信要否 | 半角数字1桁 右記参照 |
決済完了時にメールを送信するか否かの設定 "0"： 送信不要 "1"： 送信要 |
△ | ||||||||
| confirmScreenAddInfo | 内容確認画面付加情報 | 文字列256バイト以内 | 内容確認画面に表示する付加情報 | △ | ||||||||
| completeScreenAddInfo | 完了画面付加情報 | 文字列256バイト以内 | 決済完了画面に表示する付加情報 | △ | ||||||||
| screenTitle | 画面タイトル | 文字列40バイト以内 | モバイルSuica で決済完了画面・決済確認画面等で「商品・サービス名」に表示される情報 | △ | ||||||||
| completeReturnKind | 決済完了戻り先種別 | 半角数字1桁 右記参照 |
モバイルSuica でアプリ終了時に遷移する先の種別 "1"： ローカルメニュー "2"： モバイルSuica アプリを終了し「決済完了戻り先URL」へ遷移 |
△ | ||||||||
| completeReturnUrl | 決済完了戻り先URL | 半角英数字256桁以内 | モバイルSuicaでアプリ終了時に遷移する先のURL | △ | ||||||||
| completeNoticeUrl | 決済完了通知URL | 半角英数字256桁以内 | Edy Viewer にて支払いを完了した後に遷移するURL | △ | ||||||||
| salesType | 販売区分 | 半角数字1桁 右記参照 |
Edy で任意に登録する販売区分 "1"：物販 "2"：デジタル |
△ | ||||||||
| free | 備考 | 文字列256バイト以内 | 備考(商品詳細など) | △ | ||||||||
| refundOrderCtlId | 返金取引ID | 文字列 | △ | |||||||||
| receiptNo | 受付番号 | 半角英数字64文字以内 | 決済センターへ正常に決済請求が完了した際に決済センターで採番される受付番号 | △ | ||||||||
| appUrl | 決済アプリ起動URL | 半角英数字384 文字以内 | Edy Viewerの起動URL、又はモバイルSuicaアプリURL | △ | ||||||||
| orderKind | オーダー種別 | 右記参照 | "authorize"： 決済 "refund"： 返金 "present"： プレゼント請求 |
△ | ||||||||
| completeDatetime | 完了日時 | 文字列14桁 | 支払が完了した日時（YYYYMMDDhhmmss形式） | △ | ||||||||
| reAuthorizeRedirectionUrl | 復旧リダイレクションURL | 半角英数字記号256桁以内 | 復旧処理後のリダイレクト先URL | △ | ||||||||
| transactionKind | 取引種別 | 半角数字2桁 | "01"：残高照会（予約語。現在はご利用いただけません。） "02"：電子マネー決済 |
△ | ||||||||
| userId | ユーザID | 半角英数字記号64桁以内 | 取引対象利用者を一意に特定可能なID 半角英数字の他に以下の記号も使用可能です（RFC2822の local-part に準拠します）。 "!"、"#"、"$"、"%"、"&"、"'"、"*"、"+"、"-"、"/"、"="、"?"、"^"、"_"、 "`"、"{"、"|"、"}"、"~". |
△ | ||||||||
| settlementId | 決済処理ID | 文字列256桁以内 | ※現在はご利用いただくことはできません。 |
△ | ||||||||
| reAuthAppUrl | 復旧用アプリ起動URL | 半角英数字380文字以内 | 復旧処理が成功した場合の復旧処理用URL | △ | ||||||||
| properTransactionInfo | 電子マネー決済 固有トランザクション情報 | |||||||||||
| emTxnType | 取引対象タイプ | 文字列 | 取引の詳細な状態 検索要求電文の各決済の detailOrderType参照。 |
△ | ||||||||
| centerProcDatetime | 取引日時 | 文字列 | △ | |||||||||
| startDatetime | 取引日時 | 文字列 | △ | |||||||||
| cardType | カード種別 | 半角数字2桁 | 電子マネーのカード種別 "00"：かざして決済 "10"：かざして決済以外 |
△ | ||||||||
| cardNo | 取引カード番号 | 半角数字4桁 | 消費者が取引に使用した電子マネーカードのカードID下4桁 | △ | ||||||||
| cardBrandCode | 取引カードブランドコード | 半角数字4桁 | ブランドを識別するコード "0001"：nanaco |
△ | ||||||||
| settlementStatus | 決済ステータス | 半角数字10桁 | "success"：決済完了 "failure"：決済失敗 "pending"：復旧処理が必要 |
△ | ||||||||
| properOrderInfo | 銀行決済 固有オーダー情報 | |||||||||||
| settlementMethod | 決済方式 | 文字列 | △ | |||||||||
| amount | 金額 | 半角数字10桁以内 | 決済した金額 | △ | ||||||||
| name1 | 顧客名１ | 全角20バイト以内 | △ | |||||||||
| name2 | 顧客名２ | 全角20バイト以内 | △ | |||||||||
| telNo | 電話番号 | 半角数字11桁以内 | △ | |||||||||
| payLimit | 支払期限 | 文字列8桁 | YYYYMMDD形式 | △ | ||||||||
| receivedDatetime | 収納日時 | 文字列12桁 | YYYYMMDDhhmm形式 | △ | ||||||||
| properTransactionInfo | 銀行決済 固有トランザクション情報 | |||||||||||
| peTxnType | 対象取引タイプ | 文字列 | 取引の詳細な状態 検索要求電文の各決済の detailOrderType参照。 |
△ | ||||||||
| receiptNo | 受付番号 | 半角数字、"-" 27桁 | 決済センターへ正常に決済請求が完了した際に決済センターで採番される受付番号 お客様番号（半角数字20桁）-確認番号（半角数字6桁） |
△ | ||||||||
| startDatetime | 取引日時 | 文字列 | △ | |||||||||
| properOrderInfo | 銀聯ネット決済（UPOP） 固有オーダー情報 | |||||||||||
| properTransactionInfo | 銀聯ネット決済（UPOP） 固有トランザクション情報 | |||||||||||
| upopTxnType | 取引タイプ | 文字列 | 下記の値が返戻されます： 01： 与信同時売上 02： 与信のみ 03： 与信→売上 31： 与信同時売上→取消 32： 与信のみ→取消 33： 与信→売上→取消 04： 売上→返金 |
△ | ||||||||
| amount | 取引金額 | 半角数字12 桁以内 | 支払い総額 | △ | ||||||||
| startDatetime | 取引日時 | 半角数字14桁 | YYYYMMDDhhmmss形式 | △ | ||||||||
| resUpopSettleAmount | 清算金額 | 半角数字12 桁以内 | 清算金額 | △ | ||||||||
| resUpopSettleDate | 清算日付 | 半角数字4桁 | MMDD形式 | △ | ||||||||
| resUpopSettleCurrency | 清算通貨種類 | 半角数字3桁以内 | △ | |||||||||
| resUpopExchangeDate | 両替日付 | 半角数字4桁 | MMDD形式 | △ | ||||||||
| resUpopExchangeRate | 清算為替レート | 半角数字8桁 | △ | |||||||||
| resUpopOrderId | 決済センターとの取引ID | 半角英数字20桁以内 | 決済センターとの取引ID
※拡張項目のため、ご利用の際には弊社までお問い合わせください。 |
△ | ||||||||
| properOrderInfo | PayPal決済 固有オーダー情報 | |||||||||||
| settlementMethod | 決済方式 | 文字列 | △ | |||||||||
| invoiceId | 請求番号 | 半角英数字127文字以内 | 決済サーバーが発番するオーダー単位でユニークとなるID | △ | ||||||||
| payerId | 顧客番号 | 半角英数字13文字以内 | △ | |||||||||
| paymentDatetime | 支払日時 | 文字列14桁 | YYYYMMDDhhmmss形式 | △ | ||||||||
| properTransactionInfo | PayPal決済 固有トランザクション情報 | |||||||||||
| ppTxnType | 対象取引タイプ | 文字列 | 取引の詳細な状態 検索要求電文の各決済の detailOrderType参照。 |
△ | ||||||||
| centerTxnId | 取引識別子 | 半角英数字19文字以内 | PayPalが発番するユニークなID | △ | ||||||||
| amount | 金額 | 半角数字 | △ | |||||||||
| feeAmount | 手数料 | 半角数字 | △ | |||||||||
| exchangeRate | 外貨換算レート | 半角英数字17文字以内 | △ | |||||||||
| netRefundAmount | 純返金金額 | 半角数字 | △ | |||||||||
| txnFixed | 決済完了フラグ | 右記参照 | 決済完了取引かどうかを示すフラグ "0"：決済レコード（速報レコード） "1"：決済完了レコード（確報レコード） |
△ | ||||||||
| startDatetime | 取引日時 | 文字列 | △ | |||||||||
| properOrderInfo | Alipay決済 固有オーダー情報 | |||||||||||
| properTransactionInfo | Alipay決済 固有トランザクション情報 | |||||||||||
| centerTradeId | 決済センターとの取引ID | 文字列64文字以内 | 決済センターとの取引ID | △ | ||||||||
| alipayTxnType | 対象取引タイプ | 文字列 | 下記の値が返戻されます： "payment_request"：決済請求 "payment"：決済請求 "refund_request"：返金申込み請求 "refund"：返金（オンライン決済） 返金（バーコード決済：残りの返金可能金額が1円以上の場合） "void"：返金（バーコード決済：残りの返金可能金額が0円の場合） "payment_request_fail"：決済請求失敗（バーコード決済（消費者スキャン型）：QRコード生成処理に失敗した場合） "payment_fail"：決済請求失敗 "payment_pending"：決済請求保留 "refund_fail"：返金失敗 "refund_pending"：返金保留 |
△ | ||||||||
| settleAmount | 清算金額 | 半角数字7桁 | 清算金額 | △ | ||||||||
| settleCurrency | 清算通貨 | 半角数字3 桁以内 | 清算通貨 | △ | ||||||||
| paymentTime | 支払日付 | 半角数字14桁以内 | YYYYMMDDhhmmss形式 | △ | ||||||||
| settlementTime | 清算日付 | 半角数字14桁以内 | YYYYMMDDhhmmss形式 | △ | ||||||||
| payType | 決済種別 | 半角数字 | 決済種別 "0"：オンライン決済 "1"：バーコード決済（店舗スキャン型） "2"：バーコード決済（消費者スキャン型） |
△ | ||||||||
| properOrderInfo | キャリア決済 固有オーダー情報 | |||||||||||
| crServiceType | キャリアサービスタイプ | 文字列 | 決済申込時に指定したキャリア決済のタイプ(serviceOptionType) | △ | ||||||||
| withCapture | 与信同時売上フラグ | 文字列 | 決済申込時に指定した与信同時売上フラグ | △ | ||||||||
| accountingType | 課金タイプ | 文字列1桁 | 決済申込時に指定した課金タイプ | △ | ||||||||
| itemInfo | 商品情報 | 文字列 | 決済申込時に指定した商品情報 | △ | ||||||||
| itemId | 商品ID | 文字列 | 決済申込時に指定した商品ID | △ | ||||||||
| itemType | 商品タイプ | 文字列1桁 | 決済申込時に指定した商品タイプ | △ | ||||||||
| terminalKind | 端末種別 | 文字列1桁 | 決済申込時に指定した端末種別 | △ | ||||||||
| authorizeDatetime | 決済申込日時 | 文字列14桁 | 決済申込日時（YYYYMMDDhhmmss形式） | △ | ||||||||
| captureDatetime | 売上日時 | 文字列14桁 | キャリア側で売上処理した日時 YYYYMMDDhhmmss形式 |
△ | ||||||||
| cancelDatetime | 取消日時 | 文字列14桁 | キャリア側で取消処理した日時 YYYYMMDDhhmmss形式 |
△ | ||||||||
| crOrderId | キャリアオーダーID | 文字列16桁以内 | キャリア側で発番された取引毎のID | △ | ||||||||
| d3Flag | 本人認証（3Dセキュア） | 文字列1桁 | 決済申込時に指定した値 "0"：無し、"1"：バイパス、 "2"：有り |
△ | ||||||||
| mpFirstDate | 初回課金日付 | 文字列8桁 | 決済申込時に指定した初回課金日付 | △ | ||||||||
| mpDay | 継続課金日 | 文字列2桁以内 | 決済申込時に指定した継続課金日 | △ | ||||||||
| mpStatus | 継続状態フラグ (月額課金状態フラグ) |
文字列1桁 | 継続状態フラグ (月額課金状態フラグ) "1"：継続中、"8"：抹消、"9"：終了 |
△ | ||||||||
| mpOrderId | 継続課金オーダーID | 文字列6桁 | 継続課金オーダーID （課金年月をYYYYMM形式で格納） |
△ | ||||||||
| mpTxnStatusType | 継続課金状態タイプ | 文字列 | 直近の継続課金処理によって、課金データがどのような状態に遷移したかを示します。 "Init"：初期状態 "VoidReq"：取消要求 "Void"：取消 "CaptureReq"：売上要求 "Capture"：売上 "CaptureFail"：売上失敗 "VoidCaptureReq"：売上取消要求 "VoidCapture"：売上取消 "VoidWait"：取消待ち ※Searchコマンドでは、継続課金のすべての売上データを取得することはできません。 ※「mpTxnStatusType」の詳細については、『キャリア決済サービス 補足資料』を参照してください。 |
△ | ||||||||
| mpCaptureDatetime | 継続売上日時 | 文字列14桁 | 継続売上日時（YYYYMMDDhhmmss形式） | △ | ||||||||
| mpCancelDatetime | 継続取消日時 | 文字列14桁 | 継続取消日時（YYYYMMDDhhmmss形式） | △ | ||||||||
| mpTerminateDatetime | 継続終了日時 | 文字列14桁 | 継続終了日時（YYYYMMDDhhmmss形式）
※「抹消」の場合は、キャリア側で抹消された日時、または決済サーバー側で抹消を検知した日時 |
△ | ||||||||
| fletsArea | フレッツエリア | 文字列1桁 | 決済申込時に指定した値 "0"：東日本、 "1"：西日本 |
△ | ||||||||
| properTransactionInfo | キャリア決済 固有トランザクション情報 | |||||||||||
| crResultCode | キャリア結果コード | 文字列 | キャリアから返却された結果コード | △ | ||||||||
| detailCommandType | 詳細コマンドタイプ | 文字列 | 検索要求電文のキャリア決済の detailCommandType参照。
※「detailCommandType」の詳細については、『キャリア決済サービス 補足資料』を参照してください。 |
△ | ||||||||
| crRequestDatetime | キャリアへの要求日時 | 文字列14文字 | キャリアへの要求日時（YYYYMMDDhhmmss形式） | △ | ||||||||
| crResponseDatetime | キャリアからの返戻日時 | 文字列14文字 | キャリアからの返戻日時（YYYYMMDDhhmmss形式） | △ | ||||||||
| properOrderInfo | ショッピングクレジット決済 固有オーダー情報 | |||||||||||
| merchantRedirectionUrl | マーチャントリダイレクションURL | URLに使用可能な半角英数字256桁以内 | マーチャントリダイレクションURL | △ | ||||||||
| oricoOrderNo | 注文番号 | 半角英数字 20桁以内 |
ショッピングクレジット用の注文番号 | △ | ||||||||
| userNo | 会員番号(加盟店) | 半角英数記号20桁以内 | 店舗の会員番号 | △ | ||||||||
| itemName1 | 商品名1 | 全角、半角英数記号 256桁以内 |
画面表示要求時に指定した商品名1 | △ | ||||||||
| itemCount1 | 数量1 | 半角数字3桁以内 | 画面表示要求時に指定した数量1 | △ | ||||||||
| itemAmount1 | 商品価格1(税込) | 半角数字記号8桁以内 | 画面表示要求時に指定した商品価格1（税込） | △ | ||||||||
| itemName2 | 商品名2 | 全角、半角英数記号 256桁以内 |
画面表示要求時に指定した商品名2 | △ | ||||||||
| itemCount2 | 数量2 | 半角数字3桁以内 | 画面表示要求時に指定した数量2 | △ | ||||||||
| itemAmount2 | 商品価格2(税込) | 半角数字記号8桁以内 | 画面表示要求時に指定した商品価格2（税込） | △ | ||||||||
| itemName3 | 商品名3 | 全角、半角英数記号 256桁以内 |
画面表示要求時に指定した商品名3 | △ | ||||||||
| itemCount3 | 数量3 | 半角数字3桁以内 | 画面表示要求時に指定した数量3 | △ | ||||||||
| itemAmount3 | 商品価格3(税込) | 半角数字記号8桁以内 | 画面表示要求時に指定した商品価格3（税込） | △ | ||||||||
| itemName4 | 商品名4 | 全角、半角英数記号 256桁以内 |
画面表示要求時に指定した商品名4 | △ | ||||||||
| itemCount4 | 数量4 | 半角数字3桁以内 | 画面表示要求時に指定した数量4 | △ | ||||||||
| itemAmount4 | 商品価格4(税込) | 半角数字記号8桁以内 | 画面表示要求時に指定した商品価格4（税込） | △ | ||||||||
| itemName5 | 商品名5 | 全角、半角英数記号 256桁以内 |
画面表示要求時に指定した商品名5 | △ | ||||||||
| itemCount5 | 数量5 | 半角数字3桁以内 | 画面表示要求時に指定した数量5 | △ | ||||||||
| itemAmount5 | 商品価格5(税込) | 半角数字記号8桁以内 | 画面表示要求時に指定した商品価格5（税込） | △ | ||||||||
| totalItemAmount | 商品価格合計(税込) | 半角数字8桁以内 | 画面表示要求時に指定した商品価格合計(税込) | △ | ||||||||
| totalCarriage | 送料合計(税込) | 半角数字8桁以内 | 画面表示要求時に指定した送料合計(税込) | △ | ||||||||
| amount | 支払金額合計 | 半角数字8桁以内 | 画面表示要求時に指定した支払金額合計 | △ | ||||||||
| deposit | 頭金 | 半角数字8桁以内 | 画面表示要求時に指定した頭金 | △ | ||||||||
| shippingZipCode | 配送先郵便番号 | 半角数字記号8桁 | 画面表示要求時に指定した配送先郵便番号（ハイフンを含む999-9999形式） | △ | ||||||||
| handlingContractNo | 取扱契約番号 | 半角英数字3桁以内 | 画面表示要求時に指定した取扱契約番号 | △ | ||||||||
| contractDocumentKbn | 契約書有無区分 | 半角数字1桁 | "0"：契約書無し "1"：契約書有り |
△ | ||||||||
| webDescriptionId | WEB申込商品ID | 半角英数字4桁以内 | 画面表示要求時に指定したWEB申込商品ID | △ | ||||||||
| properTransactionInfo | ショッピングクレジット決済 固有トランザクション情報 | |||||||||||
| oricoTxnType | オリコトランザクションタイプ | 右記参照 | "Authorize"：画面表示、 "Verify"：決済結果取得、 "Capture"：審査結果通知、 "Cancel"：途中キャンセル |
△ | ||||||||
| orderStateCode | 審査結果コード | 半角数字 2桁 | "02"：否決 "04"：承認 |
△ | ||||||||
| approvalNo | 承認番号 | 半角数字16桁以内 | 承認番号 審査結果が「"04"：承認」の場合に返戻されます。 |
△ | ||||||||
| requestDate | 申込日 | 半角数字8桁 | 申込日（YYYYMMDD 形式） | △ | ||||||||
| loanPrincipal | ローン元金 | 半角数字8桁以内 | ローン元金 | △ | ||||||||
| paymentCount | 支払回数 | 半角英数字3桁以内 | "1"～"999":普通分割支払回数 "B01":ボーナス一括 "B02":ボーナスニ括 |
△ | ||||||||
検索 マスタ情報取得
要求電文 ： SearchRequestDto
| 要求電文 ： SearchRequestDto | ||||||
|---|---|---|---|---|---|---|
| フィールド名 | 項目名 | 書式・制限 | 複数 指定 |
ﾜｲﾙﾄﾞ ｶｰﾄﾞ |
説明 | 設定 |
| masterNames | マスタ名 | 右記参照 | ○ | 以下の値より複数指定可（随時追加予定） "bankFinancialInstInfo" ： 金融機関マスタ |
○ | |
応答電文 ： SearchResponseDto
| 応答電文 ： SearchResponseDto | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | ||||||
| result | 処理結果 | 以下、処理結果が格納されます。 | ||||||||
| mstatus | 処理結果コード | 半角英数字32文字以内 | "success"：正常終了 "failure"：異常終了 |
○ | ||||||
| vResultCode | 詳細結果コード | 半角英数字16文字 | 処理の結果を詳細に表すコード 詳細は別途『結果コード一覧』を参照下さい。 |
○ | ||||||
| merrMsg | エラーメッセージ | 文字列1024 バイト以内 | 処理結果を日本語で表示します。 | △ | ||||||
| masterInfos | マスタ情報リスト | 複数のマスタ情報が格納されます。 | ||||||||
| masterInfo | マスタ情報 | 検索条件に該当した情報が該当件数分繰り返されます。 | ||||||||
| name | キー | 文字列 | マスタ名 | ○ | ||||||
| masters | 値 | マスタに含まれるレコード情報です。 | ||||||||
| xxxxxxxxx Info | マスタ固有情報 | |||||||||
|
☆ 以下の情報は、上記「マスタ固有情報」内にセットされます。 |
||||||||||
| bankFinancialInstInfo | 金融機関マスタ情報 | |||||||||
| bankCode | 金融機関コード | 文字列 | △ | |||||||
| deviceCode | デバイスコード | 文字列 | △ | |||||||
| bankName | 金融機関名称 | 文字列 | △ | |||||||
| bankKana | 金融機関カナ | 文字列 | △ | |||||||
| bankIndexChar1 | カナ頭文字 | 文字列 | △ | |||||||
| bankIndexChar2 | カナ行頭文字 | 文字列 | △ | |||||||
| startDatetime | 登録日時 | 文字列 | YYYYMMDDhhmmss形式 | △ | ||||||
ダミーマーチャントでの検索
ダミーマーチャント（テスト専用アカウント）で検索を実施した場合は、本番マーチャントIDと以下の点が異なっています。
- 決済サービスタイプ（serviceTypeCd）に空の値が存在した場合は、結果コード：NC04を返戻します。
- 決済サービスタイプ（serviceTypeCd）、リクエストID、取引ID（アスタリスクを含まない、完全一致の指定）を一つも指定していない場合、結果コード：NC04を返戻します。
- リクエストIDを指定していない場合、結果コードがNHｘｘのトランザクションレコードを抽出対象(検索対象、結果抽出対象)から除外します。