DGFT Veritrans4G開発ガイド

お問い合わせ
  • TOP
  • MDK(SDK)導入ガイド
  • MDK(SDK)インターフェースガイド

電子マネー決済

本ドキュメントについて

本ガイドの内容

本ガイドは、(株)DGフィナンシャルテクノロジーが提供するVeriTrans4Gを利用するための専用ソフトウェアMDK（Merchant Development Kit）をインターネット店舗などに導入する開発者向けのガイドです。VeriTrans4G 電子マネー決済にて使用する電文のインターフェース詳細について記載しています。
VeriTrans4Gの詳細については、『VeriTrans4G 開発ガイド』を参照して下さい。
尚、インターフェース詳細は、決済サービス毎に提供していますので、当該決済サービスのインターフェース詳細を参照して下さい。

インターフェース詳細

本章では、各決済にて使用する電文（Dto）について説明します。以下の表に記載されているフィールドは、店舗様にて利用可能なフィールドです。

各電文（Dto）には、以下の表に記載されていないフィールドが定義されている場合がありますが、以下の表に記載されていないフィールドは店舗様では使用することはできません。

共通

  • 「設定」欄の内容は以下の通りです。

    要求電文 ...
    必須項目：○　　任意項目：△　　設定不可：×　　その他条件付：※、※n（条件は説明欄、または欄外に記入）
    応答電文 ...
    必ず返戻：○　　処理成功時のみ返戻：△　　返戻なし：×　　その他条件付：※

  • orderId（取引ID）について

    店舗で任意に採番してください。申込処理毎に付ける必要があります。他の取引IDと重複しないよう採番してください。他決済サービスとも重複できません。
    また、テスト取引で使用した取引IDを、本番取引で再度使用することはできません。
    取引IDには、半角英数字以外に"-"（ハイフン）、"_"（アンダースコア）も使用可能です。

  • 設定欄のタイトルについて

    設定欄のタイトルは、下記の通り各決済サービスを示します。
    電子マネー毎に各フィールドの設定（必須項目、任意項目、設定不可等）が異なりますのでご注意ください。
    EMB：モバイルEdy　　EPC：サイバーEdy　　EDC：Edyダイレクト
    SMBM：モバイルSuica（メール決済）　　SMBA：モバイルSuica（アプリ決済）　　
    WMB：WAON（モバイルアプリ決済）　　WPC：WAON（Pasori決済）

  • 設定欄の「✔」について

    設定欄の「✔」は、電子マネー毎、当該フィールド中の各設定値が設定できるかどうかを示しています。設定できる設定値には「✔」が記載されています。
    当該フィールド中に「✔」の付けられた設定値が複数ある場合は、いずれかの値を選択し設定します。
    尚、当該フィールドの設定（必須項目、任意項目、設定不可等）自体は、「○」、「△」等で示されています。上記「「設定」欄の内容」を参照して下さい。
    当該フィールドの設定自体が「必須項目（○）」の場合、「✔」の付けられた設定値のいずれかの値の設定が必須となります。
    「任意項目（△）」の場合は、「✔」の付けられた設定値のいずれかの値を任意で設定することができます。
    例）電子マネー決済申込（楽天Edy）のEmAuthorizeRequestDtoのモバイルEdy（EMB）で「forwardMailFlag（転送メール送信要否）」を設定する場合

    1. 電子マネー決済申込（楽天Edy）のEmAuthorizeRequestDtoのモバイルEdy（EMB）の場合、「forwardMailFlag（転送メール送信要否）」は必須項目（○）です。
    2. 「✔」の付けられた「"0"：送信不要」、または「"1"：送信要」のどちらかを選択し、設定します。
    よって、（１）（２）より、「EmAuthorizeRequestDtoのモバイルEdy（EMB）の場合、「forwardMailFlag（転送メール送信要否）」には、「"0"：送信不要」、または「"1"：送信要」のどちらかを選択し、必須で設定しなければならない」となります。

申込（楽天Edy）

要求電文 ： EmAuthorizeRequestDto

要求電文 ： EmAuthorizeRequestDto
フィールド名 項目名 書式・制限 説明 設定
EMB EPC EDC
serviceOptionType 決済サービス
オプション		 右記参照 "edy-mobile"     ：モバイルEdy
"edy-pc"        ：サイバーEdy
"edy-direct"      ：Edyダイレクト		 ○ ○ ○
orderId 取引ID 半角英数字
100桁以内		 「2-1 共通」の 「orderId（取引ID）について」参照 ○ ○ ○
amount 決済金額 半角数字
5桁以内		 1以上50,000以下 ○ ○ ○
settlementLimit 決済期限 半角数字
14桁
右記参照		 支払期限（YYYYMMDDhhmmss）

※決済期限のチェックは決済サーバーの電文受信時のシステム日時を基準とします。

 ○ × ×
