VeriTrans4G インターフェース詳細 ～電子マネー決済～

VeriTrans4G インターフェース詳細～電子マネー決済～
Ver. 1.0.1 （2019 年 07 月～）

Copyright (c) 2019 VeriTrans Inc., a Digital Garage company. All rights reserved.
1VeriTrans4G インターフェース詳細 ～電子マネー決済～

目次
第1章

本ドキュメントについて ......................................................................................................................................................................................................... 5

1-1 本ガイドの内容 ......................................................................................................................................................................................................................................................5
1-2 著作権、および問い合わせ先 .................................................................................................................................................................................................................................5
1-3 改定履歴...............................................................................................................................................................................................................................................................5

第2章

インターフェース詳細 ............................................................................................................................................................................................................ 6

2-1 共通 ......................................................................................................................................................................................................................................................................6
2-2 申込（楽天 Edy） ....................................................................................................................................................................................................................................................8
2.2.1 要求電文 ： EmAuthorizeRequestDto ................................................................................................................................................................................................................................... 8
2.2.2 応答電文 ： EmAuthorizeResponseDto ................................................................................................................................................................................................................................. 9

2-3 キャンセル（楽天 Edy）......................................................................................................................................................................................................................................... 10
2-4 返金申込（楽天 Edy）........................................................................................................................................................................................................................................... 11
2.4.1 要求電文 ： EmRefundRequestDto ....................................................................................................................................................................................................................................... 11
2.4.2 応答電文 ： EmRefundResponseDto ..................................................................................................................................................................................................................................... 11

2-5 申込（Suica） ....................................................................................................................................................................................................................................................... 13
2.5.1 要求電文 ： EmAuthorizeRequestDto ..................................................................................................................................................................................................................................132.5.2 応答電文 ： EmAuthorizeResponseDto ................................................................................................................................................................................................................................15

2-6 キャンセル（Suica） .............................................................................................................................................................................................................................................. 16
2.6.1 要求電文 ： EmCancelRequestDto .......................................................................................................................................................................................................................................16

2-7 返金申込（Suica） ................................................................................................................................................................................................................................................ 18
2.7.1 要求電文 ： EmRefundRequestDto .......................................................................................................................................................................................................................................18
2.7.2 応答電文 ： EmRefundResponseDto .....................................................................................................................................................................................................................................20

2-8 申込（WAON） ..................................................................................................................................................................................................................................................... 21
2.8.1 要求電文 ： EmAuthorizeRequestDto ..................................................................................................................................................................................................................................212.8.2 応答電文 ： EmAuthorizeResponseDto ................................................................................................................................................................................................................................22

2-9 キャンセル（WAON） ............................................................................................................................................................................................................................................ 22
2

VeriTrans4G インターフェース詳細 ～電子マネー決済～
2-10 返金申込（WAON） ............................................................................................................................................................................................................................................ 23
2.10.1 要求電文 ： EmRefundRequestDto .....................................................................................................................................................................................................................................23
2.10.2 応答電文 ： EmRefundResponseDto ...................................................................................................................................................................................................................................24

2-11 申込（nanaco） ................................................................................................................................................................................................................................................... 25
2.11.1 要求電文 ： EmAuthorizeRequestDto .................................................................................................................................................................................................................................25
2.11.2 応答電文 ： EmAuthorizeResponseDto...............................................................................................................................................................................................................................26

2-12 再決済申込（nanaco） ........................................................................................................................................................................................................................................ 27
2.12.1 要求電文 ： EmReAuthorizeRequestDto ............................................................................................................................................................................................................................27
2.12.2 応答電文 ： EmReAuthorizeResponseDto ..........................................................................................................................................................................................................................27
2.12.3 リダイレクトパラメータ ： 決済サーバーから消費者ブラウザ経由でリダイレクト(GET)される項目 ................................................................................................................................................28

2-13 キャンセル（nanaco） ......................................................................................................................................................................................................................................... 29
2.13.1 要求電文 ： EmCancelRequestDto......................................................................................................................................................................................................................................29
2.13.2 応答電文 ： EmCancelResponseDto ...................................................................................................................................................................................................................................29

2-14 返金（nanaco）................................................................................................................................................................................................................................................... 30
2-15 カード情報削除（nanaco）................................................................................................................................................................................................................................... 30
2.15.1 要求電文 ： EmRemoveRequestDto ....................................................................................................................................................................................................................................30
2.15.2 応答電文 ： EmRemoveResponseDto ..................................................................................................................................................................................................................................31

2-16 結果通知（電子マネー決済） ............................................................................................................................................................................................................................... 32
2-17 結果通知（nanaco 決済） ................................................................................................................................................................................................................................... 33

第3章

その他 補足事項 .............................................................................................................................................................................................................. 35

3-1 決済メール表示 ................................................................................................................................................................................................................................................... 35
3.1.1 Mobile Edy ..............................................................................................................................................................................................................................................................................36
3.1.2 モバイル Suica.........................................................................................................................................................................................................................................................................38

3-2 決済画面表示...................................................................................................................................................................................................................................................... 40
3.2.1 Mobile Edy ..............................................................................................................................................................................................................................................................................40
3.2.2 モバイル Suica.........................................................................................................................................................................................................................................................................41

3-3 メール送信一覧 ................................................................................................................................................................................................................................................... 46
3

VeriTrans4G インターフェース詳細 ～電子マネー決済～
3-4 WAON 決済 エラー通知メールについて .............................................................................................................................................................................................................. 48
3-5 nanaco 決済 レギュレーション .............................................................................................................................................................................................................................. 49

4

VeriTrans4G インターフェース詳細 ～電子マネー決済～

第1章 本ドキュメントについて
1-1 本ガイドの内容
本ガイドは、ベリトランス（株）が提供する VeriTrans4G を利用するための専用ソフトウェア MDK（Merchant Development Kit）をインターネット店舗などに導入する開発者向けのガイドです。VeriTrans4G
電子マネー決済にて使用する電文のインターフェース詳細について記載しています。
VeriTrans4G の詳細については、『VeriTrans4G 開発ガイド』を参照して下さい。
尚、インターフェース詳細は、決済サービス毎に提供していますので、当該決済サービスのインターフェース詳細を参照して下さい。

1-2 著作権、および問い合わせ先[著作権]

本ドキュメントの著作権はベリトランス株式会社が保有しています。
Copyright (c) 2019 VeriTrans Inc., a Digital Garage company. All rights reserved.

[お問い合わせ先]

ベリトランス株式会社 テクニカルサポート

電子メール： tech-support@veritrans.jp

1-3 改定履歴
2017/04 ：Ver1.0.0 リリース
2019/07 ：Ver1.0.1 リリース
Suica インターネットサービスを削除「2-16 結果通知（電子マネー決済）」 項目の並び順について追記「2-17 結果通知（nanaco 決済）」 項目の並び順について追記

5

VeriTrans4G インターフェース詳細 ～電子マネー決済～

第2章 インターフェース詳細
本章では、各決済にて使用する電文（Dto）について説明します。以下の表に記載されているフィールドは、店舗様にて利用可能なフィールドです。
各電文（Dto）には、以下の表に記載されていないフィールドが定義されている場合がありますが、以下の表に記載されていないフィールドは店舗様では使用することはできません。

2-1 共通■「設定」欄の内容は以下の通りです。
要求電文 … 必須項目：○

任意項目：△

設定不可：×

応答電文 … 必ず返戻：○

処理成功時のみ返戻：△

