VeriTrans4G Unified API (1.1.1 RC)

Download OpenAPI specification:Download

概要

導入


本ガイドはVeriTrans4G Unified APIについて、開発者向けの補足事項をまとめたガイドとなります。
キャリア決済(※)共通の項目および各キャリア決済固有の事項を記載しています。

※ID/パスワードのみで認証できる決済サービスを提供している各通信事業者を「キャリア」と呼称します。
(消費者の支払い方法の一つとして、電話料金合算払いを選択することができます。)
本ガイドにおいてキャリアは以下の事業者をさします。
    • ドコモ
    • au

キャリア決済共通事項

キャリアから消費者への配信メールについて


各キャリアより消費者へOpenID発行時、与信時等にメールが送信されます。
なお、テストID及び、requestModeをsandboxに設定した場合は、本メールは送信されません。

各キャリア/サービスとメール送信のタイミングを下表に記載します。

キャリア/サービス 送信タイミング
OpenID発行時 決済申込時(与信のみ) 与信取消時 売上時 売上取消時 随時支払時(与信のみ)
d払い 料金合算払い なし なし なし
(部分返金のみ)
ドコモ口座払い なし なし なし
auPAY(auかんたん決済)、
auPAY(ネット支払い)
なし なし なし


・d払い

支払方法 配信タイミング 配信メール種別 連絡内容
料金合算払い 都度決済時 spモードメール 利用内容の連絡
※メール本文に、以下の情報が出力されます。
 【詳細情報】
  ・マーチャント登録申請時にご登録頂いたサイト名
  ・決済申込(Pay)時の商品情報(name)
 【ご利用代金】
  ・決済申込(Pay)時の決済金額(amount)
 【課金種別】
  ・決済申込(Pay)時の課金種別(都度決済)
ドコモ口座払い 都度決済時 メッセージR 出金内容の連絡
※メール本文に、以下の情報が出力されます。
 【ご利用代金】
  ・決済申込(Pay)時の決済金額(amount)
ドコモ口座払い 与信取消時 メッセージR 購入取消し金額を連絡
※メール本文に、以下の情報が出力されます。
 【取消金額】
  ・決済申込(Pay)時の決済金額(amount)
料金合算払い 部分返金時 spモードメール 部分返金内容の連絡
※メール本文に、以下の情報が出力されます。
【ご利用代金(変更前)】
・部分返金前の決済金額
【ご利用代金(変更後)】
・部分返金後の決済金額
【お支払い予定月】
・変更後の金額で請求する年月
ドコモ口座払い 部分返金時 メッセージR 返金金額を連絡
※メール本文に、以下の情報が出力されます。
【返金日時】
・加盟店が部分返金を行った年月日時
【返金金額】
・部分返金により返金されドコモ口座に入金した金額
ドコモ口座払い 決済取消時 メッセージR 購入取消し金額を連絡
※メール本文に、以下の情報が出力されます。
 【取消金額】
  ・決済申込(Pay)時の決済金額(amount)
料金合算払い 随時支払時 spモードメール 利用内容の連絡
※メール本文に、以下の情報が出力されます。
 【詳細情報】
  ・マーチャント登録申請時にご登録頂いたサイト名
  ・随時申込(Subscribe)時の商品情報(name)
 【課金種別】
  ・随時支払(Charge)時の課金種別(随時決済)


・auPAY(auかんたん決済)、auPAY(ネット支払い)

課金タイプ 送信タイミング 連絡内容
都度、随時 OpenID発行時 ID連携通知メール
※メール本文に、以下の情報が出力されます。
 【パートナー名】
  ・店舗様がキャリア決済のお申込時に指定した【会社名略称】
都度、随時 売上確定/与信&売上確定 売上確定メール
※メール本文に、以下の情報が出力されます。
 【パートナー名】
  ・店舗様がキャリア決済のお申込時に指定した【会社名略称】
 【サービス名】
  ・店舗様がキャリア決済のお申込時に指定した【サイト名ユーザ表示用】
 【摘要】
  ・決済申込(Pay)時の商品情報(name)
 【商材種別】
  ・店舗様が提供する商材の種別が表示されます。
 【お問合せ先】
  ・店舗様がキャリア決済のお申込時に指定した【お問い合わせ窓口:電話番号】
 【商品金額】
  ・決済申込(Pay)時の決済金額(amount)