EMB 当日～90日後を決済期限に指定可能 ✔    
EPC
EDC		 10日固定   × ×
mailAddr メールアドレス 半角英数字
256桁以内		 決済依頼メールを送付する消費者の携帯電話メールアドレス
楽天Edy利用可能なおサイフケータイにおいて、初期設定・サービス登録が必要です。ドメイン指定受信を設定している場合は@bitwallet.co.jpを許可ドメインに加える必要があります。		 ○ × ×
forwardMailFlag 転送メール送信要否 半角数字
1桁
右記参照		 楽天Edyから消費者に通知する決済依頼メール、決済完了メールのコピーメール又はBCC メールを貴社受信用メールアドレス（merchantMailAddr）に送信するか否かを設定 ○ × ×
EMB "0"： 送信不要 ✔    
"1"： 送信要 ✔    
EPC
EDC		 設定不可   × ×
merchantMailAddr マーチャントメールアドレス 半角英数字
256桁以内		 楽天Edyから消費者に通知する決済依頼メール、決済完了メールのコピーメール又はBCC メールを受信するメールアドレス
以下の文字も使用できます。
"." (ドット)、"-" (ハイフン)、"_" (アンダースコア)、"@" (アットマーク)
複数指定時は","区切り指定して下さい。		 ※ × ×
EMB 転送メール送信要否（forwardMailFlag）に"1"： 送信要を設定した場合に設定必須 ✔    
EPC
EDC		 設定不可   × ×
requestMailAddInfo 依頼メール送信付加情報 文字列
256バイト以内		 決済依頼メールに追加される文字列（商品情報等） △ × ×
EMB 詳細は「3.1.1 Mobile Edy」の「Mobile Edy 決済開始メール」参照 ✔    
EPC
EDC		 設定不可   × ×
completeMailAddInfo 完了メール付加情報 文字列
300バイト以内		 決済完了メールに追加される文字列（遷移先URL等） △ × ×
EMB 詳細は「3.1.1 Mobile Edy」の「Mobile Edy 決済完了メール」参照 ✔    
EPC
EDC		 設定不可   × ×
shopName ショップ名 文字列
48バイト以内		 決済依頼メール、決済完了メールで使用する店舗名 △ × △
EMB 詳細は「3.1.1 Mobile Edy」の「Mobile Edy 決済開始メール」および「Mobile Edy 決済完了メール」参照 ✔    
EPC 設定不可   ×  
EDC 任意     ✔
completeNoticeUrl 決済完了通知URL 半角英数字
256桁以内		 支払いを完了した後に遷移するURL

※設定しない場合は無遷移

 × △ △

応答電文 ： EmAuthorizeResponseDto

応答電文 ： EmAuthorizeResponseDto
フィールド名 項目名 書式・制限 説明 設定
EMB EPC EDC
serviceType 決済サービスタイプ 半角英数字
10桁以内		 要求電文を送信した決済サービスタイプ ○ ○ ○
mstatus 処理結果コード 半角英数字
32文字以内		 "success"：正常終了
"failure"：異常終了
"pending"：保留		 ○ ○ ○
vResultCode 詳細結果コード 半角英数字
16文字		 処理の結果を詳細に表すコード
4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。		 ○ ○ ○
merrMsg エラーメッセージ 文字列1024 バイト以内 処理結果を日本語で表示します。 ○ ○ ○
marchTxn 電文ID 文字列
100桁以内		 決済サーバーにて決済処理電文（内部処理も含む）毎に付与するID
１つの取引IDに対して、複数のIDが付与されます。		 ○ ○ ○
orderId 取引ID 半角英数字
100文字以内		 決済要求時に店舗様にて任意に採番し送信された取引ID ○ ○ ○
custTxn 取引毎に付くID 文字列
100桁以内		 決済サーバーがオーダー（取引ID）と紐付ける為に採番するID ○ ○ ○
receiptNo 受付番号 半角英数字記号64文字以内 決済センターへ正常に決済請求が完了した際に決済センターで採番される受付番号 △ △ △
appUrl 決済アプリ起動URL 半角英数字
384文字以内		 決済処理が成功した場合、アプリ起動URL、決済センター側の決済画面URLを返却 × △ △
EMB 設定なし ×    
EPC Edy Viewerの起動URL

※楽天Edyの制御により、appUrl（決済アプリ起動URL）にアクセス後に支払いを中断すると再度アクセスする事ができず、決済を最初からやり直す必要があります。消費者様へ注意喚起される事をお勧めします。

   ✔  
EDC モバイルアプリの起動URL     ✔
txnVersion MDK バージョン 半角英数字
5桁		 電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。		 ○ ○ ○

キャンセル（楽天Edy）

楽天Edy決済はキャンセルが実施できません。

返金申込（楽天Edy）

※楽天Edy決済の返金受取期限は６０日間固定です。

要求電文 ： EmRefundRequestDto

要求電文 ： EmRefundRequestDto
フィールド名 項目名 書式・制限 説明 設定
EMB EPC EDC
serviceOptionType 決済サービスオプション 右記参照 "edy-mobile"     ：モバイルEdy
"edy-pc"        ：サイバーEdy
"edy-direct"      ：Edyダイレクト		 ○ ○ ○
orderId 取引ID 半角英数字100桁以内 「2-1 共通」の 「orderId（取引ID）について」参照 ○ ○ ○
amount 返金金額 半角数字5桁以内 返金金額。返金は一回のみ可能。
1以上　50,000以下、かつ決済申込時の金額以下		 ○ ○ ○
orderKind オーダー種別 半角英数字10桁以内 "refund"：返金　を指定 ○ ○ ○
refundOrderId 返金対象取引ID 半角英数字100文字以内 決済請求時に採番した取引ID ○ ○ ○
edyGiftName 返金名義 文字列32バイト以内
（全角16文字、半角32文字）		 返金用に用いられるEdyギフトの取得画面で表示される個別返金名義を設定したい場合に指定
未指定：『Edy決済返金』
指定：『Edy決済返金』＋指定名義		 △ △ △