その他条件付：※、※n（条件は説明欄、または欄外に記入）

返戻なし：×

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

■設定欄のタイトルについて
設定欄のタイトルは、下記の通り各決済サービスを示します。
電子マネー毎に各フィールドの設定（必須項目、任意項目、設定不可等）が異なりますのでご注意ください。
EMB：モバイル Edy

EPC：サイバーEdy

EDC：Edy ダイレクト

SMBM：モバイル Suica（メール決済）

SMBA：モバイル Suica（アプリ決済）

WMB：WAON（モバイルアプリ決済）

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

7

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-2 申込（楽天 Edy）
2.2.1 要求電文 ： EmAuthorizeRequestDto
要求電文 ： EmAuthorizeRequestDto
フィールド名

項目名

serviceOptionType

決済サービス

書式・制限

取引 ID

amount

決済金額

設定
EMB

EPC

EDC

○

○

○

「2-1 共通」の「orderId（取引 ID）について」参照

○

○

○

1 以上 50,000 以下

○

○

○

半角数字

支払期限（YYYYMMDDhhmmss）

○

×

×

14 桁

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

右記参照

EMB

当日～90 日後を決済期限に指定可能

EPC

10 日固定

×

×

○

×

×

○

×

×

×

×

×

×

右記参照

オプション
orderId

説明

半角英数字"edy-mobile"： モバイル Edy"edy-pc"： サイバーEdy"edy-direct"： Edy ダイレクト

100 桁以内
半角数字
5 桁以内
settlementLimit

決済期限

✔

EDC
mailAddr

メールアドレス

半角英数字

決済依頼メールを送付する消費者の携帯電話メールアドレス

256 桁以内

楽天 Edy 利用可能なおサイフケータイにおいて、初期設定・サービス登録が必要です。ドメイン指定受信を設定している場合は@bitwallet.co.jp を許可ドメインに加える必要があります。

forwardMailFlag

転送メール送半角数字

楽天 Edy から消費者に通知する決済依頼メール、決済完了メールのコピーメール又は BCC メールを貴社受信用メー

信要否

1桁

ルアドレス（merchantMailAddr）に送信するか否かを設定

右記参照

EMB
EPC

"0"： 送信不要✔

"1"： 送信要

✔

設定不可

EDC
merchantMailAddr

マーチャントメ

半角英数字

楽天 Edy から消費者に通知する決済依頼メール、決済完了メールのコピーメール又は BCC メールを受信するメール

ールアドレス

256 桁以内

アドレス※

以下の文字も使用できます。
"." (ドット)、"-" (ハイフン)、"_" (アンダースコア)、"@" (アットマーク)
複数指定時は","区切り指定して下さい。
EMB

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

8VeriTrans4G インターフェース詳細 ～電子マネー決済～

要求電文 ： EmAuthorizeRequestDto
フィールド名

項目名

書式・制限

説明
EPC

設定
EMB

設定不可

EPC

EDC

×

×

×

×

×

×

×

×

×

×

×

△

EDC
requestMailAddInfo

依頼メール送文字列

決済依頼メールに追加される文字列（商品情報等）

△

信付加情報

256 バイト以内

EMB

詳細は「3.1.1Mobile Edy」の「Mobile Edy 決済開始メール」参照

✔

EPC

設定不可

EDC
completeMailAddInf

完了メール付文字列

決済完了メールに追加される文字列（遷移先 URL 等）

△

o

加情報

300 バイト以内

EMB

詳細は「3.1.1Mobile Edy」の「Mobile Edy 決済完了メール」参照

✔

EPC

設定不可

EDC
shopNamecompleteNoticeUrl

ショップ名

文字列

決済依頼メール、決済完了メールで使用する店舗名△

48 バイト以内

EMB

詳細は「3.1.1Mobile Edy」の「Mobile Edy 決済開始メール」および「Mobile Edy 決済完了メール」参照

✔

EPC

設定不可

EDC

任意

決済完了通知半角英数字

支払いを完了した後に遷移する URL

URL

256 桁以内※設定しない場合は無遷移

×
✔

×

△

△

2.2.2 応答電文 ： EmAuthorizeResponseDto
応答電文 ： EmAuthorizeResponseDto
フィールド名
serviceTypemstatus

項目名

書式・制限

説明

設定
EMB

EPC

EDC

要求電文を送信した決済サービスタイプ

○

○

○

○

○

○

○

○

○

決済サービスタ

半角英数字

イプ

10 桁以内処理結果コード

半角英数字"success" ： 正常終了

32 文字以内"failure"： 異常終了"pending" ： 保留vResultCode

詳細結果コード

半角英数字

処理の結果を詳細に表すコード

16 文字

4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。

9VeriTrans4G インターフェース詳細 ～電子マネー決済～

応答電文 ： EmAuthorizeResponseDto
フィールド名merrMsg

項目名

書式・制限

エラーメッセー

文字列 1024 バ

説明

設定
EMB

EPC

EDC

処理結果を日本語又は英語で表示

○

○

○

○

○

○

ジ

イト以内

marchTxn

電文 ID

文字列

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID

100 桁以内

１つの取引 ID に対して、複数の ID が付与されます。

orderId

取引 ID

半角英数字

決済要求時に店舗様にて任意に採番し送信された取引 ID

○

○

○

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID

○

○

○

決済センターへ正常に決済請求が完了した際に決済センターで採番される受付番号

△

△

△

△

△

100 文字以内
custTxn

取引毎に付く ID

文字列
100 桁以内

receiptNo

受付番号

半角英数字記号 64 文字以内

appUrl決済アプリ起動

半角英数字

決済処理が成功した場合、アプリ起動 URL、決済センター側の決済画面 URL を返却

×URL

384 文字以内

EMB

設定なし

×

EPC

Edy Viewer の起動 URL✔

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

モバイルアプリの起動 URL

MDK バージョ

半角英数字

電文のバージョンン

5桁

問題発生時などに用いますが、通常ご利用になることはありません。

✔

○

○

○

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

10VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-4 返金申込（楽天 Edy）
※楽天 Edy 決済の返金受取期限は６０日間固定です。

2.4.1 要求電文 ： EmRefundRequestDto
要求電文 ： EmRefundRequestDto
フィールド名

項目名

serviceOptionType

決済サービスオプ

書式・制限
右記参照

ション

説明
"edy-mobile"： モバイル Edy"edy-pc"： サイバーEdy"edy-direct"： Edy ダイレクトorderId

取引 ID

半角英数字 100 桁以内「2-1 共通」の「orderId（取引 ID）について」参照

amount

返金金額

半角数字 5 桁以内返金金額。返金は一回のみ可能。

設定
EMB

EPC

EDC

○

○

○

○
○

○
○

○
○

○
○
△

○
○
△

○
○
△

1 以上 50,000 以下、かつ決済申込時の金額以下
orderKind

オーダー種別

半角英数字 10 桁以内"refund"：返金 を指定

refundOrderId

返金対象取引 ID

半角英数字 100 文字以内

決済請求時に採番した取引 ID

edyGiftName

返金名義

文字列 32 バイト以内

返金用に用いられる Edy ギフトの取得画面で表示される個別返金名義を設定したい場合に指定（全角 16 文字、半角 32 文字）

未指定：『Edy 決済返金』
指定：『Edy 決済返金』＋指定名義

2.4.2 応答電文 ： EmRefundResponseDto
応答電文 ： EmRefundResponseDto
フィールド名

項目名

書式・制限

説明

serviceType

決済サービスタイプ