都度、随時 売上取消 売上取消メール
※メール本文に、以下の情報が出力されます。
 【パートナー名】
  ・店舗様がキャリア決済のお申込時に指定した【会社名略称】
 【サービス名】
  ・店舗様がキャリア決済のお申込時に指定した【サイト名ユーザ表示用】
 【摘要】
  ・決済申込(Pay)時の商品情報(name)
  ※継続課金の場合上記の前に、
「毎月○○日に課金」の旨の内容を決済サーバから指定します。
 【商材種別】
  ・店舗様が提供する商材の種別が表示されます。
 【お問合せ先】
  ・店舗様がキャリア決済のお申込時に指定した【お問い合わせ窓口:電話番号】
 【商品金額】
  ・決済申込(Pay)時の決済金額(amount)
都度、随時 部分返金時 金額変更メール
※メール本文に、以下の情報が出力されます。
 【パートナー名】
  ・店舗様がキャリア決済のお申込時に指定した【会社名略称】
 【サービス名】
  ・店舗様がキャリア決済のお申込時に指定した【サイト名ユーザ表示用】
 【摘要】
  ・決済申込(Pay)時の商品情報(name)
 【お問合せ先】
  ・店舗様がキャリア決済のお申込時に指定した【お問い合わせ窓口:電話番号】
 【変更金額】
  ・キャンセル(Cancel)時の返金金額(amount)
  ※マイナス値で出力されます。
  ※キャンセルで金額を指定しなかった場合は、部分返金時の残高が出力されます。

キャリア毎の決済固有取引IDに対する項目名について


決済固有取引ID(providerOrderId)に該当する項目名は、それぞれ以下の名称となります。

キャリア 項目名(桁数)
d払い 決済番号(12桁)
auPAY(auかんたん決済) / auPAY(ネット支払い) 伝票番号(16桁~19桁)

ドコモ

決済確認画面に表示される表示内容について


決済申込におけるドコモ側の画面遷移の中で、SPモードパスワードを入力する画面表示が以下のようになります。

スマートフォンの表示例

本画面において、「決済詳細」には、加盟店様の契約内容が表示されます。
ただし、包括契約の場合には、決済申込において指定した「商品タイプ(commodityType)」によって表示される内容が決まります。

決済内容の表示内容

組み合わせ 表示される内容
デジタルコンテンツ+都度 デジタルコンテンツ(都度)
物販/役務+都度 物品販売(都度)

加盟店名には「株式会社DGフィナンシャルテクノロジー」が表示されます。

詳細情報は2行構成となっており、
1行目には店舗様の「サイト名」が表示されます。
2行目には決済申込において指定した「商品情報(name)」の値が表示されます。

ドコモより消費者に送信されるメールに関する注記


申込が完了(ドコモ側にて成功)すると、ドコモより消費者にメールが送信されます。
このメールにも確認画面にて表示される「決済内容」、「加盟店名」、「詳細情報」が記載されます。

生体認証機能について


2015年12月よりd払いでは、生体認証機能搭載の端末で指紋や虹彩など生体による認証が可能となります。
(包括契約を締結している加盟店様は2015年12月時点では、ご利用頂けません。ご利用開始日については現在検討中です。)

なお、生体認証機能は、携帯端末にプリインストールのブラウザ(端末の標準ブラウザおよびChromeブラウザ)のみ対応となっております。
それ以外のブラウザや加盟店様独自のアプリ内ブラウザ(WebView)では、生体認証機能はご利用頂けません。

※加盟店様独自のアプリ内ブラウザ(WebView)をご利用の場合の注意点

    ドコモ側では、生体認証機能を使える端末やブラウザの判定にUserAgent(以下、UA)を利用していますが、以下の条件全てに合致する場合には生体認証ボタンが表示され、このボタンを選択するとWebViewは非対応のため「ページが見つかりませんでした」というエラーが表示されます。

      <エラーとなる条件>
      条件1: サービスアプリでWebViewを使用している
      条件2: 標準ブラウザと同じUA情報を返す実装になっている
      条件3: docomo IDログイン画面や決済画面をWebViewで表示している

    これを回避するために、以下の対応をお願いします。
    ※既に標準ブラウザとは異なる独自のUAを使用している場合には、特に対応の必要はありません。

      <対応内容> WebViewで使用するUAの末尾に、”/(任意の文字列)” を付加する。
      ※文字列は半角英数字

      例)F-04Gの場合
      ・標準ブラウザのUA:
      Mozilla/5.0 (Linux; Android 5.0.2; F-04G Build/V14R36F) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0
      Chrome/37.0.0.0 Mobile Safari/537.36

      ・独自UA:
      Mozilla/5.0 (Linux; Android 5.0.2; F-04G Build/V14R36F) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0
      Chrome/37.0.0.0 Mobile Safari/537.36/nobioauth