応答電文 ： EmRefundResponseDto

応答電文 ： EmRefundResponseDto
フィールド名 項目名 書式・制限 説明 設定
EMB EPC EDC
serviceType 決済サービスタイプ 半角英数字10桁以内 要求電文を送信した決済サービスタイプ ○ ○ ○
mstatus 処理結果コード 半角英数字32文字以内 "success"：正常終了
"failure"：異常終了
"pending"：保留		 ○ ○ ○
vResultCode 詳細結果コード 半角英数字16 桁 処理の結果を詳細に表すコード
4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。		 ○ ○ ○
merrMsg エラーメッセージ 文字列1024 バイト以内 処理結果を日本語で表示します。 ○ ○ ○
marchTxn 電文ID 文字列100桁以内 決済サーバーにて決済処理電文（内部処理も含む）毎に付与するID
１つの取引IDに対して、複数のIDが付与されます。		 ○ ○ ○
orderId 取引ID 半角英数字100文字以内 決済要求時に店舗様にて任意に採番し送信された取引ID ○ ○ ○
custTxn 取引毎に付くID 文字列100桁以内 決済サーバーがオーダー（取引ID）と紐付ける為に採番するID ○ ○ ○
receiptNo 受付番号 半角英数字記号32文字以内 決済センターへ正常に返金請求が完了した際に決済センターで採番される受付番号 △ △ △
appUrl 決済アプリ起動URL 半角英数字384文字以内 【設定なし】 ※ ※ ※
txnVersion MDK バージョン 半角英数字桁 電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。		 ○ ○ ○

申込（Suica）

要求電文 ： EmAuthorizeRequestDto

要求電文 ： EmAuthorizeRequestDto
フィールド名 項目名 書式・制限 説明 設定
SMB M SMB A
serviceOptionType 決済サービスオプション 右記参照 "suica-mobile-mail" ：モバイルSuica（メール決済）
モバイルSuicaアプリの起動URLが載るメールをSuicaセンターより消費者に通知する。
"suica-mobile-app" ：モバイルSuica（アプリ決済）
モバイルSuicaアプリの起動リンクを決済サーバーより返戻する。即時誘導が可能。		 ○ ○
orderId 取引ID 半角英数字100桁以内 「2-1 共通」の 「orderId（取引ID）について」参照 ○ ○
amount 決済金額 半角数字5桁以内 1以上　20,000以下 ○ ○
settlementLimit 決済期限 半角数字14桁
右記参照		 支払期限（YYYYMMDDhhmmss）
当日～365日後を指定可能。5分以内の指定は不可。

※決済期限の上限・下限チェックは決済サーバーの電文受信時のシステム日時を基準とします。

 ○ ○
mailAddr メールアドレス 半角英数字256桁以内 決済依頼メールを送付する消費者の携帯電話メールアドレス ○ ×
forwardMailFlag 転送メール送信要否 半角数字1桁
右記参照		 Suica決済センターから消費者に通知する決済依頼メール、決済完了メールのコピーメール又はBCC メールを貴社受信用メールアドレス（merchantMailAddr）に送信するか否かを指定 △ ×
SMBM
 		 "0"： 送信不要 ✔  
"1"： 送信要 ✔  
SMBA 設定不可   ×
merchantMailAddr マーチャントメールアドレス 半角英数字256桁以内 Suica決済センターから消費者に通知する決済依頼メール、決済完了メールのコピーメール又はBCC メールを受信するメールアドレス
以下の文字も使用できます。"." (ドット)、"-" (ハイフン)、"_" (アンダースコア)、"@" (アットマーク)		 ※ ×
SMBM
 		 任意

※転送メール送信要否（forwardMailFlag）に "1"： 送信要を設定した場合は、設定必須

 ✔  
SMBA 設定不可   ×
requestMailAddInfo 依頼メール送信付加情報 文字列256バイト以内 決済依頼メールに追加される文字列（商品情報等）

※詳細は「3.1.2 モバイルSuica」の「モバイルSuica決済依頼メール」参照

 △ ×
completeMailAddInfo 完了メール付加情報 文字列300バイト以内 決済完了メールに追加される文字列（遷移先URL等）

※完了メール送信要否（completeMailFlag）に "0"： 送信不要を設定し、かつ本項目を設定していた場合はエラーが発生します。

 △ △
completeMailFlag 完了メール送信要否 半角数字1桁
右記参照		 Suica決済センターから消費者に決済完了時にメールを送信するか否かを指定
"0"： 送信不要
"1"： 送信要

※本項目を未設定（null）とした場合、デフォルトで"0"： 送信不要が設定されます。
※本項目で"１"：送信要を設定した場合でも、完了メール付加情報（completeMailAddInfo）の設定は必須ではありません。完了メール付加情報（completeMailAddInfo）を未設定（null）とすることも可能です。

 △ △