半角英数字 10 桁以内

要求電文を送信した決済サービスタイプ

mstatus

処理結果コード

半角英数字 32 文字以内

"success" ： 正常終了
"failure"

設定
EMB

EPC

EDC

○
○

○
○

○
○

○

○

○

○

○

○

： 異常終了"pending" ： 保留vResultCode

詳細結果コード

半角英数字 16 桁処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。

merrMsg

エラーメッセージ

文字列 1024 バイト以内

処理結果を日本語又は英語で表示

11VeriTrans4G インターフェース詳細 ～電子マネー決済～

応答電文 ： EmRefundResponseDto
フィールド名

項目名

書式・制限

説明
決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID

設定
EMB

EPC

EDC

○

○

○

○
○
△
※

○
○
△
※

○

○

marchTxn

電文 ID

文字列 100 桁以内

orderId

取引 ID

半角英数字 100 文字以内

決済要求時に店舗様にて任意に採番し送信された取引 ID

custTxn

取引毎に付く ID

文字列 100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID

receiptNo

受付番号

半角英数字記号 32 文字以内

決済センターへ正常に返金請求が完了した際に決済センターで採番される受付番号

appUrl決済アプリ起動

半角英数字 384 文字以内

【設定なし】○○△※

半角英数字桁

電文のバージョン○

１つの取引 ID に対して、複数の ID が付与されます。

URL
txnVersion

MDK バージョン

問題発生時などに用いますが、通常ご利用になることはありません。

12VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-5 申込（Suica）
2.5.1 要求電文 ： EmAuthorizeRequestDto
要求電文 ： EmAuthorizeRequestDto
設定
フィールド名

項目名

serviceOptionType

決済サービスオプ

書式・制限
右記参照

ション

説明
"suica-mobile-mail" ： モバイル Suica（メール決済）

SMB
M

SMB
A

○

○

○
○
○

○
○
○

○
△

×
×

モバイル 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
SMBA

merchantMailAddr

マーチャントメール

半角英数字 256 桁以内

アドレス"0"： 送信不要✔

"1"： 送信要✔

設定不可

Suica 決済センターから消費者に通知する決済依頼メール、決済完了メールのコピーメール又は BCC メールを

×

※

×

受信するメールアドレス
以下の文字も使用できます。"." (ドット)、"-" (ハイフン)、"_" (アンダースコア)、"@" (アットマーク)
SMBM

任意

✔

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

依頼メール送信付

文字列 256 バイト以内

加情報
completeMailAddInf

完了メール付加情

o

報

設定不可

決済依頼メールに追加される文字列（商品情報等）

×

△

×

△

△

※詳細は「3.1.2 モバイル Suica」の「モバイル Suica 決済依頼メール」参照
文字列 300 バイト以内

決済完了メールに追加される文字列（遷移先 URL 等）※完了メール送信要否（completeMailFlag）に “0”： 送信不要を設定し、かつ本項目を設定していた場合はエラーが発生します。

13

VeriTrans4G インターフェース詳細 ～電子マネー決済～

要求電文 ： EmAuthorizeRequestDto
設定
フィールド名

項目名

書式・制限

説明

completeMailFlag

完了メール送信要

半角数字 1 桁

Suica 決済センターから消費者に決済完了時にメールを送信するか否かを指定

否

右記参照

"0"： 送信不要

SMB
M

SMB
A

△

△

△

△

△

△

○

○

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

内容確認画面付加

nfo

情報completeScreenAd

完了画面付加情報

文字列 256 バイト以内※詳細は「3.2.2 モバイル Suica」の「モバイル Suica 決済内容確認画面」参照
文字列 256 バイト以内

dInfo
screenTitle

内容確認画面に表示する付加情報
決済完了画面に表示する付加情報※詳細は「3.2.2 モバイル Suica」」の「モバイル Suica 決済完了画面」参照

画面タイトル

文字列 40 バイト以内

