VeriTrans4G Unified API (1.1.1 RC)

Download OpenAPI specification:Download

概要

導入


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

全決済タイプ共通事項

スマートフォンを利用した決済の注意事項

■スマートフォンのブラウザを利用した決済について


消費者が決済を行う際に、加盟店サイトからの遷移で事業者のアプリが起動し、操作により決済が完了後「標準ブラウザ」が起動されて、新しいタブで画面遷移用URL(successUrl/cancelUrl/errorUrl)が呼び出されます。

  • 決済を開始したブラウザとは異なるブラウザが起動することがあります。
  • 標準ブラウザで決済を開始した場合にも、新しいタブで処理が完了します。

  • そのため、この挙動により、加盟店様のWebアプリケーションのセッション情報等が引き継がれなくなる可能性が考えられますが、そのような場合にも、弊社決済サーバーからブラウザを経由して連携する決済結果を受け取り、正常に処理できるように実装してください。

    ■スマートフォンの加盟店アプリを利用した決済について


    加盟店アプリ画面上から決済申込及び随時申込をし、消費者が各決済事業者アプリで決済完了した後、標準ブラウザを介したリダイレクトが実行されます。この際、消費者導線を加盟店アプリへ戻すためには、加盟店アプリを起動するためのランディングページを作成する必要があります。
    そのため、決済申込(pay)及び随時申込(subscribe)時の画面遷移用URL(successUrl/cancelUrl/errorUrl)には、作成したランディングページのURLを指定してください。
    この際、ランディングページは消費者環境の「標準ブラウザ」で表示されます。

    ■遷移フロー図

    加盟店アプリ利用時の流れ

    ■ランディングページ作成例

    以下の設定を持つ加盟店アプリに遷移したい場合のHTMLページのサンプルを示します。

    • 起動時のURLスキーム : unifiedApisample
    • 起動時のURLホスト : www.example.com
    • 起動時のURLパス : result
    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    <HTML>
    <HEAD>
    <TITLE>アプリ起動</TITLE>
    </HEAD>
    <SCRIPT language="javascript" type="text/javascript">
      window.location.href = "unifiedApisample://www.example.com/result";
    </SCRIPT>
    <BODY>
    ○○アプリを起動します。
    </BODY>
    </HTML>
    

    ※リリースまでには必ずLive環境にてテストを実施し実際の動作を確認してください。

    データの保持期限について


    どのコマンドにも共通する設定としてデータの保持期限が存在し、400日間となっています。
    データが使用されずに、データの保持期限を超えた場合は使用できなくなります。

    処理要求可能期間について


    決済タイプにおける各処理のリクエスト可能期間を下表に示します。
    下記期間は決済事業者が定める期間のため、VeriTrans4G Unified APIではチェックを行いません。

    決済タイプ API リクエスト可能期間
    PayPay 売上 申込有効期限まで※1
    売上前キャンセル
    売上後キャンセル 決済申込日(随時決済の場合は随時支払日)翌日を1日目として、365日
    随時支払 随時決済申込日もしくは最終の随時支払日から365日 ※2
    楽天ペイ 売上 決済申込日(申込日)を起算日として、365日後まで
    かつ、最後の申込を起算日として、30日後まで
    売上前キャンセル 決済申込日を起算日として、365日後まで
    売上後キャンセル 決済申込日を起算日として、365日後まで
    かつ、売上日を起算日として、30日後まで
    随時支払 随時決済申込日もしくは最終の随時支払日から400日 ※3
    ドコモ d払い 売上 決済申込日を起算日として翌々月末日 20:00
    売上前キャンセル
    売上後キャンセル 決済日を含む180日(決済日から179日後)の20:00
    随時支払 随時決済申込日から400日 ※3 ※4
    au auPAY(auかんたん決済) 売上 決済申込日を起算日として90日後
    売上前キャンセル
    売上後キャンセル 売上確定日を起算日として翌々月末日
    随時支払 随時決済申込日から400日 ※3 ※4
    auPAY(ネット支払い) 売上 決済申込日を起算日として45日後
    売上前キャンセル
    売上後キャンセル 売上確定日を起算日として90日
    随時支払 随時決済申込日から400日 ※3 ※4
    メルペイ 売上 与信の取得から60日間
    売上前キャンセル
    売上後キャンセル 売上確定から365日間
    随時支払 随時決済申込日もしくは最終の随時支払日から1年


    1. 詳細は「申込有効期限について」をご参照ください。
    2. 随時支払の要求可能期間を超過した場合、随時支払を実行すると結果応答の「resultCode」で
      UA-REQ-006を返戻し決済処理はエラーとなります。
      しかし随時決済は「承諾」状態のままPayPayアプリ上でも加盟店との連携が解除されておりません。
      上述の通り、有効期限切れとなった後に決済処理が成功することはありませんが、
      消費者側でのステータス齟齬による問合せを避けるため加盟店様にて解約操作を明示的に実行し、
      承諾終了にしていただくことを推奨します。
    3. データ保持期限の超過により、データが削除されます。
    4. 継続して随時支払に使用していれば、取得から400日を経過しても決済サーバから削除されません。
      ただし、一定期間、再与信の発生がなかった場合は、キャリア側(ドコモ/au)で利用承諾終了となり、利用できなくなります。

    二重取引について


    決済成功(与信売上確定・与信確定・承諾確定)するまで、同一paymentIdでリトライ可能です。
    しかし、決済失敗が確定する前に、再度paymentIdを実行した場合、タイミングによっては二重取引となることがあります。(resultCode=UA-000-002
    その場合はMAP(Merchant Administration Portal)で取引情報を確認し、不要な取引をキャンセルするようにお願いします。
    Unified APIとしては、一番はじめに成功となった取引を正とし、以降に成功となった取引の後続処理は不能となります。

    たとえば、1番目の決済成功となった取引のfepOrderIdが「fepOrderId_01」とし、2番目に決済成功となった取引のfepOrderIdが「fepOrderId_02」となったとき、FEPで後続処理を行えるのは「fepOrderId_01」のみです。

    売上について


     物販の一部発送(売上)について

      決済において、1件の与信に対して売上は1度しか実行できません。
      商品の発送の都合等、物販の一部発送により売上を2回以上に分ける場合は、2回目以降の売上時に再度与信を取得するか、全て発送してから売上を実行するようにしてください。

    PayPay

    決済金額について


    1回当りの支払上限金額は以下の通りとなります。

    支払方法 上限金額
    PayPay残高 100万円

    ※詳細は各決済事業者の仕様に従います。最新情報は以下のサイトをご参照ください。URLは変更となる場合があります。
    《PayPay》  https://paypay.ne.jp/help/c0043/

    申込有効期限について(都度決済)


    取引の申込有効期限は「決済申込時点から指定の申込有効期限日数後の同時刻まで」です。
    決済申込時点の取引は申込のみを取得した状態です。
    売上処理は申込取得後から申込有効期限を超過するまでに行ってください。

    加盟店様にて申込有効期限日数を設定する方法を以下に示します。
    設定変更はMAPの各種設定変更画面から行うことができます。

    ①申込有効期限日数を指定する
     「申込有効期限日数」欄に1~30日で任意の日数を設定してください。
     <注意事項>
     決済事業者のデフォルトの有効期限上限日数は30日ですが、
     事業者との調整で上限日数を30日より短くしている場合にそれを超える値を設定すると申込処理でエラーが発生します。
     例) 加盟店様の上限日数が20日に設定されている場合にMAPで30日を設定して申込する。

    ②PayPayに直接申し込んだ有効期限日数を使用する
     MAPで設定可能な有効期限日数の上限は30日です。
     この上限値制約を超える日数を適用したい場合には決済事業者に申し込みし上限値を調整していただく必要がございます。
     申し込み等詳細につきましては弊社までご連絡ください。
     申し込んだ値を使用する場合、
     「PayPayに申し込んだ値を適用する」のチェックボックスにチェックを入れて設定を保存してください。

     各種設定変更 > 各種決済設定変更 > PayPay > 与信有効期限日数

    キャンセルについて


     部分返金について

      部分返金については決済金額を超えない範囲で返金金額を指定できますが、
      決済事業者側の制限により原則1回のみ実施可能です。

      決済事業者側の設定にて複数回部分返金機能を有効化することは可能なため、ご利用の際には弊社にご連絡ください。
      なお、複数回部分返金をご利用の際には以下の点にご注意ください。
      • 返金の最大回数に達した場合、詳細結果コードとしてresultCode=UA-REQ-006およびvResultCode=1G24が返戻されます。(最大回数は、事業者側の制限になります。)
      • 部分返金を複数回行う場合、リクエスト間隔は1分以上開ける必要があります。
        リクエスト間隔が1分未満のリクエストはエラーとなり、詳細結果コードとしてresultCode=UA-PRV-001およびvResultCode=1G13が返戻されます。

    消費者における支払い/申込時間制限


    消費者が加盟店様サイトからPayPayサイトへ画面遷移してから手続き完了するまでには時間制限があります。
    時間制限を超えた場合、消費者による申込処理(都度決済の場合は支払い)が完了できません。
    このような場合には申込処理を最初からやり直していただくようご案内ください。

    決済種別 制限時間
    都度決済 5分
    随時決済 15分

    随時決済の解約単位について


    随時決済取引の解約は加盟店単位となります。
    決済サーバーの仕様上、申込取引に対して個別の解約処理となっておりますが、
    解約単位は加盟店単位となる為、解約要求を行った取引に紐づく消費者が利用しているすべての取引が解約されます。

    例えば、ある消費者が〇〇加盟店で随時決済取引A, B, Cを申し込んでいます。


    そのうちの【取引A】に対して解約処理を行った場合を以下に示します。


    解約処理後の各取引の承諾状態と抹消通知の有無は以下の通りです。

    取引 随時決済の承諾状態 抹消通知
    取引A 解約 -
    取引B 承諾 なし
    取引C 承諾 なし

    決済サーバーにおいて解約申込が行われなかった【取引B】【取引C】は承諾状態のままとなります。
    これらの取引に対して随時支払を行おうとすると、結果コードをresultCode=UA-PRV-002およびvResultCode=1G19(既に解約済みの取引のため、処理を中止しました。)を返戻します。

    次に消費者がPayPayアプリから〇〇加盟店との連携を解除した場合を以下に示します。
    消費者がPayPayアプリで可能な操作はこの「加盟店との連携解除」のみで、個別の申込取引に対する解約操作はできません。


    加盟店との連携解除後の承諾状態と抹消通知の有無は以下の通りです。

    取引 随時決済の承諾状態 抹消通知
    取引A 抹消 あり
    取引B 抹消 あり
    取引C 抹消 あり

    PayPayアプリから加盟店との連携解除が操作されると決済サーバーから抹消通知を送信します。
    通知は各取引に対して送信されます。加盟店様サイトでは抹消通知を受信し取引情報を更新してください。

    PayPayアプリへのプッシュ通知


    PayPay(オンライン決済)において、PayPayからPayPayアプリへのプッシュ通知内容とタイミングを以下に示します。
    プッシュ通知に表示される項目について

    No 項目名 説明
    1 金額 決済金額/返金金額。
    2 取引番号 PayPay社より払い出される番号。
    消費者がPayPay社に問い合わせする時などに利用します。
    弊社では以下項目で連携します。
    【都度決済】
    決済申込の結果通知、取引結果取得で「providerOrderId(決済固有取引ID)として連携します。
    【随時決済】
    随時支払のレスポンス。随時支払の結果通知、取引結果取得で「providerOrderId(決済固有取引ID)として連携します。
    3 店舗名 商品・サービスを提供するサイト名。契約時のエントリーシートに記載する「サービス名称」と同じ値です。
    4 申込期限 取引の申込有効期限。詳細は「申込有効期限について(都度決済)」を参照して下さい。
    申込のみの取引の場合のみ通知します。

    プッシュ通知タイミングと通知内容
    ※通知内容は、PayPayの仕様に従うため、変更となる可能性があります。
    通知タイミング 都度決済 随時決済 通知項目 説明
    決済申込完了時 - 金額/取引番号/店舗名/申込期限 購入内容の通知。
    申込のみの取引の場合、申込内容の通知。
    取消完了時 - 金額/取引番号/店舗名 申込のみの取引で、キャンセル処理を行った際の申込取消内容の通知。
    売上完了時 - 金額/取引番号/店舗名 申込のみの取引で、売上処理を行った際の売上確定内容の通知。
    随時支払完了時 - 金額/取引番号/店舗名 購入内容の通知。
    随時支払残高不足時 - - 残高不足の通知。
    消費者支払い要求の実施/未実施に関わらず、随時支払で残高不足が発生した場合に通知します。
    返金完了時 金額/取引番号 売上後の取引でキャンセル処理を行った場合の返金内容の通知。

    楽天ペイ

    レギュレーションについて


    導入には、楽天ペイメント株式会社が規定するレギュレーションを遵守していただく必要があります。
    楽天グループに関する名称、サービス名称や、ロゴ・ボタン等に関する表記審査をはじめ、ご利用のオプション機能用のレギュレーションがございます。
    詳細につきましては、楽天ペイメント株式会社にお問い合わせください。

    チャージバックについて


    チャージバック発生時の諸手続きは、楽天ペイメント株式会社より加盟店様へご連絡が行われ、手続きについてのご案内がございます。
    チャージバックの情報はFEPサーバには連携されないため、チャージバック対象の取引を楽天システム側でキャンセル処理が行われた場合、 FEPサーバおよび決済サーバで管理している当該取引の状態が売上済みのまま残るため、後続コマンドが実施できません。

    物品販売について


     在庫管理について

      在庫切れによるリスク回避のため決済申込を実施する時点で在庫確認を行うことを推奨します。
      また、その場合に決済申込の結果が失敗であった場合や結果の返却が一定時間ない場合には在庫をリリースするようお願いします。

     売上について

      物品販売の場合、商品を発送する前に売上を行うことが禁止されています。
      必ず、商品の発送後に売上を行うか、多少の前後は問題ございませんので、できる限り消費者への商品発送と同じタイミングで売上を行うようにしてください。

    決済申込時の注意事項


    決済後にサービス提供を行わない場合は、速やかにキャンセルを実施してください。決済申込後、取消可能期限を過ぎた場合、楽天ポイント/楽天キャッシュは返還されません。
    期間限定ポイントを使用していた場合、トラブルに発展する可能性があるため、各処理期限までに売上、またはキャンセルを実施してください。
    申込のまま既定の期限を超過し売上、またはキャンセルをともに行えなくなった場合、楽天ポイント/楽天キャッシュについては消費者へ直接返金してください。

    申込変更利用の注意事項


    以下の事項についてご確認のうえ、申込変更コマンドを利用ください。

    • 決済申込時に3Dセキュア認証を行っていた場合に、申込変更(与信延長/金額変更)を実施すると都度決済では 3Dセキュアが無効 になります。随時決済では利用承諾時に 3D セキュア認証を呼び出すことができますが、随時支払では 3Dセキュア対象外 となります。
      3Dセキュア認証が無効・対象外となると、万が一不正利用が発生した場合、加盟店様側のチャージバック負担になる可能性がありますので、ご注意ください。
    • 与信延長については、注文から30日を超える予約商材への利用を想定しています。
      楽天ペイ側では上記以外の利用は許容されていないため、ご注意ください。

    楽天ポイントを利用した決済について


    以下に、楽天ポイントを利用した決済についての注意点を示します。

    • 決済金額の変更時にはポイント利用額が変更される場合があります。
      金額の変更(部分売上、部分キャンセル)が発生した場合、クレジットカードの利用額を優先して減額が行われますが、ポイント・キャッシュ(以下、ポイント)充当設定額を下回った場合にはポイント利用額が減額されます。
      例えば、購入金額1,000円(うちポイント利用額900円)で申込が成立した取引について、部分売上で800円の売上を確定した場合は全額がポイント利用となるため、ポイント利用額は800円に変更されます。

    • ポイント利用額が変更となった場合に、ポイントが消費者へ返却されるタイミングは以下となります。
      キャンセル処理、または金額の変更(部分売上、部分キャンセル)により、注文金額がポイント充当設定額を下回った場合には、各処理が正常に完了した時点で消費者へポイントが返却されます。
      ただし、期間限定ポイントを利用している、かつ、キャンセル日が有効期限を経過していると失効となり返還されません。
      また、加盟店様側にて、売上およびキャンセルの要求可能期間(※1)内に売上処理、またはキャンセル処理が完了していない取引に関しましては、消費者の楽天ポイントは返却されず利用された状態のままとなります。
      加盟店様にて、与信の状態のまま、売上処理、またはキャンセル処理を行わずに要求可能期間切れとなりますと、楽天側にて自動でキャンセルされますが(この際、消費者へのキャンセルメールの送信はされません)、可能な限り加盟店様側で適宜売上またはキャンセル処理を行っていただくようお願いします。
      与信の時点で既に楽天ポイントが引き落とされているため、後続処理をお願いします。与信の時点で既に楽天ポイントが引き落とされているため、後続処理を行わずに放置してしまうと後のトラブルに繋がる可能性がございます。

      ※1:売上およびキャンセルの要求可能期間については、「処理要求可能期間について」をご参照ください。

    • 与信のみで決済申込処理を実施した際には、以下の点に注意してください。
      決済申込処理後にサービス提供を行わない場合は、速やかにキャンセル処理を実施してください。
      決済申込処理(与信のみ)後、キャンセル可能期限を過ぎた場合、ポイントは返還されません。
      期間限定ポイントを使用していた場合、トラブルに発展する可能性があるため、各処理期限までに売上処理またはキャンセル処理を実施してください。
      決済申込(与信のみ)のまま既定の期限を超過し、売上処理またはキャンセル処理をともに行えなくなった場合、ポイントについては消費者へ直接返金を実施してください。

    デビットカード利用について


    消費者がデビットカードを利用した注文に対して、申込変更や部分売上、部分キャンセル時にはその都度消費者の銀行口座より引き落とされる可能性があります。 その後通常自動で返金処理は行われますが、処理タイミングや方法はカード会社によって異なるためご注意ください。

    楽天から消費者に送信されるメールについて


    楽天ペイ(オンライン決済)において、楽天から消費者に送信されるメールの送信タイミングを以下に示します。

    送信タイミング メール内容
    決済完了時(都度決済) 注文確認メール
    申込完了時(随時決済) 申込確認メール
    注文取消時 キャンセル受付メール
    決済完了時(都度決済)
    (部分売上、部分取消、与信変更(金額変更))
    金額変更受付メール

    WebView等を利用したスマートフォンアプリへの実装に関する注意事項


    WebView等を利用したスマートフォンアプリへの実装についてはサポート対象外となっています。
    ※実際にご利用いただいている例もございますので、対応される場合は加盟店様にて十分にテストを実施し、
     問題ないことを確認してください。なおテストについては必ずLive環境で実施するようにしてください。
     また、加盟店様アプリから決済事業者にコントロールが移ったあと、再度加盟店様アプリに戻ってくるかどうか、
     ブラウザやWebView内での画面遷移を想定していたが事業者のアプリが起動する(もしくは逆)といった動作はSandbox環境での確認は難しく、
     事業者側の変更(基本的には事前の案内はいただけません)により変わってしまう可能性がございますのでこの点はご認識ください。

    ドコモ/au共通

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

    • ドコモ
    • au

    機種依存文字について


    決済サーバに送信する電文の文字エンコーディングはUTF-8ですが、キャリア側のインターフェースではShift-JISが利用されます。
    したがって、一部のShift-JIS(MS932含む)などの機種依存文字は利用できません。
    利用できない文字を設定した場合は、消費者の画面での文字化けや、キャリア側での決済処理が失敗する場合がありますので、決済サーバでは、以下の検証により許可する全角文字列の判定を行っています。

    • UTF-8からShift-JISに変換後、再度UTF-8に変換した文字が、元の文字と同一であること。

    この判定によって、以下のような文字を含む場合は当該文字を□に変換した上で処理を行いますので、ご注意ください。
    利用できない文字 対処方法
    "―" 全角ダッシュ 利用可能な以下の文字で代用する等をご検討ください。
    "‐" 全角ハイフン
    "ー" 全角長音
    "-" 全角マイナス
    "~" 全角波形
    その他の機種依存文字 利用可能な文字での代用をご検討ください。

    au

    auの与信がKDDI側で取り消される問題について


    auPAY(auかんたん決済)、auPAY(ネット支払い)では、売上要求時点で消費者の契約状態に変更があった場合(※)には、与信有効期限内であっても売上確定に失敗する場合があります。
    この場合、決済サーバは結果コードをresultCode=UA-CST-001およびvResultCode=WG13という値で返戻します。
    この取引については、KDDI側で与信自体が取消となり、該当の取引に対しては売上を立てることができませんので、消費者にご連絡のうえ、注文の取消や代替手段での請求をご検討ください。
    また、この問題によるトラブルを防ぐためには、必ず売上が成功後に商品の発送やサービスの提供を行う運用をご検討ください。
    なお、d払いにはこのような仕様はございません。与信が成立した取引については、与信有効期限内であれば売上は成功します。

    ※消費者の契約状態は、料金未払いによるものや回線解約等がございますが、KDDIから詳細な情報は開示されません。

    au随時申込リクエスト項目nameの書式設定について


    auPAY(auかんたん決済)、auPAY(ネット支払い)ウェブ方式の随時決済を利用する場合、随時決済リクエスト項目nameについては決済事業者仕様に従って情報を設定してください。

    書式・制限 全角、最大24文字
    auPAY(auかんたん決済)
    商品名(サービス名)+課金タイミング 例)旬の果物5000円分お届け■3か月毎に1日に課金
    ※必ず、■(全角スペース)を入れてください。
    auPAY(ネット支払い)ウェブ方式
    商品名(サービス名)+お客様問合せ対応時に必要となる商品コード 例)○○サービス利用料■商品コード:****
    ※■(全角スペース)の有無は任意。

    auPAY(auかんたん決済)について


    利用限度額について

    ■ID連携 および au IDログイン

    利用限度額はKDDIのサイトにて確認できます。
    https://kantan.auone.jp/service/communicationfee/#Section02

    以下、サイトより引用します(2024年7月現在)。

    ■au PAY(ネット支払い)

    利用限度額はKDDIのサイトにて確認できます。
    https://aupay.wallet.auone.jp/?link=faq

    以下、サイトより引用します(2024年7月現在)。

    コンテンツ等の提供に関するガイドライン

    KDDI株式会社及び沖縄セルラー電話株式会社が auPAY(auかんたん決済)の円滑な運用を図るために制定している コンテンツ等の提供に関するガイドラインがありますので、以下の点について事前にご確認ください。
    ※以下の点について遵守いただけない場合、auPAY(auかんたん決済)が利用できなくなる可能性があります。

    加盟店様サイトにおける表示内容など

    1. 店舗様サイトにて、お問い合わせ先(電話番号、E-Mail等)はユーザのわかりやすい場所に記載されているか。
    2. KDDI が提供しているサービス説明用ページへのリンクが設置されてるか。
      【PC】https://id.auone.jp/payment/pc/guide/index.html
      【スマートフォン】https://id.auone.jp/payment/sp/guide/index.html
    3. 継続課金を導入している場合、サイト上に会員解約/退会方法に関するコンテンツが用意されているか。
      また、退会へのリンクが設置されているか。
    4. Androidアプリからの解約、または解約ページへのリンクを設置する場合には、その遷移について提示しているか。
    5. Androidアプリを削除した場合においても、退会への導線が用意されているか。
    6. ※4, 5についてはAndroidアプリから利用する場合
    7. 契約契機の前に、サイト上またはアプリ上で請求情報(価格、課金間隔、課金日等)が表示されるか。
      【都度決済の例】
        購入一回あたり ・・・ ○○円

    メルペイ

    決済金額について


    ユーザの決済可能な金額は、お支払用口座およびメルカリアプリの本人確認登録状態などにより異なります。
    詳細はメルペイアプリのガイドをご確認ください。

    消費者における支払い/申込時間制限


    決済申込応答受領後「20分以内」に、消費者をメルペイの決済画面に遷移させて支払い手続きを完了させる必要があります。
    時間制限を超えた場合、消費者による支払い手続きは完了できませんので、決済申込処理を最初からやり直していただくようご案内ください。

    スマートフォン決済におけるメルカリアプリ起動についての注意事項


     【スマートフォンブラウザ】決済処理開始時と完了時でのブラウザの違いによる問題

      消費者様がスマートフォンブラウザからECサイトを利用する場合、決済処理でメルカリアプリを経由することで、処理開始と完了時でのブラウザが異なる可能性があります。
      現在のメルペイの仕様上、Chromeで処理を開始した場合に限り、申込時にuserAgentを指定すれば完了時にもChromeに戻すことができますが、Chrome以外のブラウザの場合は、完了時に異なるブラウザに戻る可能性があります。
      問題の詳細については以下のメルペイ仕様書の内容をご参照ください。


      このような問題に対しても弊社決済サーバーからブラウザを経由して連携する決済結果を受け取り、正常に処理できるように実装してください。

     【スマートフォンアプリ(加盟店アプリ)】メルカリアプリ起動について

      スマートフォンアプリ(以後、加盟店アプリと呼びます)を起点とした決済でメルカリアプリを起動するためには、各OS(iOS, Android)が提供するAPIを利用してredirectUrlを開いてください。
      redirectUrlは、iOSの Universal Links、Androidの App Links として登録されています。
      各OSの実装方法に応じた注意点がメルペイ仕様書に説明されていますので、内容をご参照ください。


    個人情報(配送先情報・購入者情報)の要求について


    メルペイより個人情報の提供を受けることができます。
    取得できる個人情報は申込時の審査で承認された項目のみとなります。
    また、加盟店様が個人情報を受け取るには、ユーザがメルカリアプリで個人情報を提供することに同意する必要があり、
    個人情報の提供の同意が行われない場合は、メルカリアプリよりキャンセル処理が行われ、決済申込時リクエスト項目で指定されたcancelUrlへリダイレクトされます。

    ※個人情報は決済申込の結果通知電文でのみ通知いたします。
    結果通知受信に失敗した場合は、個人情報を取得できませんので、ご注意ください。
    (結果通知電文は開発ガイドIF仕様書のAPIs配下「Webhook」を参照)


     配送先情報

      配送先情報タイプ(deliveryAddressType)を設定することにより、決済処理時にメルペイより配送先情報の提供を受けることができます。これによってユーザはシームレスに商品の注文を行うことができます。

     購入者情報

      購入者情報タイプ(buyerInfoType)を設定することにより、決済処理時にメルペイより購入者情報の提供を受けることができます。

    商品カテゴリID一覧


    カテゴリIDへ入力する一覧となります。
    カテゴリIDは決済手段のメルペイスマート払いを利用するために必要な情報となる為、適切に設定してください。
    金融庁のガイドラインでは、メルペイスマート払いを利用する場合は、その商品がどういった商品カテゴリ(衣類、コスメ、食品等々)であるかを、明示することを求めています。
    なお、メルペイスマート払いは消費者が選択可能な決済手段で、利用不可とすることはできません。

    カテゴリ名 カテゴリID
    大カテゴリ 中カテゴリ
    ファッション 衣類 1010
    アクセサリー/腕時計 1011
    バッグ・小物・ブランド雑貨 1012
    家電 生活家電 1110
    スマホ・携帯電話 1111
    PC・タブレット 1112
    テレビ・映像機器 1113
    周辺機器 1114
    美容 コスメ 1210
    医療品/健康食品 1211
    エンタメ テレビゲーム 1310
    ホビー 1311
    楽器・音楽機材 1312
    エンタメ用品 1313
    グルメ 食品 1410
    1411
    住まい/暮らし ソファ/ベッド 1510
    家具 1511
    日用品 1512
    スポーツ用品/アウトドア 1513
    ベビー用品 1514
    1515
    オートパーツ 1610
    その他 優待券/割引券/施設利用券 1710
    金券 1711
    デジタルコンテンツ 1712
    寄付/納税 1713
    その他 1714

    改訂履歴

    バージョン リリース年月 更新内容
    1.0.0 RC 2024/08
    1. インターフェース仕様書から補足情報を本ドキュメントに分離
    2. 以下の項目を追加
      • 全決済タイプ共通事項
        • データの保持期限について
        • 二重取引について
        • 売上について
        • キャンセルについて
      • 楽天ペイ
        • 楽天ポイントを利用した決済について
    1.1.0 RC 2025/06
    1. ドコモ、auおよびメルペイ追加に伴い、以下に関連の記載を追加
      • 全決済タイプ共通事項
        • 処理要求可能期間について
      • ドコモ/au共通
      • au
      • メルペイ
    2. 詳細結果コードの記載をresultCodeおよびvResultCodeどちらも併記するよう修正
    1.1.1 RC 2025/09
    1. 以下の項目を追加記載および修正
      • 全決済タイプ共通事項
        • 「スマートフォンを利用した決済の注意事項」を追加
      • PayPay
        • 「消費者における支払い/申込時間制限」を追加
        • 「随時決済の解約単位について」を追加
        • 「PayPayアプリへのプッシュ通知」を追加
        • 「決済金額について」の残高支払い時の上限金額を修正
      • 楽天ペイ
        • 「決済申込時の注意事項」を追加
        • 「申込変更利用の注意事項」を追加
        • 「デビットカード利用について」を追加
        • 「楽天から消費者に送信されるメールについて」を追加
        • 社名表記を「楽天グループ株式会社」から「楽天ペイメント株式会社」に変更
      • au
        • auかんたん決済のサービス名称をauPAY(auかんたん決済)に変更