キャンセルについて


 部分返金要求時にエラーが発生した場合の注意点

    以下のケースで部分返金を行った場合、ドコモ側システムの処理が間に合わず、エラーが発生する可能性があります。

    対象のケース エラーコード
    resultCode vResultCode
    売上後、すぐに部分返金を行った場合 UA-PRV-001 WG20
    部分返金を実施後、すぐにもう一度部分返金を行った場合 UA-PRV-002 WG11

    このケースで上記のエラーコードを受信した場合には、時間をおいてから再度実施してください。

 部分返金時に返金される優先順について

    d払いの部分返金については以下の順で返金されます。

    決済時にご利用の基本となるお支払い方法(電話料金合算払い)から優先的に減額(返金)し、ドコモ口座充当、dポイント充当の順に減額(返金)します。

    例)決済金額:300円(電話料金合算払い:100円、ドコモ口座充当:200円)に対し、200円減額する場合、電話料金合算払い:100円返金、ドコモ口座充当:100円返金となり、ドコモ口座充当:100円が請求対象となる。


 dポイントの返還について

    dポイントを充当してお支払いした決済に対し、加盟店による取消処理または減額となる補正処理が行われた場合、充当したdポイントは利用者に返還されます。
    ただし、加盟店による取消処理または減額となる補正処理が行われた時点で返還するポイントが失効していた場合、 利用者へポイント返還は行われません(加盟店の取消処理または補正処理は正常に行われます)。
    完了要求実施最終期限までに加盟店による完了処理が正常に完了しなかった場合、ご利用ポイントは利用者へ返還されます。

ドコモ社との直接契約について


 サービス開始までの流れ

    加盟店様がドコモ社と直接契約し、VeriTrans4Gのd払いを導入される場合のサービス開始までのお手続きの流れを以下にご説明します。
    ※詳細につきましては弊社営業またはテクニカルサポートにお問合せください。

    1. ドコモ社とのご契約
      ご契約の際に、以下のIDが発行されます。このIDはURL登録や接続試験の申請等で必要になります。
      • IPID・・・加盟店様を識別するID
      • サイトID・・・加盟店様のサイトを識別するID(弊社システムからドコモ社システムへ接続するために必要)
      • サブID・・・BPサイトにログインするためのID

    2. BPサイトでのURL登録
      ドコモ社提供の管理画面「BPサイト」にログインし、システム接続に必要な、弊社のインターフェースURL等をご登録いただきます。
      ※登録作業については、弊社側で実施することも可能です。

    3. 接続試験期間の申請
      接続試験を実施するために、ドコモ社に接続試験期間の申請をしていただきます。
      申請方法については、ドコモ社のドキュメント『d払い_接続試験手順書』をご確認ください。
      なお、申請の際には連絡事項に以下の記載をしてください。
      「【ベリトランスPF】加盟店名(サイトID)」

    4. 接続試験の実施
      加盟店様の試験環境にて、弊社およびドコモ社との接続試験を実施していただきます。
      試験内容については、ドコモ社のドキュメント『d払い_接続試験チェックシート(都度決済)』をご確認ください。
      ※試験環境をご提示いただければ、弊社側で代わりに実施することも可能です。

    5. 接続試験結果の提出
      接続試験結果をドコモ社に提出していただきます。
      提出方法については、ドコモ社のドキュメント『d払い_接続試験手順書』をご確認ください。

    6. サービス開始
      ドコモ社で接続試験の結果が承認されたあとに、サービス提供開始可能となります。


 BPサイトご利用の際の注意点

    ドコモ社提供の管理画面「BPサイト」では、取引に対する売上や取消の操作が可能ですが、BPサイトからそれらの操作を行われますと、その結果が弊社システムには反映されないため、ドコモ社と弊社で取引データの状態不整合が発生します。
    そのため、売上や取消の処理は必ず弊社提供のMAP(Merchant Administration Portal)から実施してください。

au

エンドユーザの認証について


対象種別:auPAY(auかんたん決済)

auPAY(auかんたん決済)は、Open IDのプロトコルを用いたau IDを認証基盤とした決済方式と、au PAYアプリ内で認証および決済をする決済方式がございます。