決済完了画面・決済確認画面等で「商品・サービス名」に表示される文字列※詳細は「3.2.2 モバイル Suica」の「モバイル Suica 決済内容確認画面」および「モバイル Suica 決済完了画面」
参照
以下の文字が設定可能です。
・半角英数字・半角記号（但し以下を除く^ （ハット）、` （バッククォート）、{ } （中括弧）、| （縦棒）、~ （チルダ））

・全角文字

14

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2.5.2 応答電文 ： EmAuthorizeResponseDto
応答電文 ： EmAuthorizeResponseDto
設定
フィールド名

項目名

書式・制限

説明

serviceType

決済サービスタイプ

半角英数字 10 桁以内

要求電文を送信した決済サービスタイプ

mstatus

処理結果コード

半角英数字 32 文字以"success" ： 正常終了

内

"failure"

SMB
M

SMB
A

○
○

○
○

○

○

○
○

○
○

決済要求時に店舗様にて任意に採番し送信された取引 ID

○

○
○
△
△

： 異常終了"pending" ： 保留vResultCode

詳細結果コード

半角英数字 16 文字処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。

merrMsg

エラーメッセージ

文字列 1024 バイト以内

処理結果を日本語又は英語で表示

marchTxn

電文 ID

文字列 100 桁以内

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID
１つの取引 ID に対して、複数の ID が付与されます。

orderId

取引 ID

半角英数字 100 文字以
内

custTxn

取引毎に付く ID

文字列 100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID

receiptNo

受付番号

半角英数字 64 文字以内

決済センターへ正常に決済請求が完了した際に決済センターで採番される受付番号

appUrl決済アプリ起動

半角英数字 384 文字以処理が成功した場合、アプリ起動 URL、決済センター側の決済画面 URL を返却

○
△
×

URL

内

SMBM

設定無し

×

SMBA

アプリ起動 URL

txnVersion

MDK バージョン

半角英数字 5 桁

電文のバージョン✔

○○問題発生時などに用いますが、通常ご利用になることはありません。

15

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-6 キャンセル（Suica）
2.6.1 要求電文 ： EmCancelRequestDto
要求電文 ： EmCancelRequestDto
設定
フィールド名

項目名

serviceOptionType

決済サービスオプ

書式・制限
右記参照

ション

説明
キャンセル対象の取引の、決済した方式を指定

SMB
M

SMB
A

○

○

○
○

○
○

"suica-mobile-mail" ： モバイル Suica（メール決済）"suica-mobile-app"： モバイル Suica（アプリ決済）

orderId

取引 ID

半角英数字 100 桁以内

決済請求時に採番した取引 ID

orderKind

オーダー種別右記参照

キャンセル対象のオーダー種別を指定"authorize"： 決済申込
"refund"： 返金申込

16

VeriTrans4G インターフェース詳細 ～電子マネー決済～
応答電文 ： EmCancelResponseDto

応答電文 ： EmCancelResponseDto
設定
フィールド名

項目名

書式・制限

説明

serviceType

決済サービスタイプ

半角英数字 10 桁以内

要求電文を送信した決済サービスタイプ

mstatus

処理結果コード

半角英数字 32 文字以"success" ： 正常終了

内

"failure"

SMB
M

SMB
A

○
○

○
○

○

○

○
○

○
○

決済要求時に店舗様にて任意に採番し送信された取引 ID

○

○

○
○

○
○

： 異常終了"pending" ： 保留vResultCode

詳細結果コード

半角英数字 16 文字処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。

merrMsg

エラーメッセージ

文字列 1024 バイト以内

処理結果を日本語又は英語で表示

marchTxn

電文 ID

文字列 100 桁以内

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID
１つの取引 ID に対して、複数の ID が付与されます。

orderId

取引 ID

半角英数字 100 文字以
内

custTxn

取引毎に付く ID

文字列 100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID

txnVersion

MDK バージョン

半角英数字 5 桁

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。

17

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-7 返金申込（Suica）
2.7.1 要求電文 ： EmRefundRequestDto
要求電文 ： EmRefundRequestDto
設定
フィールド名

項目名

serviceOptionType

決済サービスオプ

書式・制限
右記参照

ション

説明
返金対象の取引の、決済した方式を指定

SMB
M

SMB
A

○

○

○
○

○
○
○
○

"suica-mobile-mail" ： モバイル Suica（メール決済）"suica-mobile-app"： モバイル Suica（アプリ決済）

orderId

取引 ID

半角英数字 100 桁以内「2-1 共通」の「orderId（取引 ID）について」参照

amount

返金金額

半角数字 5 桁以内

返金金額を指定。返金は一回のみ可能。

orderKind

オーダー種別

半角英数字 10 桁以内“refund”：返金 を指定

refundOrderId

返金対象取引 ID

半角英数字 100 文字以

決済請求時に採番した取引 ID を指定します。

○○

半角数字 14 桁

YYYYMMDDhhmmss 形式

○

○

右記参照

返金申込当日 5 分後から 60 日以内で指定可能です。

半角英数字 256 桁以内返金する取引において指定した消費者の携帯電話メールアドレス

△

×

SMBM

✔

1 以上 20,000 以下、 かつ決済申込時の金額以下内
settlementLimit

返金受取期限mailAddr

メールアドレス

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

SMBA
forwardMailFlag

設定不可

転送メール送信要

半角数字 1 桁

返金通知メールのコピー又は BCC メールをマーチャントメールアドレス（merchantMailAddr）に送信するか否かを

否

右記参照

指定

×

△

×

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

マーチャントメール
アドレス

半角英数字 256 桁以内"0"： 送信不要✔

"1"： 送信要✔

設定不可

返金通知メールのコピーメール又は BCC メール先マーチャントメールアドレス以下の文字も使用できます。

×

※

×

"."(ドット)、"-"(ハイフン)、"_"(アンダースコア)、"@"(アットマーク)
SMBM

任意

✔

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

設定不可

×

18

VeriTrans4G インターフェース詳細 ～電子マネー決済～

要求電文 ： EmRefundRequestDto
設定
フィールド名

項目名

書式・制限

requestMailAddInfo

返金通知メール付

半角英数字 256 桁以内

加情報

requestMailFlag

説明
返金通知メールに追加される文字列（返金情報等）

SMB
A

△

×

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

任意

SMBA

設定不可

✔
×

返金通知メール送

半角数字 1 桁

Suica 決済センターから消費者に返金通知メールの送信要否を指定

△

信要否

右記参照

SMBM

"0"： 送信不要✔

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

✔

SMBA
confirmScreenAddI

内容確認画面付加

nfo

情報completeScreenAd

完了画面付加情報

文字列 256 バイト以内

設定不可

返金内容確認画面に表示する付加情報

×

×

△

△

△

△

△

△

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

dInfo
screenTitle

SMB
M

返金受取完了画面に表示する付加情報※詳細は「3.2.2 モバイル Suica」の「Suica ポケット受取完了画面（返金）」参照

画面タイトル

文字列 40 バイト以内

返金内容確認、返金受取完了画面などで「商品・サービス名」に表示される文字列※詳細は「3.2.2 モバイル Suica」の「Suica ポケット受取内容確認画面（返金）」および「Suica ポケット受取完了画面（返金）」参照19

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2.7.2 応答電文 ： EmRefundResponseDto
応答電文 ： EmRefundResponseDto
設定
フィールド名

項目名

書式・制限

説明

serviceType

決済サービスタイプ

半角英数字 10 桁以内

要求電文を送信した決済サービスタイプ

mstatus

処理結果コード

半角英数字 32 文字以内

"success" ： 正常終了
"failure"

SMB
M

SMB
A

○
○

○
○

○

○

○
○

○
○
○
○
△
△

： 異常終了"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決済アプリ起動

半角英数字 384 文字以内処理が成功した場合、アプリ起動 URL、決済センター側の決済画面 URL を返却

○
○
△
×

SMBM

設定なし

×

SMBA

処理成功時、アプリ起動 URL

URL✔

処理成功時、返金画面 URL ※Suica ポケットを用いた返金
txnVersion

MDK バージョン

半角英数字桁

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

20

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-8 申込（WAON）
2.8.1 要求電文 ： EmAuthorizeRequestDto
要求電文 ： EmAuthorizeRequestDto
設定
フィールド名

項目名

serviceOptionType

決済サービスオプ

書式・制限
右記参照

ション

説明

WMB

WPC

○

○

○
○
○

○
○
○

△

△

決済が成功した場合、戻りボタン押下時に遷移する店舗 URL

×

○

WMB

設定不可

×

WPC

必須

"waon-mobile"： モバイルアプリ決済"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

failureUrlcancelUrl

成功時戻り URL

失敗時戻り URL

キャンセル時

半角英数字 128 桁以内

半角英数字 128 桁以内

半角英数字 128 桁以内

戻り URLcancelLimit

支払取消期限

半角数字 14 桁✔

決済が失敗した場合、戻りボタン押下時に遷移する店舗 URL

×

WMB

設定不可

×

WPC

必須

✔

支払い確認ページなどでキャンセルボタン押下時に遷移する店舗 URL

×

WMB

設定不可

×

WPC

必須

返金期限（YYYYMMDDhhmmss）

○

○
✔

○

○

決済日から 365 日先の日付までが上限です。
（例 1/1 日中の取引に関しては、YYYY1231235959 が上限）
※キャンセル（Cancel）の期限ではなく返金（Refund）の期限

21VeriTrans4G インターフェース詳細 ～電子マネー決済～

2.8.2 応答電文 ： EmAuthorizeResponseDto
応答電文 ： EmAuthorizeResponseDto
フィールド名

項目名

書式・制限

説明

serviceType

決済サービスタイプ

半角英数字 10 桁以内

要求電文を送信した決済サービスタイプ

mstatus

処理結果コード

半角英数字 32 文字以内

"success" ： 正常終了
"failure"

設定
WMB

WPC

○
○

○
○

○

○

○
○

○
○
○
○
△
△

： 異常終了"pending" ： 保留vResultCode

詳細結果コード

半角英数字 16 文字処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。

merrMsg

エラーメッセージ

文字列 1024 バイト以内

処理結果を日本語又は英語で表示

marchTxn

電文 ID

文字列 100 桁以内

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID

orderId

取引 ID

半角英数字 100 文字以内

決済要求時に店舗様にて任意に採番し送信された取引 ID

custTxn

取引毎に付く ID

文字列 100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID

receiptNo

受付番号

半角英数字 64 文字以内

決済センターへ正常に決済請求が完了した際に決済センターで採番される受付番号

appUrl決済アプリ起動

半角英数字 384 文字以内処理が成功した場合、アプリ起動 URL、決済センター側の決済画面 URL を返却

○
○
△
△

WMB

アプリ起動 URL✔

WPC

決済画面 URL

１つの取引 ID に対して、複数の ID が付与されます。

URL
invoiceId

請求番号

半角英数字 25 桁

決済サーバーが WAON との通信時に発番した、決済を識別するための ID

txnVersion

MDK バージョン

半角英数字 5 桁

電文のバージョン

✔

△
○

△
○

問題発生時などに用いますが、通常ご利用になることはありません。

2-9 キャンセル（WAON）
WAON 決済はキャンセルが実施できません。

22

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-10 返金申込（WAON）
2.10.1 要求電文 ： EmRefundRequestDto
要求電文 ： EmRefundRequestDto
設定
フィールド名

項目名

serviceOptionType

決済サービスオプ

書式・制限
右記参照

ション

説明

WMB

WPC

○

○

○
○

○
○

○
○
△

○
○
△

返金が成功した場合、戻りボタン押下時に遷移する店舗 URL

×

○

WMB

設定不可

×

WPC

必須

返金する取引の、決済した方式を指定"waon-mobile"： モバイルアプリ決済"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 桁以内

指定

failureUrlcancelUrl

失敗時戻り URL

キャンセル時戻り URL

半角英数字 128 桁以内

半角英数字 128 桁以内✔

返金が失敗した場合、戻りボタン押下時に遷移する店舗 URL

×

WMB

設定不可

×

WPC

必須

○
✔

確認ページなどでキャンセルボタン押下時に遷移する店舗 URL

×

WMB

設定不可

×

WPC

必須

○
✔

23

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2.10.2 応答電文 ： EmRefundResponseDto
応答電文 ： EmRefundResponseDto
フィールド名

項目名

書式・制限

説明

serviceType

決済サービスタイプ

半角英数字 10 桁以内

要求電文を送信した決済サービスタイプ

mstatus

処理結果コード

半角英数字 32 文字以内

"success" ： 正常終了
"failure"

設定
WMB

WPC

○
○

○
○

○

○

○
○

○
○
○
○
△
△

： 異常終了"pending" ： 保留vResultCode

詳細結果コード

半角英数字 16 桁処理の結果を詳細に表すコード
4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。
詳細は『結果コード一覧』を参照下さい。

merrMsg

エラーメッセージ

文字列 1024 バイト以内

処理結果を日本語又は英語で表示

marchTxn

電文 ID

文字列 100 桁以内

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID

orderId

取引 ID

半角英数字 100 文字以内

決済要求時に店舗様にて任意に採番し送信された取引 ID

custTxn

取引毎に付く ID

文字列 100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID

receiptNo

受付番号

半角英数字 32 文字以内

決済センターへ正常に返金請求が完了した際に決済センターで採番される受付番号

appUrl決済アプリ起動

半角英数字 384 文字以内処理が成功した場合、アプリ起動 URL、決済センター側の決済画面 URL を返却

○
○
△
△

WMB

アプリ起動 URL✔

WPC

返金画面 URL

１つの取引 ID に対して、複数の ID が付与されます。

URL✔

決済と同様にアプリ上で返金処理を行います。
invoiceId

請求番号

半角英数字 25 桁

決済サーバーが WAON との通信時に発番した、決済を識別するための ID

txnVersion

MDK バージョン

半角英数字桁

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

※WAON 決済開発の注意点
WAON 決済は、楽天 Edy や Suica と異なりエラーが発生した場合以外、WAON 決済センターから消費者にメール通知が行われることはありません。
上記、要求電文フィールドの「mailAddr」はエラー通知メール用のパラメータであり、任意指定項目です。
この為、応答電文フィールドである「appUrl」を用いたリダイレクト処理、もしくは URL 自体をメールなどで消費者に通知し、WAON の決済用サイトにアクセス、または決済アプリを起動して決済するよう、店舗様にて決済フローを構築する必要があります。

24

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-11 申込（nanaco）
2.11.1 要求電文 ： EmAuthorizeRequestDto
要求電文 ： EmAuthorizeRequestDto
フィールド名

項目名

属性

桁数

説明

設定

serviceOptionType

決済サービスオプション

半角英数字

右記参照

"tcc-redirect"：nanaco 決済○

orderId

取引 ID

半角英数字

100 桁以内「2-1 共通」の「orderId（取引 ID）について」を参照○

amount

決済金額

半角数字

5 桁以内

1 以上 50,000 以下○

completeNoticeUrl

決済完了通知 URL

半角英数字

256 桁以内transactionKind

取引種別

半角数字

2桁

支払いを完了した後に遷移する URL※未指定の場合は、マーチャント登録申請時に設定した値を使用"01"：残高照会（予約語。現在はご利用いただけません。）"02"：電子マネー決済※○
取引対象利用者を一意に特定可能な ID

userIdユーザ ID

半角英数字記号

64 桁以内

半角英数字の他に以下の記号も使用可能です（RFC2822 の local-part に準拠します）。
○"!"、"#"、"$"、"%"、"&"、"'"、"*"、"+"、"-"、"/"、"="、"?"、"^"、"_"、"`"、"{"、"|"、"}"、"~".