confirmScreenAddInfo 内容確認画面付加情報 文字列256バイト以内 内容確認画面に表示する付加情報

※詳細は「3.2.2 モバイルSuica」の「モバイルSuica決済内容確認画面」参照

 △ △
completeScreenAddInfo 完了画面付加情報 文字列256バイト以内 決済完了画面に表示する付加情報

※詳細は「3.2.2 モバイルSuica」」の「モバイルSuica決済完了画面」参照

 △ △
screenTitle 画面タイトル 文字列40バイト以内 決済完了画面・決済確認画面等で「商品・サービス名」に表示される文字列

※詳細は「3.2.2 モバイルSuica」の「モバイルSuica決済内容確認画面」および「モバイルSuica決済完了画面」参照

以下の文字が設定可能です。

  • 半角英数字
  • 半角記号（但し以下を除く　　^ （ハット）、` （バッククォート）、{ } （中括弧）、| （縦棒）、~ （チルダ））
  • 全角文字
 ○ ○

応答電文 ： EmAuthorizeResponseDto

応答電文 ： EmAuthorizeResponseDto
フィールド名 項目名 書式・制限 説明 設定
SMB M SMB A
serviceType 決済サービスタイプ 半角英数字10桁以内 要求電文を送信した決済サービスタイプ ○ ○
mstatus 処理結果コード 半角英数字32文字以内 "success"：正常終了
"failure"：異常終了
"pending"：保留		 ○ ○
vResultCode 詳細結果コード 半角英数字16文字 処理の結果を詳細に表すコード
4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。		 ○
 		 ○
 
merrMsg エラーメッセージ 文字列1024 バイト以内 処理結果を日本語で表示します。 ○ ○
marchTxn 電文ID 文字列100桁以内 決済サーバーにて決済処理電文（内部処理も含む）毎に付与するID
１つの取引IDに対して、複数のIDが付与されます。		 ○ ○
orderId 取引ID 半角英数字100文字以内 決済要求時に店舗様にて任意に採番し送信された取引ID ○ ○
custTxn 取引毎に付くID 文字列100桁以内 決済サーバーがオーダー（取引ID）と紐付ける為に採番するID ○ ○
receiptNo 受付番号 半角英数字64文字以内 決済センターへ正常に決済請求が完了した際に決済センターで採番される受付番号 △ △
appUrl 決済アプリ起動URL 半角英数字384文字以内 処理が成功した場合、アプリ起動URL、決済センター側の決済画面URLを返却 × △
SMBM 設定無し ×  
SMBA アプリ起動URL   ✔
txnVersion MDK バージョン 半角英数字5桁 電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。		 ○ ○

キャンセル（Suica）

要求電文 ： EmCancelRequestDto

要求電文 ： EmCancelRequestDto
フィールド名 項目名 書式・制限 説明 設定
SMB M SMB A
serviceOptionType 決済サービスオプション 右記参照 キャンセル対象の取引の、決済した方式を指定
"suica-mobile-mail" ：モバイルSuica（メール決済）
"suica-mobile-app" ：モバイルSuica（アプリ決済）		 ○ ○
orderId 取引ID 半角英数字100桁以内 決済請求時に採番した取引ID ○ ○
orderKind オーダー種別 右記参照 キャンセル対象のオーダー種別を指定
"authorize"： 決済申込
"refund"： 返金申込		 ○ ○

応答電文 ： EmCancelResponseDto

応答電文 ： EmCancelResponseDto
フィールド名 項目名 書式・制限 説明 設定
SMB M SMB A
serviceType 決済サービスタイプ 半角英数字10桁以内 要求電文を送信した決済サービスタイプ ○ ○
mstatus 処理結果コード 半角英数字32文字以内 "success"：正常終了
"failure"：異常終了
"pending"：保留		 ○ ○
vResultCode 詳細結果コード 半角英数字16文字 処理の結果を詳細に表すコード
4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。		 ○ ○
merrMsg エラーメッセージ 文字列1024 バイト以内 処理結果を日本語で表示します。 ○ ○
marchTxn 電文ID 文字列100桁以内 決済サーバーにて決済処理電文（内部処理も含む）毎に付与するID
１つの取引IDに対して、複数のIDが付与されます。		 ○ ○
orderId 取引ID 半角英数字100文字以内 決済要求時に店舗様にて任意に採番し送信された取引ID ○ ○
custTxn 取引毎に付くID 文字列100桁以内 決済サーバーがオーダー（取引ID）と紐付ける為に採番するID ○ ○
txnVersion MDK バージョン 半角英数字5桁 電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。		 ○ ○

返金申込（Suica）

要求電文 ： EmRefundRequestDto

要求電文 ： EmRefundRequestDto
フィールド名 項目名 書式・制限 説明 設定
SMB M SMB A
serviceOptionType 決済サービスオプション 右記参照 返金対象の取引の、決済した方式を指定
"suica-mobile-mail" ：モバイルSuica（メール決済）
"suica-mobile-app" ：モバイルSuica（アプリ決済）		 ○ ○
orderId 取引ID 半角英数字100桁以内 「2-1 共通」の 「orderId（取引ID）について」参照 ○ ○
amount 返金金額 半角数字5桁以内 返金金額を指定。返金は一回のみ可能。
1以上　20,000以下、 かつ決済申込時の金額以下		 ○ ○
orderKind オーダー種別 半角英数字10桁以内 "refund"：返金　を指定 ○ ○
refundOrderId 返金対象取引ID 半角英数字100文字以内 決済請求時に採番した取引IDを指定します。 ○ ○
settlementLimit 返金受取期限 半角数字14桁
右記参照		 YYYYMMDDhhmmss形式
返金申込当日5分後から60日以内で指定可能です。		 ○ ○
mailAddr メールアドレス 半角英数字256桁以内 返金する取引において指定した消費者の携帯電話メールアドレス △ ×
SMBM
 		 任意

※設定されない場合は事前にJR東日本に登録されたメールアドレスが適用されます。

 ✔  
SMBA 設定不可   ×
forwardMailFlag 転送メール送信要否 半角数字1桁
右記参照		 返金通知メールのコピー又はBCCメールをマーチャントメールアドレス（merchantMailAddr）に送信するか否かを指定

※返金の場合は、返金完了メールは消費者に通知されません。

 △ ×
SMBM
 		 "0"： 送信不要 ✔  
"1"： 送信要 ✔  
SMBA 設定不可   ×
merchantMailAddr マーチャントメールアドレス 半角英数字256桁以内 返金通知メールのコピーメール又はBCC メール先マーチャントメールアドレス以下の文字も使用できます。
"."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)		 ※ ×
SMBM
 		 任意

※転送メール送信要否（forwardMailFlag）に"1"： 送信要を設定した場合、設定必須

 ✔  
SMBA 設定不可   ×
requestMailAddInfo 返金通知メール付加情報 半角英数字256桁以内 返金通知メールに追加される文字列（返金情報等）

※詳細は「3.2.2 モバイルSuica」の「Suicaポケット発行メール（返金）」参照

 △ ×
SMBM 任意 ✔  
SMBA 設定不可   ×
requestMailFlag 返金通知メール送信要否 半角数字1桁
右記参照		 Suica決済センターから消費者に返金通知メールの送信要否を指定 △ ×
SMBM
 		 "0"： 送信不要 ✔  
"1"： 送信要

※特に理由がない場合は、"1"：送信要に設定願います。

 ✔  
SMBA 設定不可   ×
confirmScreenAddInfo 内容確認画面付加情報 文字列256バイト以内 返金内容確認画面に表示する付加情報

※詳細は「3.2.2 モバイルSuica」の「Suicaポケット受取内容確認画面（返金）」参照

 △ △
completeScreenAddInfo 完了画面付加情報 文字列256バイト以内 返金受取完了画面に表示する付加情報

※詳細は「3.2.2 モバイルSuica」の「Suicaポケット受取完了画面（返金）」参照

 △ △
screenTitle 画面タイトル 文字列40バイト以内 返金内容確認、返金受取完了画面などで「商品・サービス名」に表示される文字列

※詳細は「3.2.2 モバイルSuica」の「Suicaポケット受取内容確認画面（返金）」および「Suicaポケット受取完了画面（返金）」参照

 △ △

応答電文 ： EmRefundResponseDto

応答電文 ： EmRefundResponseDto
フィールド名 項目名 書式・制限 説明 設定
SMB M SMB A
serviceType 決済サービスタイプ 半角英数字10桁以内 要求電文を送信した決済サービスタイプ ○ ○
mstatus 処理結果コード 半角英数字32文字以内 "success"：正常終了
"failure"：異常終了
"pending"：保留		 ○ ○
vResultCode 詳細結果コード 半角英数字16 桁 処理の結果を詳細に表すコード
4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。		 ○ ○
merrMsg エラーメッセージ 文字列1024 バイト以内 処理結果を日本語で表示します。 ○ ○
marchTxn 電文ID 文字列100桁以内 決済サーバーにて決済処理電文（内部処理も含む）毎に付与するID
１つの取引IDに対して、複数のIDが付与されます。		 ○ ○
orderId 取引ID 半角英数字100文字以内 決済要求時に店舗様にて任意に採番し送信された取引ID ○ ○
custTxn 取引毎に付くID 文字列100桁以内 決済サーバーがオーダー（取引ID）と紐付ける為に採番するID ○ ○
receiptNo 受付番号 半角英数字32文字以内 決済センターへ正常に返金請求が完了した際に決済センターで採番される受付番号 △ △
appUrl 決済アプリ起動URL 半角英数字384文字以内 処理が成功した場合、アプリ起動URL、決済センター側の決済画面URLを返却 × △
SMBM 設定なし ×  
SMBA 処理成功時、アプリ起動URL   ✔
  処理成功時、返金画面URL

※Suicaポケットを用いた返金

    
txnVersion MDK バージョン 半角英数字桁 電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。		 ○ ○

申込（WAON）

要求電文 ： EmAuthorizeRequestDto

要求電文 ： EmAuthorizeRequestDto
フィールド名 項目名 書式・制限 説明 設定
WMB WPC
serviceOptionType 決済サービスオプション 右記参照 "waon-mobile"    ：モバイルアプリ決済 ※Android端末のみ利用可能
"waon-pc"        ：Pasori決済		 ○ ○
orderId 取引ID 半角英数字100桁以内 「2-1 共通」の 「orderId（取引ID）について」参照 ○ ○
amount 決済金額 半角数字5桁以内 1以上50,000以下 ○ ○
settlementLimit 決済期限 半角数字14桁
右記参照		 支払期限（YYYYMMDDhhmmss）
決済日から365日先の日付までが上限です。
（例 1/1日中の取引に関しては、YYYY1231235959が上限）		 ○ ○
mailAddr メールアドレス 半角英数字256桁以内 WAONセンター側から消費者に通知されるメールの宛先を指定

※取引において「WAON媒体がロックされている」などのエラーが発生した場合に使用します。

 △ △
successUrl 成功時戻りURL 半角英数字128桁以内 決済が成功した場合、戻りボタン押下時に遷移する店舗URL × ○
WMB 設定不可 ×  
WPC 必須   ✔
failureUrl 失敗時戻りURL 半角英数字128桁以内 決済が失敗した場合、戻りボタン押下時に遷移する店舗URL × ○
WMB 設定不可 ×  
WPC 必須   ✔
cancelUrl キャンセル時
戻りURL		 半角英数字128桁以内 支払い確認ページなどでキャンセルボタン押下時に遷移する店舗URL × ○
WMB 設定不可 ×  
WPC 必須   ✔
cancelLimit 支払取消期限 半角数字14桁 返金期限（YYYYMMDDhhmmss）
決済日から365日先の日付までが上限です。
（例 1/1日中の取引に関しては、YYYY1231235959が上限）

※キャンセル（Cancel）の期限ではなく返金（Refund）の期限

 ○ ○

応答電文 ： EmAuthorizeResponseDto

応答電文 ： EmAuthorizeResponseDto
フィールド名 項目名 書式・制限 説明 設定
WMB WPC
serviceType 決済サービスタイプ 半角英数字10桁以内 要求電文を送信した決済サービスタイプ ○ ○
mstatus 処理結果コード 半角英数字32文字以内 "success"：正常終了
"failure"：異常終了
"pending"：保留		 ○ ○
vResultCode 詳細結果コード 半角英数字16文字 処理の結果を詳細に表すコード
4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。		 ○ ○
merrMsg エラーメッセージ 文字列1024 バイト以内 処理結果を日本語で表示します。 ○ ○
marchTxn 電文ID 文字列100桁以内 決済サーバーにて決済処理電文（内部処理も含む）毎に付与するID
１つの取引IDに対して、複数のIDが付与されます。		 ○ ○
orderId 取引ID 半角英数字100文字以内 決済要求時に店舗様にて任意に採番し送信された取引ID ○ ○
custTxn 取引毎に付くID 文字列100桁以内 決済サーバーがオーダー（取引ID）と紐付ける為に採番するID ○ ○
receiptNo 受付番号 半角英数字64文字以内 決済センターへ正常に決済請求が完了した際に決済センターで採番される受付番号 △ △
appUrl 決済アプリ起動URL 半角英数字384文字以内 処理が成功した場合、アプリ起動URL、決済センター側の決済画面URLを返却 △ △
WMB アプリ起動URL ※Android端末のみ利用可能 ✔  
WPC 決済画面URL   ✔
invoiceId 請求番号 半角英数字25桁 決済サーバーがWAONとの通信時に発番した、決済を識別するためのID △ △
txnVersion MDK バージョン 半角英数字5桁 電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。		 ○ ○

キャンセル（WAON）

WAON決済はキャンセルが実施できません。

返金申込（WAON）

要求電文 ： EmRefundRequestDto

要求電文 ： EmRefundRequestDto
フィールド名 項目名 書式・制限 説明 設定
WMB WPC
serviceOptionType 決済サービスオプション 右記参照 返金する取引の、決済した方式を指定
"waon-mobile"    ：モバイルアプリ決済 ※Android端末のみ利用可能
"waon-pc"        ：Pasori決済		 ○ ○
orderId 取引ID 半角英数字100桁以内 「2-1 共通」の 「orderId（取引ID）について」参照 ○ ○
amount 返金金額 半角数字5桁以内 返金金額を指定。返金は一回のみ可能。
1以上50,000以下、かつ決済申込時の金額以下		 ○ ○
orderKind オーダー種別 半角英数字10桁以内 "refund"：返金　を指定 ○ ○
refundOrderId 返金対象取引ID 半角英数字100文字以内 決済請求時に採番した取引ID ○ ○
mailAddr メールアドレス 半角英数字256桁以内 取引においてエラーやキャンセルが発生した場合に、WAONセンター側から消費者に通知されるメールの宛先を指定 △ △
successUrl 成功時戻りURL 半角英数字128桁以内 返金が成功した場合、戻りボタン押下時に遷移する店舗URL × ○
WMB 設定不可 ×  
WPC 必須   ✔
failureUrl 失敗時戻りURL 半角英数字128桁以内 返金が失敗した場合、戻りボタン押下時に遷移する店舗URL × ○
WMB 設定不可 ×  
WPC 必須   ✔
cancelUrl キャンセル時
戻りURL		 半角英数字128桁以内 確認ページなどでキャンセルボタン押下時に遷移する店舗URL × ○
WMB 設定不可 ×  
WPC 必須   ✔

応答電文 ： EmRefundResponseDto

応答電文 ： EmRefundResponseDto
フィールド名 項目名 書式・制限 説明 設定
WMB WPC
serviceType 決済サービスタイプ 半角英数字10桁以内 要求電文を送信した決済サービスタイプ ○ ○
mstatus 処理結果コード 半角英数字32文字以内 "success"：正常終了
"failure"：異常終了
"pending"：保留		 ○ ○
vResultCode 詳細結果コード 半角英数字16 桁 処理の結果を詳細に表すコード
4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。		 ○ ○
merrMsg エラーメッセージ 文字列1024 バイト以内 処理結果を日本語で表示します。 ○ ○
marchTxn 電文ID 文字列100桁以内 決済サーバーにて決済処理電文（内部処理も含む）毎に付与するID
１つの取引IDに対して、複数のIDが付与されます。		 ○ ○
orderId 取引ID 半角英数字100文字以内 決済要求時に店舗様にて任意に採番し送信された取引ID ○ ○
custTxn 取引毎に付くID 文字列100桁以内 決済サーバーがオーダー（取引ID）と紐付ける為に採番するID ○ ○
receiptNo 受付番号 半角英数字32文字以内 決済センターへ正常に返金請求が完了した際に決済センターで採番される受付番号 △ △
appUrl 決済アプリ起動URL 半角英数字384文字以内 処理が成功した場合、アプリ起動URL、決済センター側の決済画面URLを返却 △ △
WMB アプリ起動URL ※Android端末のみ利用可能 ✔  
WPC 返金画面URL
決済と同様にアプリ上で返金処理を行います。		   ✔
invoiceId 請求番号 半角英数字25桁 決済サーバーがWAONとの通信時に発番した、決済を識別するためのID △ △
txnVersion MDK バージョン 半角英数字桁 電文のバージョン
問題発生時などに用いますが、通常ご利用になることはありません。		 ○ ○
※WAON決済開発の注意点
WAON決済は、楽天EdyやSuicaと異なりエラーが発生した場合以外、WAON決済センターから消費者にメール通知が行われることはありません。
上記、要求電文フィールドの「mailAddr」はエラー通知メール用のパラメータであり、任意指定項目です。
この為、応答電文フィールドである「appUrl」を用いたリダイレクト処理、もしくはURL自体をメールなどで消費者に通知し、WAONの決済用サイトにアクセス、
または決済アプリを起動して決済するよう、店舗様にて決済フローを構築する必要があります。

結果通知（電子マネー決済）

決済サーバーは、決済センターからの入金／返金完了情報（消費者の支払完了情報／消費者への返金完了情報）を受け取り、該当の入金／返金が完了したと判断した場合に、店舗様へ入金通知／返金通知を送信します。

下表に、電文項目の詳細を示します。
結果通知に関するサービス共通の仕様については、『開発ガイド』を併せてご参照ください。

項番 フィールド名 項目名 書式・制限 説明
1 numberOfNotify 通知件数 半角数字4桁以内 1度に通知可能な件数は1,000件 1,001件以上は次回通知
2 pushTime 送信時刻 半角数字14桁 決済サーバーから通知した時刻 YYYYMMDDhhmmss形式
3 pushId 識別ID 半角数字8桁 プッシュ処理を行うたびに採番されるID

注） 他の決済サービスで使用されたIDと重複する場合があります。
通知件数分下記の項番（4～7）を繰り返す。尚、フィールド名の後ろに4ケタの連番（0000～0999）を付与する。
4 orderId 取引ID 半角英数字100桁以内  
5 emType EMタイプ 半角英数字10桁以内 "edy", "suica","waon"
6 receiptDate 完了日時 半角数字14桁 消費者側で支払が完了した日時（入金の場合）
消費者側で返金額の受取りを完了した日時（返金の場合）
YYYYMMDDhhmmss形式

※金融機関によって時刻の扱いは異なります。
7 dummy ダミー決済フラグ 半角数字1桁 ダミーデータを示す場合は"1"を設定
（注意事項）
  • pushId（識別ID）は、他の決済サービスで使用されたIdと重複する場合がありますので、ユニークキーとして処理しないようにしてください。
  • 項目の並び順は、必ずしも表の順序とは一致しません。

その他　補足事項

決済メール表示

各電子マネーセンターより消費者へ送られる決済を行うためのメールにおいて、該当箇所に特定の情報を表示することができます。

テストID及び、DUMMY_TYPEを設定した場合メールは送信されません。
本番IDで且つ決済センターに通信できた場合のみ該当するメールが送信されます。

Mobile Edy

Mobile Edy 決済開始メール

Mobile Edy 決済開始メールの特定の箇所に情報を表示することができます。
決済開始メールとMDKでの項目名、弊社システムの登録情報の対応は以下の通りです。
メールはEdyセンターより送信されます。

画面は以下のように表示されます。

Mobile Edy 決済開始メール

Mobile Edy 決済完了メール

Mobile Edy　決済完了メールの特定の箇所に情報を表示することができます。
MDKでの項目名、弊社システムの登録情報の対応は以下の通りです。
メールはEdyセンターより送信されます。

画面は以下のように表示されます。

Mobile Edy 決済完了メール

モバイルSuica

モバイルSuica決済依頼メール

決済依頼メールの特定の箇所に情報を表示することができます。
決済依頼メールとMDKでの項目名、弊社システムの登録情報の対応は以下の通りです。
メールはモバイルSuicaセンターより送信されます。

画面は以下のように表示されます。

モバイルSuica決済依頼メール

モバイルSuica決済完了メール

決済完了メールの特定の箇所に情報を表示することができます。
決済完了メールとMDKでの項目名、弊社システムの登録情報の対応は以下の通りです。
メールはモバイルSuicaセンターより送信されます。

画面は以下のように表示されます。

モバイルSuica決済完了メール

決済画面表示

Mobile Edy

Mobile Edy　決済画面

決済内容確認画面の特定の箇所に情報を表示することができます。
決済内容確認画面とMDKでの項目名の対応は以下の通りです。

画面は以下のように表示されます。

Mobile Edy　決済画面

モバイルSuica

モバイルSuica決済内容確認画面

決済内容確認画面の特定の箇所に情報を表示することができます。
決済内容確認画面とMDKでの項目名、弊社システムの登録情報の対応は以下の通りです。

画面は以下のように表示されます。

モバイルSuica決済内容確認画面

モバイルSuica決済完了画面

決済完了画面の特定の箇所に情報を表示することができます。
決済完了画面とMDKでの項目名、弊社システムの登録情報の対応は以下の通りです。

画面は以下のように表示されます。

モバイルSuica決済完了画面

Suicaポケット発行メール（返金）

Suica決済の返金はSuicaポケットとして処理されます。依頼メールの特定の箇所に情報を表示することができます。
Suicaポケット発行メールとMDKでの項目名、弊社システムの登録情報の対応は以下の通りです。
メールはモバイルSuicaセンターより送信されます。

画面は以下のように表示されます。

Suicaポケット発行メール（返金）

Suicaポケット受取内容確認画面（返金）

返金時のSuicaポケット処理時にSuicaポケット受取内容確認画面の特定の箇所に情報を表示することができます。
Suicaポケット受取内容確認画面とMDKでの項目名、弊社システムの登録情報の対応は以下の通りです。

画面は以下のように表示されます。

Suicaポケット受取内容確認画面（返金）

Suicaポケット受取完了画面（返金）

返金時のSuicaポケット処理時にSuicaポケット受取完了画面の特定の箇所に情報を表示することができます。
Suicaポケット受取完了画面とMDKでの項目名、弊社システムの登録情報の対応は以下の通りです。

画面は以下のように表示されます。

Suicaポケット受取完了画面（返金）

メール送信一覧

電子マネー決済センターから送信される電子メールについて記載します。

ダミーモードを設定した場合、メールは送信されません。 本番IDで且つ決済センターに通信できた場合のみ該当するメールが送信されます。

※送信有無 ： ◎：必ず送信、○：制御可、×：送信無し

表 3-3 1 メール送信タイミング一覧
送信元
↓
送信先		 処理 送信有無 送信制御フラグ 送信先メールアドレス
モバイルEdy 決済センター
↓
消費者		 決済申込(Authorize) ◎ 登録済みメールアドレス（mail-addr）
決済完了通知 ◎ 登録済みメールアドレス
返金申込(Refund) ×
決済センター
↓
店舗様		 決済申込(Authorize ○ forwardMailFlag merchant-mail-addr
決済完了通知 ○ forwardMailFlag merchant-mail-addr
返金申込((Refund) ×
サイバーEdy 決済センター
↓
消費者		 決済申込(Authorize ×
決済完了通知 ×
返金申込((Refund) ×
決済センター
↓
店舗様		 決済申込(Authorize) ×
決済完了通知 ×
返金申込((Refund) ×
モバイルSuica
（メール決済）		 決済センター
↓
消費者		 決済申込(Authorize ◎ 登録済みメールアドレス（mail-addr）
決済完了通知 ○ completeMailFlag 登録済みメールアドレス
返金申込(Refund) ○ requestMailFlag 登録済みメールアドレス
決済センター
↓
店舗様		 決済申込(Authorize) ○ forwardMailFlag merchant-mail-addr
決済完了通知 ○ forwardMailFlag merchant-mail-addr
返金申込(Refund) ○ forwardMailFlag merchant-mail-addr
モバイルSuica
（アプリ決済）		 決済センター
↓
消費者		 決済申込(Authorize) ×
決済完了通知 ○ completeMailFlag 登録済みメールアドレス
返金申込((Refund) ×
決済センター
↓
店舗様		 決済申込(Authorize) ×
決済完了通知 ○ forwardMailFlag merchant-mail-addr
返金申込((Refund) ×

※ 全ての返金申込について、返金完了の際にメールを送信する機能はありません。

WAON決済　エラー通知メールについて

WAON決済では、楽天Edy決済やSuica決済と異なり、消費者にメール通知が行われるのはWAON媒体のロックが発生している場合など、処理エラーを通知する場合のみです。要求電文の任意設定項目である「mailAddr」に設定されたメールアドレス宛に、以下のようなメールが通知されます。

WAON決済センターから消費者に通知されるエラー通知メール（サンプル）

画面は以下のように表示されます。

WAON決済　エラー通知メールについて