以下は、au ID認証基盤を利用した場合についてご説明いたします。
auID認証基盤を利用した場合、au IDで認証を行う「au IDログイン」と、加盟店様サイトの独自IDで認証を行う「ID連携」の2つの認証方式を提供しており、auPAY(auかんたん決済)を利用するうえでどちらかの認証を利用する必要がございます。

「au IDログイン」と「ID連携」の機能は、決済申込および随時申込時のパラメータ「ログインタイプ(loginType)」の設定値を切り替えることでご利用できます。
※未設定の場合は、「ID連携」となります。
※加盟店様サイトで独自のユーザ認証を行わずに(加盟店様サイトにログインさせずに)auPAY(auかんたん決済)を提供する場合には、必ず「au IDログイン」をご利用下さい。

ID連携

    加盟店様サイトの独自IDとau IDを連携し、KDDIから発行されるOpen IDを加盟店様の独自IDと併せて会員管理・認証を行う方式です。
    独自IDにて加盟店様サイトの認証を行います。独自IDとau IDの連携を行うため、エンドユーザは初回のみau ID/PWの入力が必要となります。

au IDログイン
    au IDログインは、au ID/PWの入力により加盟店様サイトへログインし、KDDIから発行されるOpenIDをもとに会員管理・認証を行う方式です。
    au IDにて加盟店様サイトの認証を実施します。

■KDDIから発行されたOpen IDが利用できなくなるパターンは以下の通りです。
  • エンドユーザ自身がPC/携帯電話で、WEB上より連携を解除した場合
  • エンドユーザが一定期間(1年)以下のいずれも行っていない場合
    • au IDと加盟店様サイトの独自IDとの認証・決済処理
    • au IDで加盟店様サイトへのログイン
    • 加盟店様サイトのauPAY(auかんたん決済)処理
  • エンドユーザが通信サービスを解約または、譲渡した場合

部分返金について


対象種別:auPAY(auかんたん決済)、auPAY(ネット支払い)

部分返金を利用するにはKDDIへの申請が必要です。ご利用の場合は、テクニカルサポートまたは担当営業にご連絡ください。

部分返金が可能であっても、消費者様が決済申込時に選択した支払方法によっては、部分返金要求時にresultCode=UA-CST-001およびvResultCode=WG24が返戻されることがあります。
当該取引では部分返金は行えないため、代替手段での返金をご検討ください。

随時決済に関する特記事項


対象種別:auPAY(auかんたん決済)

  1. 随時決済の利用承諾時、KDDIから消費者への通知はありませんので、必要に応じて店舗様にて消費者への申込完了画面の表示やメール通知をご対応ください。
  2. 随時決済の利用承諾では申込内容のオーソリ枠を事前に確保することができないため、随時決済の際に消費者の利用限度額を超過した場合などには処理に失敗することがあります。
    上記の旨を利用承諾時点で消費者に説明(提示)いただくとともに、商品提供等を行う場合は売上確定を確認後に提供するフローの徹底をお願いいたします。
  3. 売上確定でエラーが発生した場合は以下のような対応検討をお願いいたします。
    売上確定でのエラーコード 消費者への失敗通知
    resultCode vResultCode
    UA-CST-001 WG39 必要
    WG40
    上記以外のエラーコード 任意
    • 消費者への失敗通知
      • 売上確定でのエラーコードがresultCode=UA-CST-001かつResultCode=WG39、もしくはresultCode=UA-CST-001かつResultCode=WG40の場合は消費者起因のエラーのため売上処理ができません。
        消費者に売上失敗の旨を通知し、必要に応じて失敗した売上を別の支払い方法で行うようご検討ください。
        それ以外のエラーコードは『結果コード一覧』の「想定される原因」、および「発生した場合の対処例」を参考に対応をご検討ください。

  4. 随時決済の利用承諾終了処理を行った場合や抹消通知(Deregistration)を受信した場合には、消費者に対して随時決済終了通知を画面表示・メール等でご対応ください。
  5. 店舗様画面では消費者が随時決済の終了手続きをスムーズに進められるよう分かりやすいインターフェースをご検討ください。

改訂履歴

バージョン リリース年月 更新内容
1.1.0 RC 2025/06  新規作成
1.1.1 RC 2025/09
  1. 以下の項目を追加記載および修正
    • au
      • auかんたん決済のサービス名称をauPAY(auかんたん決済)に変更
    • ドコモ
      • 「売上/取消要求中ステータスについて」を削除