25

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2.11.2 応答電文 ： EmAuthorizeResponseDto
応答電文 ： EmAuthorizeResponseDto
フィールド名
serviceType

項目名
決済サービスタイプ

属性

桁数

半角英数字

10 桁以内説明
要求電文を送信した決済サービスタイプ"em"： 電子マネー決済

設定○"success"：正常終了
mstatus

処理結果コード

半角英数字

32 文字以内"failure"：異常終了○"pending"：保留処理の結果を詳細に表すコード
vResultCode

詳細結果コード

半角英数字

16 文字

4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。

○

詳細は『結果コード一覧』を参照下さい。
merrMsg

エラーメッセージ

文字列

300 桁以内

処理結果を日本語又は英語で表示

marchTxn

電文 ID

文字列

100 桁以内

orderId

取引 ID

半角英数字

100 文字以内

決済要求時に店舗様にて任意に採番し送信された取引 ID○

custTxn

取引毎に付く ID

文字列

100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID○

appUrl決済アプリ起動 URL

半角英数字

384 文字以内

txnVersion

MDK バージョン

半角英数字

5桁

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID
１つの取引 ID に対して、複数の ID が付与されます。

決済処理が成功した場合、アプリ起動 URL、または決済センター側の決済画面 URL を返戻します。
電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。

○
○

△

○

26

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-12 再決済申込（nanaco）
2.12.1 要求電文 ： EmReAuthorizeRequestDto
要求電文 ： EmReAuthorizeRequestDto
フィールド名

項目名

属性

桁数

説明

設定

serviceOptionType

決済サービスオプション

半角英数字

右記参照

"tcc-redirect"：nanaco 決済○

orderId

取引 ID

半角英数字

100 桁以内

決済申込時の取引 ID を指定○

reAuthorizeRedirectionUrl

復旧リダイレクション URL

半角英数字記号

256 桁以内

復旧処理後のリダイレクト先 URL○

2.12.2 応答電文 ： EmReAuthorizeResponseDto
応答電文 ： EmReAuthorizeResponseDto
フィールド名
serviceType

項目名
決済サービスタイプ

属性

桁数

半角英数字

10 桁以内説明
要求電文を送信した決済サービスタイプ"em"： 電子マネー決済

設定○"success"：正常終了
mstatus

処理結果コード

半角英数字

32 文字以内"failure"：異常終了○"pending"：保留処理の結果を詳細に表すコード
vResultCode

詳細結果コード

半角英数字

16 文字

4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。

○

詳細は『結果コード一覧』を参照下さい。
merrMsg

エラーメッセージ

文字列

300 桁以内

処理結果を日本語又は英語で表示

marchTxn

電文 ID

文字列

100 桁以内

orderId

取引 ID

半角英数字

