銀行決済
本ドキュメントについて
本ガイドは、(株)DGフィナンシャルテクノロジーが提供するVeriTrans4Gを利用するための専用ソフトウェアMDK（Merchant Development Kit）をインターネット店舗などに導入する開発者向けのガイドです。VeriTrans4G 銀行決済にて使用する電文のインターフェース詳細について記載しています。
VeriTrans4Gの詳細については、『VeriTrans4G 開発ガイド』を参照して下さい。
尚、インターフェース詳細は、決済サービス毎に提供していますので、当該決済サービスのインターフェース詳細を参照して下さい。
インターフェース詳細
本章では、各決済にて使用する電文（Dto）について説明します。以下の表に記載されているフィールドは、店舗様にて利用可能なフィールドです。
各電文（Dto）には、以下の表に記載されていないフィールドが定義されている場合がありますが、以下の表に記載されていないフィールドは店舗様では使用することはできません。
共通
-
「設定」欄の内容は以下の通りです。
- 要求電文 ...
- 必須項目：○ 任意項目：△ 設定不可：× その他条件付：※、※n（条件は説明欄、または欄外に記入）
- 応答電文 ...
- 必ず返戻：○ 処理成功時のみ返戻：△ 返戻なし：× その他条件付：※
-
orderId（取引ID）について
店舗で任意に採番してください。申込処理毎に付ける必要があります。他の取引IDと重複しないよう採番してください。他決済サービスとも重複できません。
また、テスト取引で使用した取引IDを、本番取引で再度使用することはできません。
取引IDには、半角英数字以外に"-"（ハイフン）、"_"（アンダースコア）も使用可能です。
申込
要求電文 ： BankAuthorizeRequestDto
| 要求電文 ： BankAuthorizeRequestDto | ||||
|---|---|---|---|---|
| フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 |
| serviceOptionType | 決済サービスオプション | 右記参照 | "atm"：番号通知方式(ATM決済) "netbank-pc"：銀行リンク方式(ネットバンク決済) |
○ |
| orderId | 取引ID | 半角英数字100桁以内 | 「2-1 共通」の「orderId（取引ID）について」参照 | ○ |
| amount | 決済金額 | 半角数字10桁以内 | 1以上 9,999,999,999以下 | ○ |
| name1 | 顧客名1 | 全角10文字以内 | 購入者名
※詳細は「3-1 銀行決済 使用可能文字一覧」を参照して下さい。 |
○ |
| name2 | 顧客名2 | 全角10文字以内 | 購入者名（予備）
※詳細は「3-1 銀行決済 使用可能文字一覧」を参照して下さい。 |
△ |
| kana1 | 顧客名カナ1 | 全角10文字以内 | 購入者名（カナ）
※詳細は「3-1 銀行決済 使用可能文字一覧」を参照して下さい。 |
○ |
| kana2 | 顧客名カナ2 | 全角10文字以内 | 購入者名（カナ）（予備）
※詳細は「3-1 銀行決済 使用可能文字一覧」を参照して下さい。 |
△ |
| payLimit | 支払期限 | 半角数字8桁右記参照 | 支払期限（YYYYMMDD形式） 当日～60日後を支払期限に指定可能。 |
○ |
| pushUrl | プッシュURL | URLに使用可能な半角文字256桁以内 | 入金通知先URLを指定
※未指定の場合は、MAPの「各種設定変更」で設定した入金通知URLに通知されます。 |
△ |
| contents | 請求内容（漢字） | 全角12文字以内 | インフォメーションとしてATM等に表示 | ○ |
| contentsKana | 請求内容（カナ） | 全角24文字以内 | インフォメーションとしてATM等に表示 | ○ |
| payCsv | 決済機関コード | 半角数字4桁 | 支払を行う金融機関を固定する場合に金融機関コードを指定 金融機関コードはhttps://www.veritrans.co.jp/payment/bank/list.htmlを参照。 |
△ |
| termUrl | 決済結果戻り先URL | URLに使用可能な半角文字128桁以内 | 決済完了後に店舗側サイトへ遷移を戻すためのURL 決済サービスオプションが銀行リンク方式（ネットバンク決済）かつ決済機関コードを指定しない場合のみ設定可能です。 |
△ |
| pushExpantionFlag | 結果通知パラメータ追加フラグ | 半角数字1桁 | "1"： 結果通知に追加のパラメータを設定する "0"： 結果通知に追加のパラメータを設定しない ※ 未指定の場合は、MAPの「各種設定変更」の「入金通知パラメータを追加する」に設定された状態に従います。 ※ 追加パラメータの詳細は、「2-3 結果通知」を参照してください。 |
△ |
応答電文 ： BankAuthorizeResponseDto
| 応答電文 ： BankAuthorizeResponseDto | |||||||
|---|---|---|---|---|---|---|---|
| フィールド名 | 項目名 | 書式・制限 | 説明 | 設定 | |||
| serviceType | 決済サービスタイプ | 半角英数字10桁以内 | 要求電文を送信した決済サービスタイプ | ○ | |||
| mstatus | 処理結果コード | 半角英数字32文字以内 | "success"：正常終了 "failure"：異常終了 "pending"：保留 |
○ | |||
| vResultCode | 詳細結果コード | 半角英数16桁 | 処理の結果を詳細に表すコード 4桁ずつ4つのブロックで構成され、各ブロックでサービス毎の処理結果を表します。 詳細は『結果コード一覧』を参照下さい。 |
○ | |||
| merrMsg | エラーメッセージ | 文字列300桁以内 | 処理結果を日本語で表示します。 | ○ | |||
| marchTxn | 電文ID | 文字列100桁以内 | 決済サーバーにて決済処理電文（内部処理も含む）毎に付与するID １つの取引IDに対して、複数のIDが付与されます。 |
○ | |||
| orderId | 取引ID | 文字列100桁以内 | 決済要求時に店舗様にて任意に採番し送信された取引ID | ○ | |||
| custTxn | 取引毎に付くID | 文字列100桁以内 | 決済サーバーがオーダー（取引ID）と紐付ける為に採番するID | ○ | |||
| requestId | リクエストID | 半角英数字記128桁以内 | 要求に対する任意のIDです。記号は"@"、"-"が含まれます。 | △ | |||
| shunoKikanNo | 収納機関番号 | 半角英数字8桁以内 | 番号通知方式 | 処理成功時のみ返戻 | △ | ||
| 銀行リンク方式 | 決済機関コード未指定 | 【返戻なし】 | × | ||||
| 決済機関コード指定 | 処理成功時のみ返戻 | △ | |||||
| customerNo | お客様番号 | 半角英数字20桁以内 | 番号通知方式 | 処理成功時のみ返戻 | △ | ||
| 銀行リンク方式 | 決済機関コード未指定 | 【返戻なし】 | × | ||||
| 決済機関コード指定 | 【返戻なし】 | × | |||||
| confirmNo | 確認番号 | 半角英数字6桁以内 | 番号通知方式 | 処理成功時のみ返戻 | △ | ||
| 銀行リンク方式 | 決済機関コード未指定 | 【返戻なし】 | × | ||||
| 決済機関コード指定 | 【返戻なし】 | × | |||||
| billPattern | 支払パターン | 文字列128文字以内 | 番号通知方式 | 【返戻なし】 | × | ||
| 銀行リンク方式 | 決済機関コード未指定 | 【返戻なし】 | × | ||||
| 決済機関コード指定 | 処理成功時のみ返戻 | △ | |||||
| bill | 支払暗号文字列 | 文字列1024文字以内 | 番号通知方式 | 【返戻なし】 | × | ||
| 銀行リンク方式 | 決済機関コード未指定 | 【返戻なし】 | × | ||||
| 決済機関コード指定 | 処理成功時のみ返戻 | △ | |||||
| url | URL | 半角英数字512桁以内 | 番号通知方式 | 【返戻なし】 | × | ||
| 銀行リンク方式 | 決済機関コード未指定 | 処理成功時のみ返戻 金融機関選択画面へのURL（接続時にはGETをご使用ください。） |
△ | ||||
| 決済機関コード指定 | 処理成功時のみ返戻 金融機関が提供する入金画面へのURL（接続時にはPOSTをご使用ください。） |
△ | |||||
| view | 画面情報 | 文字列 | 番号通知方式 | 【返戻なし】 | × | ||
| 銀行リンク方式 | 決済機関コード未指定 | 処理成功時のみ返戻 | △ | ||||
| 決済機関コード指定 | 【返戻なし】 | × | |||||
| txnVersion | MDK バージョン | 半角英数字5桁 | 電文のバージョン 問題発生時などに用いますが、通常ご利用になることはありません。 |
○ | |||
結果通知
決済サーバーは、決済センターからの入金完了情報（消費者の支払完了情報）を受け取り、該当の入金が完了したと判断した場合に店舗様へ入金通知を送信します。
※入金が結果通知対象となります。
結果通知に関するサービス共通の仕様については、『開発ガイド』を併せてご参照ください。
-
pushId（識別ID）について
各決済の結果通知において、pushId（識別ID）は重複する事がありますのでユニークキーに設定しないようにご注意下さい。
| 項番 | フィールド名 | 項目名 | 書式・制限 | 説明 |
|---|---|---|---|---|
| 1 | numberOfNotify | 通知件数 | 半角数字4桁以内 | １回の送信に含まれる取引の件数。 初回の通知は1件ずつ送信します。 結果通知に対してHTTPステータスコード"200"が返戻されなかった場合はリトライを実施しますが、リトライ時はリトライ対象の取引を複数件まとめて送信します。 1度に通知可能な件数は50件で、 51件以上の場合は次回の通知になります。 |
| 2 | pushTime | 送信時刻 | 半角数字14桁 | 決済サーバーから通知した時刻 YYYYMMDDhhmmss形式 |
| 3 | pushId | 識別ID | 半角数字8桁 | プッシュ処理を行うたびに採番されるID |
| 通知件数分下記の項番（4～13）を繰り返す。尚、フィールド名の後ろに4ケタの連番（0000～0049）を付与する。 | ||||
| 4 | orderId | 取引ID | 半角英数字100桁以内 | |
| 5 | kikanNo | 収納機関コード | 半角英数字8桁以内 | 弊社を表す固定値で、収納機関番号と同じものを表します。ペイジーとペイジー以外で値が異なっています。 決済応答電文の収納機関番号と同じ値となりますが、ペイジーの場合は、決済応答電文の収納機関番号と表記方法が異なり収納機関番号+000の値が設定されます。 |
| 6 | kigyoNo | 収納企業コード | 半角英数字5桁以内 | 加盟店ごとに割り当てられているコード |
| 7 | rcvDate | 収納日時 | 半角英数字12桁以内 | 消費者側で支払が完了した時刻 YYYYMMDDhhmm形式 |
| 8 | customerNo | お客様番号 | 半角数字20桁以内 | 銀行リンク方式の場合も設定されます。銀行リンク方式で入金が出来なかった場合でも、この番号を使用してペイジーでの入金が可能です（住信ＳＢＩネット銀行、PayPay銀行を除く）。 |
| 9 | confNo | 確認番号 | 半角英数字6桁以内 | 同上 |
| 10 | rcvAmount | 入金金額 | 半角数字10桁以内 | |
| 11 | dummy | ダミー決済フラグ | 半角数字1桁 | ダミーデータを示す場合は"1"を設定 |
| 以下のパラメータは「結果通知パラメータ追加フラグ」が有効の場合に設定されます。 | ||||
| 12 | bankCode | 金融機関コード | 半角数字4桁 | 入金が行われた金融機関のコード。 金融機関コードはhttps://www.veritrans.co.jp/payment/bank/list.htmlを参照。 |
| 13 | payEasyFlag | ペイジーフラグ | 半角数字1桁 | ペイジーでのお支払いの場合は"1"を設定 ペイジー以外でのお支払いの場合は"0"を設定 |
- 項目の並び順は、必ずしも表の順序とは一致しません。
その他 補足事項
決済サービスオプションについて
決済サービスオプションタイプには、番号通知方式と銀行リンク方式の２つのタイプがあります。
番号通知方式はペイジーでの支払いに必要な３つの番号「収納機関番号」「お客様番号」「確認番号」を返戻します。消費者はこの番号をATMまたはネットバンキングのペイジー決済の画面に入力して入金を行います。
以下の２つの金融機関についてはペイジー決済とは異なる独自の決済方式での支払いとなりますため、番号通知方式には対応しておりません。
- 住信ＳＢＩネット銀行
- PayPay銀行
- PayPay銀行はペイジーでのお支払いを提供していますが、弊社との契約がないため、本サービスではペイジー決済を利用することはできません。
銀行リンク方式は加盟店ECサイトから金融機関のネットバンキングのサイトに遷移します。決済情報は弊社から金融機関に連携されますので、消費者は「収納機関番号」「お客様番号」「確認番号」を入力することなく入金操作を行うことができます。
銀行リンク方式で金融機関コードを指定しなかった場合は、弊社の金融機関選択画面が表示され、選択した金融機関のサイトに遷移します。金融機関コードを指定した場合は指定した金融機関のサイトに遷移します。
それぞれのフローについては、『概略システムフロー図』をご確認ください。
取扱金融機関について
- 取扱可能な金融機関の一覧は以下のURLよりご参照ください。
https://www.veritrans.co.jp/payment/bank/list.html - 上記URLの一覧に記載されている「ATMでのお支払い」の列は、「金融機関の店舗やコンビニエンスストアのATM端末での支払いが可能か否か」を示しており、番号通知方式の利用可否を示すものではございません。「ATMでのお支払い」の列に「〇」の記載が無い金融機関でも、各金融機関のWEBサイトからペイジー決済を利用することが可能です（住信ＳＢＩネット銀行、PayPay銀行を除く）。
使用可能文字一覧
銀行決済の下記全角項目にて、JIS基本漢字（JIS X 0208）で使用可能な文字の範囲を以下に表します。
使用可能文字の範囲外の文字を使用した場合、文字化けが発生し処理エラーとなる可能性があります。
-
顧客名1（name1）、顧客名2（name2）、請求内容（漢字）（contents）
区点 内容 01区 パラレル∥、ダッシュ―、マイナス－、セント￠、ポンド￡以外の記号 02区 否定記号￢以外の記号 03区～08区 各種記号、平仮名、カタカナ、アルファベット等 16区～47区 第一水準漢字 48区～84区 第二水準漢字 -
顧客名カナ1（kana1）、顧客名カナ2（kana2）、請求内容（カナ）（contentskana）
区点 内容 01区 括弧（） ピリオド． スラッシュ／ カギ括弧「」
ハイフン ‐ 長音符ー03区 数字・アルファベット 05区 カタカナ
顧客名・請求内容について
「顧客名1」、「顧客名2」、「顧客名カナ1」、「顧客名カナ2」、「請求内容（漢字）」、「請求内容（カナ）」は、ATMの画面やATMの利用明細、ネットバンキングの画面に表示されますが、どの項目がどのように表示されるかは、金融機関の仕様になります。必ず表示されるのか、漢字、カナのどちらが表示されるのかなども金融機関の仕様次第になります。
「顧客名1」、「顧客名2」の入力に特に決まりはございませんが、「顧客名1」に姓、「顧客名2」に名を設定するのが一般的です。会社名を入力する場合、「顧客名1」に「○○○○○○○○」、「顧客名2」に「株式会社」といったように入力してもよろしいかと思います。
「顧客名1」、「顧客名2」それぞれの文字数に収まらない場合は、「顧客名1」と「顧客名2」を連結した形で収まるように工夫して設定してください。