100 文字以内

決済要求時に店舗様にて任意に採番し送信された取引 ID○

custTxn

取引毎に付く ID

文字列

100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID○

reAuthAppUrl

復旧用アプリ起動 URL

半角英数字

380 文字以内

復旧処理が成功した場合、復旧処理用 URL を返戻します。

△

txnVersion

MDK バージョン

半角英数字

5桁

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID
１つの取引 ID に対して、複数の ID が付与されます。

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。

○
○

○
27

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2.12.3 リダイレクトパラメータ ： 決済サーバーから消費者ブラウザ経由でリダイレクト(GET)される項目
決済サーバーから消費者ブラウザ経由で店舗様へリダイレクト(GET)されるパラメータです。

リダイレクト受信内容 ： 決済サーバーから消費者ブラウザ経由でリダイレクト(GET)される項目
フィールド名
serviceType

項目名
決済サービスタイプ

属性

桁数

半角英数字

10 桁以内説明
要求電文を送信した決済サービスタイプ"em"： 電子マネー決済

設定○"success"：正常終了
mstatus

処理結果コード

半角英数字

32 文字以内"failure"：異常終了○"pending"：保留処理の結果を詳細に表すコード
vResultCode

詳細結果コード

半角英数字

16 文字

4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。

○

詳細は『結果コード一覧』を参照下さい。
merrMsg

エラーメッセージ

文字列

300 桁以内

処理結果を日本語又は英語で表示○

marchTxn

電文 ID

文字列

100 桁以内

orderId

取引 ID

半角英数字

100 文字以内

決済要求時に店舗様にて任意に採番し送信された取引 ID○

custTxn

取引毎に付く ID

文字列

100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID○

balance

残高

半角英数字

7 桁以内

決済後の電子マネーカードの残高△

completeDate

取引成立日時

半角数字

14 桁

cardNo取引カード番号

半角数字

4桁

cardBrandCode

取引カードブランドコード

半角数字

4桁

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID
１つの取引 ID に対して、複数の ID が付与されます。

取引の成立を決済サービスセンタが確定した日時
YYYYMMDDhhmmss 形式
消費者が取引に使用した電子マネーカードのカード ID 下 4 桁
ブランドを識別するコード"0001"：nanaco

○

△
△
△
電子マネーのカード種別

cardKind

カード種別

半角数字

2桁

"00"：かざして決済△"10"：かざして決済以外

28

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-13 キャンセル（nanaco）
2.13.1 要求電文 ： EmCancelRequestDto
要求電文 ： EmCancelRequestDto
フィールド名

項目名

属性

桁数

説明

設定

serviceOptionType

決済サービスオプション

半角英数字

右記参照

"tcc-redirect"：nanaco 決済○

orderId

取引 ID

半角英数字

100 桁以内

決済申込時の取引 ID を指定○

2.13.2 応答電文 ： EmCancelResponseDto
応答電文 ： EmCancelResponseDto
フィールド名
決済サービスタイプ

項目名serviceType

属性

桁数

半角英数字

10 桁以内説明
要求電文を送信した決済サービスタイプ"em"： 電子マネー決済

設定○"success"：正常終了
処理結果コード

mstatus

半角英数字

32 桁以内"failure"：異常終了○"pending"：保留処理の結果を詳細に表すコード
詳細結果コードvResultCode

半角英数字

16 桁

4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。

○

詳細は『結果コード一覧』を参照下さい。
エラーメッセージ

merrMsg

文字列

300 桁以内

処理結果を日本語又は英語で表示

○

電文 ID

marchTxn

半角英数字

100 桁以内

取引 ID

orderId

半角英数字

100 桁以内

決済要求時に店舗様にて任意に採番し送信された取引 ID○

取引毎に付く ID

custTxn

文字列

100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID○

MDK バージョン

txnVersion

半角英数字

5桁

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID
１つの取引 ID に対して、複数の ID が付与されます。

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。

○

○

29

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-14 返金（nanaco）
nanaco 決済は返金が実施できません。

2-15 カード情報削除（nanaco）
2.15.1 要求電文 ： EmRemoveRequestDto
要求電文 ： EmRemoveRequestDto
フィールド名

項目名

属性

桁数

説明

設定

serviceOptionType

決済サービスオプション

半角英数字

右記参照

"tcc-redirect"：nanaco 決済○

orderId

取引 ID

半角英数字

100 桁以内「2-1 共通」の「orderId（取引 ID）について」を参照○

決済申込時のユーザ ID を指定
userIdユーザ ID

半角英数字記号

64 桁以内※決済申込時に「かざしてお支払」を利用し、電子マネーカード情報とユーザ ID が紐づけられ○ている必要があります。

30

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2.15.2 応答電文 ： EmRemoveResponseDto
応答電文 ： EmRemoveResponseDto
フィールド名
決済サービスタイプ

項目名serviceType

属性

桁数

半角英数字

10 桁以内説明
要求電文を送信した決済サービスタイプ"em"： 電子マネー決済

設定○"success"：正常終了
処理結果コード

mstatus

半角英数字

32 桁以内"failure"：異常終了○"pending"：保留処理の結果を詳細に表すコード
詳細結果コードvResultCode

半角英数字

16 桁

4 桁ずつ 4 つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。

○

詳細は『結果コード一覧』を参照下さい。
エラーメッセージ

merrMsg

文字列

300 桁以内

処理結果を日本語又は英語で表示

電文 ID

marchTxn

半角英数字

100 桁以内

取引 ID

orderId

半角英数字

100 桁以内

決済要求時に店舗様にて任意に採番し送信された取引 ID○

取引毎に付く ID

custTxn

文字列

100 桁以内

決済サーバーがオーダー（取引 ID）と紐付ける為に採番する ID○

削除カード数

deleteCardNum

半角数字

2 桁以内

削除した電子マネーカードの数△

MDK バージョン

txnVersion

半角英数字

5桁

決済サーバーにて決済処理電文（内部処理も含む）毎に付与する ID
１つの取引 ID に対して、複数の ID が付与されます。

電文のバージョン問題発生時などに用いますが、通常ご利用になることはありません。

○
○

○

31

VeriTrans4G インターフェース詳細 ～電子マネー決済～

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

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

項目名

書式・制限

1

numberOfNotify

通知件数

半角数字 4 桁以内

2

pushTime

送信時刻

半角数字 14 桁

3

pushId

識別 ID

半角数字 8 桁

説明
1 度に通知可能な件数は 1,000 件
1,001 件以上は次回通知
決済サーバーから通知した時刻
YYYYMMDDhhmmss 形式
プッシュ処理を行うたびに採番される ID
注） 他の決済サービスで使用された ID と重複する場合があります。

通知件数分下記の項番（4～7）を繰り返す。尚、フィールド名の後ろに 4 ケタの連番（0000～0999）を付与する。
4

orderId

取引 ID

半角英数字 100 桁以内

5

emTypeEM タイプ

半角英数字 10 桁以内"edy", "suica","waon"

6

receiptDate

完了日時

半角数字 14 桁

消費者側で支払が完了した日時（入金の場合）
消費者側で返金額の受取りを完了した日時（返金の場合）
YYYYMMDDhhmmss 形式※金融機関によって時刻の扱いは異なります。

7

dummy

ダミー決済フラグ

半角数字 1 桁

ダミーデータを示す場合は"1"を設定（注意事項）


pushId（識別 ID）は、他の決済サービスで使用された Id と重複する場合がありますので、ユニークキーとして処理しないようにしてください。



項目の並び順は、必ずしも表の順序とは一致しません。

32

VeriTrans4G インターフェース詳細 ～電子マネー決済～

2-17 結果通知（nanaco 決済）
nanaco 決済における、結果通知の送信対象となる処理を下表に示します。
決済サービス名

決済申込

再決済申込

キャンセル

カード情報削除nanaco 決済

○

○

－

－

※nanaco 決済における結果通知については、他の決済サービスと一部考え方が異なります。
決済申込、および再決済申込（復旧処理）の処理状況（成功、処理未了、失敗（一部のみ））の通知であることにご注意ください。

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

フィールド名

項目名

属性

桁数

1

numberOfNotify

通知件数

半角数字

4 桁以内

2

pushTime

送信時刻

半角数字

14 桁

3

pushId

識別 ID

半角英数字

8桁

説明
1 度に通知可能な件数は 1,000 件
1,001 件以上は次回通知
決済サーバーから通知した時刻
YYYYMMDDhhmmss 形式
プッシュ処理を行うたびに採番される ID
注） 他の決済サービスで使用された Id と重複する場合があります。

通知件数分下記の項番（4～12）を繰り返す。尚、フィールド名の後ろに 4 ケタの連番（0000～0999）を付与する。
4

orderId

オーダーID

半角英数字

100 桁以内

決済要求時に店舗様にて任意に採番し送信された取引 ID

5

emTypeEM タイプ

半角英数字

10 桁以内"tcc"：nanaco 決済

6

receiptDate

完了日時

半角数字

14 桁

取引日時、またはカード書込み日時
YYYYMMDDhhmmss 形式
電子マネーのカード種別
7

cardType

カード種別

半角数字

2桁

"00"：かざして決済"10"：かざして決済以外

8

cardNo取引カード番号

半角数字

4桁

消費者が取引に使用した電子マネーカードのカード ID 下 4 桁
33

VeriTrans4G インターフェース詳細 ～電子マネー決済～
ブランドを識別するコード
9

cardBrandCode

取引カードブランドコード

半角数字

4桁

10

balance

残高

半角数字

7 桁以内

"0001"：nanaco
決済後の電子マネーカードの残高"success"：決済完了
11

settlementStatus

決済ステータス

半角英数字

10 桁以内"failure"：決済失敗"pending"：復旧処理が必要

12

dummy

ダミー決済フラグ

半角数字

1桁

ダミーデータを示す場合は"1"を設定（注意事項）


pushId（識別 ID）は、他の決済サービスで使用された Id と重複する場合がありますので、ユニークキーとして処理しないようにしてください。

nanaco 決済では、決済サーバーが決済結果をリアルタイムに把握できない状況があり得るため、定期的に決済センターへ問合せを行い、結果を店舗様に結果通知電文として PUSH 送信します。問合せの対象は、決済申込要求は成功しているものの、決済サーバーが決済センターより決済結果通知を受信していない取引です。決済サーバーから店舗様へ問合わせの結果が通知されるのは、決済が成功、または失敗している取引、および決済が未了となっている取引です。


この状況での通知は、対象の取引が複数件ある場合、まとめて 1 回の電文にて通知します。

nanaco 決済で使用する結果通知 URL は、他の電子マネー決済（楽天 Edy、Suica、WAON）と共通です。電文の「emType（EM タイプ）」フィールドの値で、nanaco 決済であるか否かを判別できます。



項目の並び順は、必ずしも表の順序とは一致しません。

34

VeriTrans4G インターフェース詳細 ～電子マネー決済～

第3章 その他 補足事項
3-1 決済メール表示
各電子マネーセンターより消費者へ送られる決済を行うためのメールにおいて、該当箇所に特定の情報を表示することができます。
テスト ID 及び、DUMMY_TYPE を設定した場合メールは送信されません。
本番 ID で且つ決済センターに通信できた場合のみ該当するメールが送信されます。

35

VeriTrans4G インターフェース詳細 ～電子マネー決済～

3.1.1 Mobile Edy
Mobile Edy 決済開始メール

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

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

Edy 決済開始メール
お取引内容ををご確認の上お支払ください。

店舗名（登録情報）

09/15 13:00

shopName(MDK 項目)

ｘｘｘｘショップ
5000 円amount（MDK 項目）
注文 ID
0000000000000000000000000000000000
0001

InvoiceId（MDK 項目）

商品一式
requestMailAddInfo（MDK 項目）
お支払い期限06/09/30 23:59 まで
settlementLimit（MDK 項目）
お支払いはこちら

36

VeriTrans4G インターフェース詳細 ～電子マネー決済～

Mobile Edy 決済完了メール

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

画面は以下のように表示されます。
Edy 決済完了メール
お支払いが完了しました。ありがとうございました。

店舗名（登録情報）
shopName(MDK 項目)

09/15 13:00
ｘｘｘｘショップ

amount（MDK 項目）

5000 円

注文 ID

InvoiceId（MDK 項目）

0000000000000000000000000000000000
0001
completeMailAddInfo（MDK 項目）
発送までしばらくお待ちください。

37

VeriTrans4G インターフェース詳細 ～電子マネー決済～

3.1.2 モバイル Suica

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

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

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

ネット決済受付：モバイル Suica
モバイル Suica のネット決済申込みを受け付けました。内容をご確認の上、支払手続きを行なってください。
□商品・サービス名
ｘｘｘｘ商品screenTitle（MDK 項目）
店舗名(登録情報）□利用店名
ｘｘｘｘショップ
□支払額
5000 円amount（MDK 項目）□決済依頼 ID
00000000000001
orderId（MDK 項目）□支払期限
06/09/30 23:59
settlementLimit（MDK 項目）
□追加情報
商品一式
サービス提供 ： JR 東日本

requestMailAddInfo（MDK 項目）

支払手続きはこちら
38

VeriTrans4G インターフェース詳細 ～電子マネー決済～

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

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

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

ネット決済完了：モバイル Suica
モバイル Suica の支払手続きが完了しました。

□商品・サービス名

screenTitle（MDK 項目）

ｘｘｘｘ商品□利用店名

店舗名(登録情報)

ｘｘｘｘショップ
□支払額
5000 円amount（MDK 項目）□決済依頼 ID
00000000000001

orderId（MDK 項目）□支払完了日時2006/09/29 10:40
発送までしばらくお待ちください。

サービス提供 ： JR 東日本

completeMailAddInfo（MDK 項目）

39

VeriTrans4G インターフェース詳細 ～電子マネー決済～

3-2 決済画面表示
3.2.1 Mobile Edy
Mobile Edy 決済画面

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

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

お取引内容をご確認下さい。
お取引内容をご確認下さい。
お支払合計額
お支払合計額\5000\5000

amount（MDK 項目）

お取引前
お取引前Edy
Edy残高
残高\8,500\8,500
お取引後
お取引後Edy
Edy残高
残高\3,500\3,500
1

実行

0

中止

40

VeriTrans4G インターフェース詳細 ～電子マネー決済～

3.2.2 モバイル Suica

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

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

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

ネット決済内容確認

screenTitle（MDK 項目）□商品・サービス名
ｘｘｘｘ商品□利用店名
ｘｘｘｘショップ
□支払額
5,000 円
□決済後の残額
6,500 円
□決済依頼 ID
00000000000001□支払期限
2006/09/30 23:59
□追加情報
商品一式

settlementLimit（MDK 項目）

上記内容で支払手続きしますか。

confirmScreenAddInfo①支払手続きする②支払手続きしない③入金（チャージ）④SF（電子マネー）

店舗名(登録情報)

amount（MDK 項目）

orderId（MDK 項目）（MDK 項目）41

VeriTrans4G インターフェース詳細 ～電子マネー決済～

モバイル Suica 決済完了画面

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

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

ネット決済完了
支払手続きが完了しました。
screenTitle（MDK 項目）□商品・サービス名
ｘｘｘｘ商品
店舗名(登録情報)□利用店名
ｘｘｘｘショップ
□支払額
5,000 円amount（MDK 項目）□決済後の残額
6,500 円
□支払完了日時2006/09/29 10:40□追加情報
発送までしばらくお待ちください。

①次へ
completeScreenAddInfo
次へ（MDK 項目）42

VeriTrans4G インターフェース詳細 ～電子マネー決済～

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

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

Suica ポケット受付：モバイル Suica
モバイル Suica の SF（電子マネー）への入金（チャージ）額を Suica ポケットでお預かりしております。内容
をご確認の上、受取手続きを行なってください。
screenTitle (MDK 項目）□サービス名ｘｘｘｘ商品返金分

店舗名(登録情報）□発行元
ｘｘｘｘショップ
□受取額

amount（MDK 項目）

5000 円□Suica ポケット依頼 ID
00000000000002

refundOrderId（MDK 項目）□受取期限
06/09/30 23:59□追加情報

settlementLimit（MDK 項目）

ｘｘｘｘ商品返金分となります。

サービス提供 ： JR 東日本

requestMailAddInfo（MDK 項目）

お受取はこちら43VeriTrans4G インターフェース詳細 ～電子マネー決済～

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

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

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

Suica ポケット内容確認□サービス名ｘｘｘｘ商品返金分

screenTitle（MDK 項目）□発行元
ｘｘｘｘショップ

店舗名(登録情報)□受取額
5,000 円
□受取後の残額
10,500 円□Suica ポケット依頼 ID
00000000000002

amount（MDK 項目）

refundOrderId（MDK 項目）□受取期限
2006/09/30 23:59
settlementLimit（MDK 項目）□追加情報
ｘｘｘｘ商品返金分となります。
上記内容で受取手続きし、SF（電子マネー）に入金（チャージ）しますか。

confirmScreenAddInfo（MDK 項目）①入金（チャージ）②Suica ポケット一覧③メニュー④SF（電子マネー）

44

VeriTrans4G インターフェース詳細 ～電子マネー決済～

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

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

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

Suica ポケット受取完了
Suica ポケットからの入金（チャージ）が完

screenTitle（MDK 項目）

了しました。

□サービス名

店舗名(登録情報)

ｘｘｘｘ商品返金分□発行元
ｘｘｘｘショップ
□受取額
5,000 円amount（MDK 項目）□受取後の残額
10,500 円□受取完了日時2006/09/30 10:00□追加情報
ｘｘｘｘ商品返金分となります。
①Suica ポケット一覧

completeScreenAddInfo（MDK 項目）

①メニュー
次へ

目）

45

VeriTrans4G インターフェース詳細 ～電子マネー決済～

3-3 メール送信一覧
電子マネー決済センターから送信される電子メールについて記載します。
ダミーモードを設定した場合、メールは送信されません。
本番 ID で且つ決済センターに通信できた場合のみ該当するメールが送信されます。

※送信有無 ： ◎：必ず送信、○：制御可、×：送信無し
送信元
↓
送信先
モバイル Edy

決済センター↓
消費者
決済センター↓
店舗様

サイバーEdy

決済センター↓
消費者
決済センター↓
店舗様

モバイル Suica（メール決済）

決済センター↓
消費者
決済センター↓
店舗様

モバイル Suica（アプリ決済）

決済センター
↓
消費者

処理

送信有無

送信制御フラグ

送信先メールアドレス

決済申込(Authorize)◎

登録済みメールアドレス（mail-addr）

決済完了通知◎登録済みメールアドレス

返金申込(Refund)×

決済申込(Authorize○

forwardMailFlag

merchant-mail-addr

決済完了通知○forwardMailFlag

merchant-mail-addr

返金申込((Refund)×

決済申込(Authorize

×

決済完了通知×

返金申込((Refund)×

決済申込(Authorize)×

決済完了通知×

返金申込((Refund)×

決済申込(Authorize◎

決済完了通知○completeMailFlag 登録済みメールアドレス

返金申込(Refund)○requestMailFlag

登録済みメールアドレス

決済申込(Authorize)○

forwardMailFlag

merchant-mail-addr

決済完了通知○forwardMailFlag

merchant-mail-addr

返金申込(Refund)○forwardMailFlag

merchant-mail-addr

決済申込(Authorize)×

決済完了通知○返金申込((Refund)×

登録済みメールアドレス（mail-addr）

completeMailFlag 登録済みメールアドレス
46

VeriTrans4G インターフェース詳細 ～電子マネー決済～
決済センター↓
店舗様

決済申込(Authorize)×

決済完了通知○返金申込((Refund)×

forwardMailFlag

merchant-mail-addr

表 3-3-1 メール送信タイミング一覧※ 全ての返金申込について、返金完了の際にメールを送信する機能はありません。

47

VeriTrans4G インターフェース詳細 ～電子マネー決済～

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

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

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

Subject ： WAON のお手続きに関して
WAON ｲﾝﾀｰﾈｯﾄｻｰﾋﾞｽをご利用いただきありがとうございます｡
受信メール
ご利用いただきました､ｲﾝﾀｰﾈｯﾄでのお手続きにつきまして処理途中に読み取り機からはずしてしまった等の原因によりお手続きが完了しておりません｡ｲﾝﾀｰﾈｯﾄでのお手続きの処理が完了していないため､店頭にてご利用いただけない状態にあります｡お手数ですが､以下の手順にしたがってお手続きを完了してください｡■お手続き方法
1.ﾊﾟｿｺﾝから再度 WAON 公式ｻｲﾄ http://www.waon.com へｱｸｾｽいた
だきﾛｸﾞｲﾝを行ってください｡
2.ﾛｸﾞｲﾝしていただき､画面上部の｢お手続きはこちら｣のﾘﾝｸをｸﾘｯｸしてください｡
3.「WAON ｶｰﾄﾞを FeliCa ﾎﾟｰﾄ搭載 PC もしくは PaSoRi(ﾊﾟｿﾘ)にかざしてください」と画面表示されます。
4.｢お手続きの処理を完了しました｡｣の画面表示がされるとお手続きが完了いたします｡
上記手順にて処理いただければ､ｲﾝﾀｰﾈｯﾄ及び店頭にてご利用いただけます｡今後も WAON ﾈｯﾄｻｰﾋﾞｽをご利用いただきますよう宜しくお願い申し上げます｡
また､本ﾒｰﾙの配信ﾀｲﾐﾝｸﾞによって､既にお手続きが完了されている場
合もございます｡予めご了承ください｡
こちらのﾒｰﾙｱﾄﾞﾚｽは､発信専用となっておりますので返信できません｡
ご注意ください｡

48

VeriTrans4G インターフェース詳細 ～電子マネー決済～

3-5 nanaco 決済 レギュレーション
nanaco 決済サービスのご利用にあたり、決済センターの指導により、店舗様の Web サイト上に表示していただく事項、および店舗様よりメールにて消費者へ通知していただく事項があります。
詳細は、『開発ガイド別冊 nanaco 決済補足資料』を参照してください。

49