openapi: 3.1.0
info:
  title: PGマルチペイメントサービス OpenAPIタイプ
  version: 1.13.0
  description: |
    <div class="announcement-banner">
      <h3>【予告】Webドキュメントリニューアルのお知らせ</h3>
      <p>2026年3月末に、新しいWebドキュメントサイトを公開予定です。<br />
      新サイトはインターネット上で公開します（Basic認証は不要です）。<br />
      また、以下の3サイトを1つのサイトに統合します。</p>
      <ul>
        <li><a href="https://docs.mul-pay.jp">マルペイDocs</a></li>
        <li>OpenAPIタイプドキュメント（本サイト）</li>
        <li><a href="/docs/payment-method/credit/card/tokenization">トークン決済v2開発ガイド</a></li>
      </ul>
      <p>新サイトは、現行サイトとはURLが異なります。</p>
      <h4>新サイトの主な特長</h4>
      <ul>
        <li><strong>Ask AI機能</strong><br />
        自然な文章で質問するだけで、AIがドキュメントの内容を元に回答し、必要な情報に素早くたどり着けます。</li>
        <li><strong>Try it now機能</strong><br />
        テスト環境へのAPIリクエストをブラウザ上でそのまま試すことができます。<br />
        お試しになったリクエストはサンプルコードとして利用でき、動作確認や仕様の把握をスムーズに行えます。<br />
        利用にはテスト環境のショップID・ショップパスワードが必要です。</li>
        <li><strong>高精度・高速な検索機能</strong><br />
        キーワードやエラーコードから、関連する情報を迅速かつ的確に検索できます。</li>
      </ul>
      <h4>新サイト公開後の各サイトの取り扱いについて</h4>
      <h5><a href="https://docs.mul-pay.jp">マルペイDocs</a></h5>
      <ul>
        <li>最低半年間は公開を継続します。</li>
        <li>ただし、内容の更新は行いません。</li>
        <li>最新の仕様は新しいWebドキュメントをご参照ください。</li>
      </ul>
      <h5>OpenAPIタイプドキュメント（本サイト）</h5>
      <ul>
        <li>新サイト公開と同時に公開を終了します。</li>
        <li>既存のURLへアクセスした場合は、新サイトへリダイレクトされます。</li>
      </ul>
      <h5><a href="/docs/payment-method/credit/card/tokenization">カード情報トークン化</a></h5>
      <ul>
        <li>新サイト公開と同時に公開を終了します。</li>
        <li>既存のURLへアクセスした場合は、新サイトへリダイレクトされます。</li>
      </ul>
    </div>
  x-logo:
    url: https://static.mul-pay.jp/k01/mulpayconsole/bundles/gmopggpconsole/images/logo_on.png
    altText: GMO-PG logo
servers:
  - url: https://stg.openapi.mul-pay.jp
    description: PGマルチペイメントサービス OpenAPIタイプ テスト環境
  - url: https://openapi.mul-pay.jp
    description: PGマルチペイメントサービス OpenAPIタイプ 本番環境
security:
  - Password: []
  - AccessToken:
      - openapi
tags:
  - name: intro
    x-displayName: はじめに(OpenAPIタイプ)
    description: |
      OpenAPIタイプのAPIリファレンスです。  
      こちらでは、OpenAPIタイプのAPIの仕様について記載してます。  
      API共通の仕様・制約事項については[OpenAPIタイプ 概要](/mulpay/docs/connection-method/openapi-type/overview)を確認ください。   
      <br />
      <a href="/mulpay/openapi-spec/openapi-type.yml" download>OpenAPI Spec（YAML）をダウンロード</a>

  - name: migration
    x-displayName: プロトコルタイプ/モジュールタイプからの移行
    description: |
      プロトコルタイプ/モジュールタイプは引き続き利用いただけますが、より便利なOpenAPIタイプに移行することを推奨します。  
      前述の通り、OpenAPIタイプと従来の接続方式には互換性があり併用が可能です。  
      例えば取引の確定をするスケジュール処理を先⾏して実装するといった柔軟な移⾏が可能です。  
      詳細な情報については、[プロトコルタイプ対応表](#tag/correspondence)を参照ください。  

      プロトコルタイプ/モジュールタイプとOpenAPIタイプで共通して取り扱うデータについて説明します。  
      |データ|説明|
      | :--- | :--- |
      |ショップID|共通して利用でき、変更の必要はありません。<br />テスト環境のショップIDも同様です。|
      |ショップパスワード|共通して利用でき、変更の必要はありません。<br />管理画面からパスワードを変更した場合、両方に反映されます。|
      |サイトID|OpenAPIタイプでは利用しません。<br />ショップIDの設定により、紐づくサイトIDが自動で利用されます。<br />カード登録時の処理料ご請求先は、これまで通り請求先ショップです。|
      |サイトパスワード|OpenAPIタイプでは利用しません。|
      |取引ID|共通の仕様で発行され、両方で利用できます。|
      |取引パスワード|OpenAPIタイプでは利用しません。<br />元の取引を指定する場合は取引IDのみで行います。|
      |取引ステータス|共通して利用できます。|
      |オーダーID|共通して利用できます。|
      |会員ID|共通して利用できます。|
      |登録済みカード|共通して利用できます。ただし、OpenAPIタイプでは削除済み状態のカードで支払いできません。|
      |カード登録連番モード|OpenAPIタイプでは利用しません。<br />従来の「物理モード」が標準ですが、「論理モード」もサポートします。|
      |カード登録連番|OpenAPIタイプでは従来の「物理登録連番」を「カードID」と表します。<br />「論理登録連番」は「カードインデックス」として扱います。|

      従来のプロトコルタイプ/モジュールタイプとOpenAPIタイプには、一部の仕様に差異があります。  
      移行においては、特に以下の点にご注意ください。  
      - OpenAPIタイプでは、一部の決済手段を除いて従来の「結果通知」はサポートしていません。  
        タイムアウトなどでレスポンスが返らない場合は、同一の冪等キーを設定してリトライをお願いします。  
        詳細については[結果通知（Webhook）](/mulpay/docs/developer-support/notification/overview)、従来の[結果通知 概要（マルペイDocs）](https://docs.mul-pay.jp/notified/overview)<sup>※</sup>を参照ください。  
        <small>※マルペイDocsの利用方法は[こちら](https://mp-faq.gmo-pg.com/s/article/F00579)</small>  
      - モバイルEdy決済、モバイルSuica決済など、[支払い処理](#tag/payment)に記載のない決済手段は現時点で提供の予定はありません。
      - 金額と税送料は統合しました。税送料は個別に設定できません。
      - 個別の加盟店様向けの特殊機能やオプションパラメーターは利用できません。
      - プロトコルタイプ/モジュールタイプで取引登録を行った取引に対してOpenAPIタイプで処理を行った場合、従来の「結果通知」仕様に則り通知がされます。  
      - プロトコルタイプ/モジュールタイプのカード登録/更新(SaveCard)では、物理モードで登録連番を指定せずに登録済みのカード番号を指定した場合、同一のカード番号を「新規登録」ではなく「更新」として処理しますが、OpenAPIタイプでは「新規登録」として扱います。  
      - 登録済みカード情報のデフォルトフラグを付け替える機能は提供していません。

      <br />
  - name: connected
  - name: idempotence
    x-displayName: 冪等処理
    description: |
      冪等性(べきとうせい)とは、同じ操作を何度繰り返しても、同じ結果が得られるという性質です。  
      OpenAPIタイプの対象APIは冪等性をサポートしており、安全にリトライが可能です。  


      <div >
      1回目のリクエストが<span >成功</span>した場合の処理シーケンス
      </div>

      ```mermaid
      %%{
       init: {
        'theme': 'base',
        'themeVariables': {
          'primaryColor': '#f0f2f5',
          'primaryTextColor': '#001C40',
          'noteBkgColor': '#d9f4fc',
          'noteTextColor': '#001C40',
          'noteBorderColor': '#54C5E8'
        }
       }
      }%%
      sequenceDiagram
      participant mer as 加盟店様
      participant psp as 当サービス
      mer ->>+ psp: リクエスト　冪等キー'AAA'
      Note right of psp: 処理成功
      psp--xmer: レスポンス 'OK'
      Note left of mer: 通信エラー等により<br />レスポンスの受け取りに失敗
      mer ->>+ psp: リクエストのリトライ　冪等キー'AAA'
      Note right of psp: 再処理はせずに1回目と同じ<br />レスポンスを返却
      psp-->>mer: レスポンス 'OK'
      ```

      1回目のリクエストが失敗していた場合は、同じ冪等キーでのリトライは冪等にならず再処理されます。  
      1回目の[HTTPステータスコード](#tag/httpstatuscode)が<span class="mp-oas-code">409</span>、<span class="mp-oas-code">429</span>、<span class="mp-oas-code">500</span>、<span class="mp-oas-code">502</span>エラーであれば、再処理の結果、成功することがあります。  
      上記以外のエラーは、リトライをしても1回目と同じエラーになる可能性が高いです。  

      <div >
      1回目のリクエストが<span >失敗</span>した場合の処理シーケンス
      </div>

      ```mermaid
      %%{
       init: {
        'theme': 'base',
        'themeVariables': {
          'primaryColor': '#f0f2f5',
          'primaryTextColor': '#001C40',
          'noteBkgColor': '#d9f4fc',
          'noteTextColor': '#001C40',
          'noteBorderColor': '#54C5E8'
        }
       }
      }%%
      sequenceDiagram
      participant mer as 加盟店様
      participant psp as 当サービス
      mer ->>+ psp: リクエスト　冪等キー'BBB'
      Note right of psp: 処理失敗
      psp--xmer: レスポンス 'ERROR'
      Note left of mer: 通信エラー等により<br />レスポンスの受け取りに失敗
      mer ->>+ psp: リクエストのリトライ　冪等キー'BBB'
      Note right of psp: 1回目が失敗しているため再処理
      psp-->>mer: レスポンス 'OK'<br />※必ず成功するわけではありません
      ```

      <br />

      ### 冪等性をサポートするAPI  
      主に更新処理を伴うAPIが冪等性をサポートします。  
      対象となるAPIは、詳細仕様の<span class="mp-oas-code">HEADER PARAMETERS</span>に、<span class="mp-oas-code">Idempotency-Key</span>が定義されています。  

      <br />

      ### 利用方法
      冪等にするためには、[リクエストのHTTPヘッダー](#tag/header)に冪等キーを設定します。  
      冪等キーには、リクエスト毎にユニークな最大36桁の任意の文字列を割り当ててください。  
      ランダムにユニークな値を生成するUUID v4の利用を推奨します。  
      以下はHTTPリクエストヘッダーの設定例です。  
      ```html
      Idempotency-Key: ede66c43-9b9d-4222-93ed-5f11c96e08e2
      ```

      <br />

      ### 有効範囲
      リクエストの開始から24時間以内は冪等性が有効です。  
      有効期限が切れた冪等キーは、新規のリクエストとして扱われます。  

      <br />
  - name: callback
    x-displayName: リダイレクトとコールバック
    description: |
      ### リダイレクト
      3Dセキュア認証処理やPay払いは、外部のサイトにリダイレクトします。  
      OpenAPIタイプでは全てのリダイレクト処理をHTTPメソッド<span class="mp-oas-code">GET</span>で実現します。  
      当サービスから返る遷移先URLにリダイレクトする処理のサンプルです。  

      HTTPヘッダーを使って302リダイレクト

      ```html
      HTTP/1.1 302 Found
      Location: {redirectUrl}
      ```

      <br />
      meta refreshでリダイレクト

      ```html
      <html>
        <head>
          <meta http-equiv="refresh" content="0; URL={redirectUrl}" />
        </head>
      </html>
      ```

      <br />

      ### コールバック
      リダイレクト後は、お客様と遷移先のサイトの間で処理が行われます。  
      処理が終わると取引リクエスト時に設定した加盟店様のコールバックURL<span class="mp-oas-code">callbackUrl</span>に遷移します。  
      加盟店様のシステムで処理の結果を受け取れるようコールバックのエンドポイントをご用意ください。  
      お客様がブラウザを閉じるなど処理を中断した場合、コールバックはしません。  
      コールバックの呼び出し時のHTTPメソッドは<span class="mp-oas-code">GET</span>です。  
      元の取引を特定するために、以下のパラメーターを送信します。  
      パラーメーターはJSON形式の文字列をBase64*URL*エンコードし、コールバックURLのクエリパラメーター<span class="mp-oas-code">p</span>に設定します。  
      Base64URLデコードしてご利用ください。  

      |パラメーター|説明|
      | :--- | :--- |
      |accessId|取引リクエスト時に返る取引ID|
      |event|このコールバックのイベントタイプ<br /><span class="mp-oas-code">TDS_CHARGE_FINISHED</span><br /><small>3Dセキュアの支払いにてautoAuthorization=trueの場合に返ります。取引照会にて状態を確認し決済成否を判断してください。</small><br /><span class="mp-oas-code">TDS_VERIFICATION_FINISHED</span><br /><small>3Dセキュアの有効性確認にてautoAuthorization=trueの場合に返ります。取引照会にて状態を確認し決済成否を判断してください。</small><br /><span class="mp-oas-code">TDS_FINISHED</span><br /><small>3Dセキュアの支払い・有効性確認にてautoAuthorization=falseの場合に返ります。3Dセキュア後の支払い・有効性確認を実施してください</small><br /><span class="mp-oas-code">WALLET_CHARGE_FINISHED</span><br /><small>Pay払いの都度支払いにて返ります。取引照会にて状態を確認し決済成否を判断してください。</small><br /><span class="mp-oas-code">WALLET_APPROVAL_FINISHED</span><br /><small>Pay払いの利用承諾にて返ります。取引照会にて状態を確認し決済成否を判断してください。</small><br /><span class="mp-oas-code">VERIFICATION_FINISHED</span><br /><small>本人確認の認証開始にて返ります。照会にて状態を確認し認証成否を判断してください。</small>||
      |csrfToken|取引リクエスト時に加盟店様が設定した任意の値<br /><small>※加盟店様システムにてコールバック受け取り後にCSRF対策として<br />正当性を確認することを想定しています。文字数は最大36桁です。</small>|

      例を以下に示します。

      取引リクエスト時に加盟店様が設定したコールバックURL

      ```html
      https://merchant.example.com/callback
      ```

      コールバック時に当サービスにてBase64URLエンコードした値をクエリパラメーターに追加

      ```html
      https://merchant.example.com/callback?p=eyJhY2Nlc3NJZCI6ImFjZGM3ZDUzZjdhNzhmNDg4ZDhkMDk5N2VmZjk5YzZmIiwiZXZlbnQiOiJURFNfQ0hBUkdFX0ZJTklTSEVEIiwiY3NyZlRva2VuIjoiYmRiMDRjNWYtNDJmMC0yOWUyLTA5NzktZWRhZTNlNzc2MGJmIn0=
      ```

      上記<span class="mp-oas-code">p</span>パラメーターの値をBase64URLデコードした結果

      ```javascript
      {
        "accessId":"acdc7d53f7a78f488d8d0997eff99c6f",
        "event":"TDS_CHARGE_FINISHED",
        "csrfToken":"bdb04c5f-42f0-29e2-0979-edae3e7760bf"
      }
      ```

      <br />
  - name: webhook
    x-displayName: Webhook通知
    description: |
      処理された取引の結果を非同期で加盟店様に通知する機能です。  
      リクエスト時に設定した加盟店様のWebhook URL<span class="mp-oas-code">webhookUrl</span>にHTTPで送信されます。  
      加盟店様のシステムで通知を受け取れるようWebhookエンドポイントをご用意ください。  
      <br />

      ### 通知の対象
      通知対象の処理は以下です。  
      通常は数秒から2時間程度以内に通知します。  
      通知内容は各リンク先を参照ください。  
      - [現金払いの支払い完了](#tag/events/operation/cashWebhook)
      - [支払い完了済みのAmazon Pay V2をキャンセルした結果](#tag/events/operation/amazonPayCancelWebhook)  
      - [Pay払いの決済結果通知](#tag/events/operation/walletChargeWebhook) 
      - [Pay払いの利用承諾結果通知](#tag/events/operation/walletAcceptWebhook) 
      - [都度支払い（フロントエンド方式）の決済結果通知](#tag/events/operation/walletFrontendWebhook)  
      - [アトカラ与信結果通知](#tag/events/operation/atokaraWebhook)  

      <br />

      ### 通知APIの仕様
      Webhook通知APIの接続仕様です。  
      |項目|仕様|
      |:---|:---|
      |HTTPメソッド|<span class="mp-oas-code">POST</span>|
      |HTTPリクエストヘッダーの<br /><span class="mp-oas-code">Content-Type</span>|<span class="mp-oas-code">application/json</span>|
      |リクエストボディー|JSON形式|

      以下のIPアドレスから送信されます。  
      加盟店様システムにて接続制限をしている場合は、許可設定をお願いします。  
      |環境|送信元IPアドレス|
      |:---|:---|
      |テスト環境|210.197.108.196|
      |本番環境|210.175.7.20|

      受信する加盟店様システムのSSLサーバー証明書によっては通信エラーになる可能性があります。  
      動作確認済みのSSLサーバー証明書は[結果通知 SSL証明書（マルペイDocs）](https://docs.mul-pay.jp/notified/ssl)<sup>※</sup>を参照ください。  
      <small>※マルペイDocsの利用方法は[こちら](https://mp-faq.gmo-pg.com/s/article/F00579)</small>  
      <br />

      ### 通知への応答
      Webhookを受信して正常に処理をした後は、HTTPステータス200番台を返してください。  
      レスポンスのボディは不要です。  
      200番台以外が返る場合は通知失敗と扱われ、リトライの対象になります。  
      リトライは一定間隔で正常応答をするまで最大5回送信されます。  
      間隔の初期設定は60分で、後述のとおり変更できます。  
      <br />

      ### 通知の設定
      Webhookの通知を受けるためには、APIリクエスト時に加盟店様のWebhook URLをパラメーター<span class="mp-oas-code">merchant.webhookUrl</span>に設定します。  
      従来の「結果通知」とは異なり、事前にショップ管理画面から有効化する必要はありません。  

      ショップ管理画面にて以下の設定を変更可能です。  
      - リトライ間隔: デフォルト60分である通知失敗時のリトライ間隔を変更
      - 結果通知停止時間: 加盟店様システムのメンテナンスにより結果通知を受け取れない時間帯を設定し、終了時刻後にまとめて通知

      変更の方法は[結果通知 管理画面操作マニュアル（マルペイDocs）](https://docs.mul-pay.jp/notified/console)<sup>※</sup>を参照ください。  
      <small>※マルペイDocsの利用方法は[こちら](https://mp-faq.gmo-pg.com/s/article/F00579)</small>  
      「基本設定」、「SNI設定」など、上記以外の設定はOpenAPIタイプのWebhookには適用されません。  
      <br />
  - name: fqdn
    x-displayName: 環境とFQDN
    description: |
      テスト環境と本番環境を用意しています。  
      各環境はFQDN(絶対ドメイン名)で区別され、取引のデータは共用されません。  
      テスト環境での確認を終えて商用利用を開始する際は、以下の2点を切り替えます。

      - HTTPヘッダーの「認証情報」を本番アカウントのものに更新
      - 接続先のAPIエンドポイントのFQDNを以下のものに更新

      |環境|目的|FQDN|
      | :--- | :--- | :--- |
      |テスト環境|APIの接続を確認する|stg.openapi.mul-pay.jp|
      |本番環境|商用の取引を実行する|openapi.mul-pay.jp|

      <br />
  - name: versioning
    x-displayName: バージョン管理
    description: |
      OpenAPIタイプのAPI仕様は順次アップグレードされ機能が追加されていきますが、加盟店様の稼働中システムに影響を与える破壊的変更は原則行いません。  
      それでも破壊的変更を伴うアップグレード時は、数ヵ月前に加盟店様にご連絡いたします。  
      以下は破壊的変更ではなく、後方互換があるものとして扱われます。
      - エンドポイントの追加
      - Webhook通知、コールバック時イベント<span class="mp-oas-code">event</span>の追加 (加盟店様側で新たなイベントを受け取れるための開発は必要です)
      - 設定任意リクエストパラメーターの追加
      - レスポンスパラメーターの追加
      - 設定任意リクエストHTTPヘッダー項目の追加
      - レスポンスHTTPヘッダー項目の追加
      - リクエストパラメーターに設定する文字列長・文字種・パターンの追加
      - 設定必須リクエストパラメーターを任意へ変更

      OpenAPIタイプのAPIリファレンス(OASファイル)とAPI仕様それぞれにバージョンがあります。  
      変更の内容は[変更履歴](#tag/changelog)を参照ください。  

      |種類|形式|表記の例|
      | :--- | :--- | :--- |
      |APIリファレンス<br />(OASファイル)<br />バージョン|[セマンティック・バージョニング](https://ja.wikipedia.org/wiki/セマンティックバージョニング)形式<br />|<span class="mp-oas-code">1.0.1</span>|
      |APIバージョン|YYYY-MM(年月)形式|<span class="mp-oas-code">2023-06</span>|

      <br />

      ### APIリファレンス(OASファイル)バージョン
      OpenAPIタイプのAPIリファレンス、およびダウンロード可能なOpenAPI specification(OAS)ファイルのバージョンです。  
      以下の基準で各バージョンが上がります。  

      |バージョン|基準|
      | :--- | :--- |
      |メジャー (1番目の数字)|後方互換がない破壊的変更|
      |マイナー (2番目の数字)|仕様追加や変更・削除|
      |パッチ (3番目の数字)|軽微な仕様変更や説明の追加・修正|

      <br />

      ### APIバージョン
      当サービスのAPI仕様のバージョン番号です。  
      後方互換がない破壊的変更を伴うリリース時の年月を新規に割りあてます。  
      [HTTPヘッダーのAPIバージョン](#tag/header)を設定することで破壊的変更前の仕様を保証します。  
      該当しないバージョン番号(年月)が設定されている場合、それより過去で最も近い年月のバージョンで動作します。  
      APIバージョンは頻繁に上がりませんが、将来の破壊的変更に備えて予めHTTPヘッダーにバージョン番号または加盟店様システム構築時の年月を設定してください。  
      <br />
      例)  
      APIバージョンが<span class="mp-oas-code">2023-06</span>から<span class="mp-oas-code">2024-06</span>にアップグレード  
      HTTPヘッダーのAPIバージョンに<span class="mp-oas-code">2023-10</span>が設定されている場合は<span class="mp-oas-code">2023-06</span>バージョンで動作  
      ただし、<span class="mp-oas-code">2023-13</span>のように日付の様式が正しくない場合は最新バージョンで動作  

      <br />
  - name: httpstatuscode
    x-displayName: HTTPステータスコード
    description: |
      HTTPステータスコードは、APIリクエストに対する処理結果を表す3桁の数字です。  
      OpenAPIタイプでは、[RFC 7231, section 6](https://www.rfc-editor.org/rfc/rfc7231#section-6)の仕様に従って、以下の3つのカテゴリのHTTPステータスコードが返ります。  
        - <span class="mp-oas-code">2xx</span>はリクエストが正常に受け付けられ、当サービスで処理されたことを表します。
        - <span class="mp-oas-code">4xx</span>は接続方法やパラメーターが正しくないなどのリクエストに誤りがあることを表します。  
        お客様のアカウント状態や残高に問題があり、支払いが完了できない場合のエラーも含まれます。  
        - <span class="mp-oas-code">5xx</span>は、当サービスまたは当サービスから先のネットワーク事業者、決済事業者に問題が発生していることを表します。  

      APIごとに発生するHTTPステータスコードについては、各API仕様の<span class="mp-oas-code">Responses</span>を確認してください。  
      ただし、以下表の「種別」が「認証エラー」、「アクセスエラー」、「サービス利用不可」は、APIを受け付ける前のエラーであり、全てのAPIで発生する可能性があります。  
      |HTTP<br />ステータス<br />コード|種別|説明|
      |:---|:---|:---|
      |<span class="mp-oas-code">200</span>|成功|照会系のリクエストは正常に処理されました。|
      |<span class="mp-oas-code">201</span>|成功|更新系のリクエストは正常に処理されました。|
      |<span class="mp-oas-code">202</span>|成功|更新系のリクエストが受け付けられ、完了のためには後続の処理が必要です。|
      |<span class="mp-oas-code">400</span>|リクエストパラメーターエラー|パラメーターの内容が正しくない、または状態が不正なため、リクエストは処理できません。|
      |<span class="mp-oas-code">401</span>|認証エラー|[APIの認証](/mulpay/docs/connection-method/openapi-type/auth-security)情報が正しくないため、リクエストは受け付けられません。|
      |<span class="mp-oas-code">402</span>|リクエストエラー|外部事業者にて支払い・承認・確定・取消リクエストが拒否されました。|
      |<span class="mp-oas-code">404</span>|アクセスエラー|APIエンドポイントが無効であるため、リクエストは受け付けられません。|
      |<span class="mp-oas-code">405</span>|アクセスエラー|HTTPメソッドが正しくないため、リクエストは受け付けられません。<br />リダイレクト時は<span class="mp-oas-code">GET</span>、それ以外は<span class="mp-oas-code">POST</span>です。|
      |<span class="mp-oas-code">409</span>|二重リクエスト|二重リクエストのため、リクエストは受け付けられません。|
      |<span class="mp-oas-code">415</span>|アクセスエラー|<span class="mp-oas-code">Content-Type</span>ヘッダーが正しくないため、リクエストは受け付けられません。|
      |<span class="mp-oas-code">429</span>|アクセスエラー|同時処理数が規定値を超えているため、リクエストは受け付けられません。|
      |<span class="mp-oas-code">500</span>|当サービス内部のシステムエラー|当サービスのサーバーで問題が発生したため、リクエストを処理できませんでした。|
      |<span class="mp-oas-code">502</span>|外部事業者のシステムエラー|外部事業者やネットワークで問題が発生したため、リクエストを処理できませんでした。|
      |<span class="mp-oas-code">503</span>|サービス利用不可|当サービスがメンテナンス中のため、リクエストは受け付けられません。<br />このコードが返るメンテナンス情報は、6ヶ月前に加盟店様に通知します。|

      <br />
  - name: errors
    x-displayName: エラーの情報
    description: |
      APIリクエストがエラーになると、前述の通り[HTTPステータスコード](#tag/httpstatuscode)は<span class="mp-oas-code">4xx</span>、<span class="mp-oas-code">5xx</span>が返ります。  
      レスポンスボディは[RFC 9457](https://www.rfc-editor.org/rfc/rfc9457)の仕様に従って以下のエラー情報がJSON形式で返ります。  
      HTTPレスポンスヘッダーの<span class="mp-oas-code">Content-Type</span>は、<span class="mp-oas-code">application/problem+json</span>です。

      |キー|説明|例|
      |:--|:--|:--|
      |type|エラーの説明ページURL<br />該当のエラーに説明ページがない場合は何も返りません|https://mp-faq.gmo-pg.com/s/article/D00923|
      |title|エラーの内容サマリー<br />エラーコードとして取り扱えます<br />一覧は以下の表を参照ください|invalid_parameter|
      |detail|エラーの詳細説明<br />エラーメッセージとして取り扱えます<br />全て英文です。|The value provided for parameter is invalid.(orderid)|
      |instance|エラーが発生したエンドポイント|/credit/charge|

      <span class="mp-oas-code">title</span>パラメーター(エラーの内容サマリー)の一覧は以下の通りです。
      |title名|説明|HTTP<br />ステータス<br />コード|
      |:---|:---|:---|
      |invalid_contract|対象ショップの契約状態が無効であるか、ショップの設定が不足しています。|400|
      |invalid_header|リクエストヘッダーの値が不正です。|400|
      |invalid_parameter|リクエストパラメーターの書式または桁数が不正です。|400|
      |invalid_request|対象の取引に対して不正なリクエストです。|400|
      |invalid_status|対象の取引状態に対して処理できないリクエストです。|400|
      |missing_parameter|必須パラメーターが設定されていません。|400|
      |transaction_count_exceeded|同一取引に対する処理上限を超過しています。<br />所定の返金回数を超過した場合などに発生します。|400|
      |transaction_expired|処理期限を超過しています。<br />オーソリの有効期限超過後に確定を行った場合などに発生します。|400|
      |unauthorized_request|認証情報が正しくないか、許可されないIPアドレスのため、リクエストは受け付けられません。|401|
      |operation_aborted_by_user|お客様の操作により決済手続きが中止されました。|402|
      |card_declined|カード起因のエラーにより、リクエストが拒否されました。|402|
      |insufficient_balance|残高が不足しているため、リクエストが拒否されました。|402|
      |amount_limit_exceeded|上限金額を超過しているため、リクエストが拒否されました。|402|
      |processing_failure|決済事業者からエラーが返りました。<br />詳細は<span class="mp-oas-code">detail</span>を参照ください。|402|
      |resource_not_found|APIエンドポイントが無効であるため、リクエストは受け付けられません。|404|
      |method_not_allowed|HTTPメソッドが正しくないため、リクエストは受け付けられません。<br />リダイレクト時は<span class="mp-oas-code">GET</span>、それ以外は<span class="mp-oas-code">POST</span>です。|405|
      |conflict|二重リクエストのため、リクエストは受け付けられません。|409|
      |unsupported_media_type|<span class="mp-oas-code">Content-Type</span>ヘッダーが正しくないため、リクエストは受け付けられません。<br /><span class="mp-oas-code">application/json</span>のみに対応しています。|415|
      |too_many_requests|同時接続数の上限を超過しています。|429|
      |internal_server_error|当サービスのサーバーで問題が発生したため、リクエストを処理できませんでした。|500|
      |bad_gateway|外部事業者やネットワークで問題が発生したため、リクエストを処理できませんでした。|502|
      |maintenance|外部事業者によるメンテナンスのため、リクエストは受け付けられません。|502|
      |service_unavailable|当サービスがメンテナンス中のため、リクエストは受け付けられません。|503|

      以下はエラーレスポンスのサンプルです。
      ```javascript
      {
        "type":"https://mp-faq.gmo-pg.com/s/article/XXXXXX",
        "title":"invalid_parameter",
        "detail":"The parameter value is invalid.(order.amount)",
        "instance":"/credit/charge"
      }
      ```

      <br />
  - name: access-token
    x-displayName: アクセストークン
    description: |
      支払いAPI、本人確認APIを利用するためのアクセストークンを発行します
  - name: card-token-v2
    x-displayName: トークン決済v2
    description: |
      APIでカード情報をトークン化します。スマートフォンのネイティブアプリから直接呼ばれることを想定しています。  
      TLS は1.2 に対応しています。
      ATSにつきましては対応していませんので、アプリ側でATSに対応している場合はホワイトリストへのURLの登録をお願いします。  
      <br />
      カード情報のトークン化の詳細は、[トークン決済v2 概要](/mulpay/docs/developer-support/sdk/overview)を参照してください。  
  - name: encrypteddata
    x-displayName: カード情報オブジェクト作成ガイド
    description: |
      Web APIで利用するパラメーター<span class="mp-oas-code">encryptedData</span>はカード情報を暗号化した文字列です。
      作成の手順を説明します。

      ### カード情報データの用意
      お客様が入力した値からネイティブアプリ内で以下のカード情報データをJSON形式で用意します。

      <div class="parameter_table">
      <table>
        <thead>
          <tr>
            <th colspan="2">項目</th>
            <th>説明</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td colspan="2" class="parameter">card<p class="required">required</p></td>
            <td><span >object</span> </td>
          </tr>
          <tr>
            <td rowspan="5"></td>
            <td class="parameter">cardNumber<p class="required">required</p></td>
            <td>
              <span >string</span> <code>^[0-9]{12,16}$</code><br />
              カード番号<br />
              ハイフンは含めず半角数字のみで設定します。
            </td>
          </tr>
          <tr>
            <td class="parameter">cardholderName</td>
            <td>
              <span >string</span> <code>^[0-9a-zA-Z\s\x2c-\x2f]{0,50}$</code><br />
              カード名義人<br />
              設定しない場合、カード名義人を取引に記録しません。<br />
              3Dセキュア認証利用時には必ず設定してください。<br />
              未設定でもエラーにはなりませんが、変更になる可能性があります。
            </td>
          </tr>
          <tr>
            <td class="parameter">expiryMonth<p class="required">required</p></td>
            <td>
              <span >string</span> <code>^[0-9]{2}$</code><br />
              有効期限(月)<br />
              半角数字でMM形式で設定します。
            </td>
          </tr>
          <tr>
            <td class="parameter">expiryYear<p class="required">required</p></td>
            <td>
              <span >string</span> <code>^([0-9]{2}|[0-9]{4})$</code><br />
              有効期限(年)<br />
              半角数字でYYまたはYYYY形式で設定します。
            </td>
          </tr>
          <tr>
            <td class="parameter">securityCode</td>
            <td>
              <span >string</span> <code>^(|[0-9]{3,4})$</code><br />
              セキュリティコード<br />
              3または4桁の数字で設定します。
            </td>
          </tr>
        </tbody>
      </table>
      </div>

      以下はカード情報データのサンプルです。
      ```javascript
      {
        "card": {
          "cardNumber":"4111111111111111",
          "cardholderName":"HOLDER NAME",
          "expiryMonth":"05",
          "expiryYear":"24",
          "securityCode":"123"
        }
      }
      ```

      ### 暗号化とBase64エンコード
      前述のカード情報データのJSON文字列を管理画面からダウンロードした公開鍵を用いてRSA方式(2048bit)で暗号化します。公開鍵については[カード情報トークン化](/mulpay/docs/payment-method/credit/card/tokenization)の認証情報を参照ください。
      暗号化後の文字列をBase64エンコードした文字列を「カード情報オブジェクト」としてトークン発行リクエストパラメーターに設定します。

      ### サンプルコード
      JavaとSwiftのコードスニペットです。変数の保持方法や例外処理は適切に変更してください

      <details>
        <summary >Java</summary>

        ```java
        public String createEncryptedData() throws Exception {
          // 管理画面からダウンロードした公開鍵
          String publicKeyString = "MIIBIjA...";
          // カード情報データのJSON文字列
          String cardInfoJson = "{\"card\":{\"cardNumber\":\"4111111111111111\",\"cardholderName\":\"HOLDERNAME\",\"expiryMonth\":\"05\",\"expiryYear\":\"24\",\"securityCode\":\"123\"}}";

          // 公開鍵から公開鍵オブジェクトを作成
          byte[] decodedPublicKey = Base64.getDecoder().decode(publicKeyString.getBytes(StandardCharsets.UTF_8));
          PublicKey publicKey = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(decodedPublicKey));

          // カード情報データを暗号化
          Cipher cipher = Cipher.getInstance("RSA/ECB/PKCS1Padding");
          cipher.init(Cipher.ENCRYPT_MODE, publicKey);
          byte[] encryptedByte = cipher.doFinal(cardInfoJson.getBytes());

          // Base64エンコード
          String encryptedData = Base64.getEncoder().encodeToString(encryptedByte);

          return encryptedData;
        }
        ```

      </details>
      <br />
      <details>
        <summary >Swift</summary>

        ```swift
        func makeCardInfoData() -> String? {
          do{
            let publicKeyString = "MIIBIjA..."
            let cardInfoJson = "{\"card\":{\"cardNumber\":\"4111111111111111\",\"cardholderName\":\"HOLDERNAME\",\"expiryMonth\":\"05\",\"expiryYear\":\"24\",\"securityCode\":\"123\"}}"

            // 公開鍵から公開鍵オブジェクトを作成
            let data:Data = Data(base64Encoded: publicKeyString, options: Data.Base64DecodingOptions.ignoreUnknownCharacters)!
            let keyDict:[NSObject:NSObject] = [kSecAttrKeyType: kSecAttrKeyTypeRSA,
              kSecAttrKeyClass: kSecAttrKeyClassPublic,
              kSecAttrKeySizeInBits: NSNumber(value: 2048),
              kSecReturnPersistentRef: true as NSObject
            ]
            let publicKey = SecKeyCreateWithData(data as CFData, keyDict as CFDictionary, nil)

            // カード情報データを暗号化
            let plainBuffer = [UInt8](cardInfoJson.utf8)
            var cipherBufferSize : Int = Int(SecKeyGetBlockSize(publicKey!))
            var cipherBuffer = [UInt8](repeating:0, count:Int(cipherBufferSize))
            let status = SecKeyEncrypt(publicKey!, SecPadding.PKCS1, plainBuffer, plainBuffer.count, &cipherBuffer, &cipherBufferSize)
            if (status != errSecSuccess) {
              // 失敗時の処理
            }

            // Base64エンコード
            let mudata = NSData(bytes: &cipherBuffer, length: cipherBufferSize)
            let encryption = mudata.base64EncodedString(options: NSData.Base64EncodingOptions.lineLength64Characters)
            return encryption
          } catch {
            return nil
          }
        }
        ```

      </details>
  - name: token-api-errors
    x-displayName: エラー情報
    description: |
      APIリクエストがエラーになると、HTTPステータスコードは<span class="mp-oas-code">4xx</span>、<span class="mp-oas-code">5xx</span>を返却します。
      HTTPレスポンスヘッダー、レスポンスボディは[API仕様](/mulpay/apis/openapi-type/create-token)のResponsesを参照してください。
      ただし、以下表の「種別」が「アクセスエラー」、「サービス利用不可」は、APIを受け付ける前のエラーであり、上記Responsesには記載していません。

      ### エラー時のHTTPステータスコードとエラー情報
      |HTTP<br />ステータス<br />コード|種別|説明|
      |:---|:---|:---|
      |<span class="mp-oas-code">400</span>|リクエストパラメーターエラー|パラメーターの内容が正しくない、<br />またはカード情報オブジェクトが正しく<br />暗号化できていないため、リクエストは処理できません。|
      |<span class="mp-oas-code">404</span>|アクセスエラー|APIエンドポイントが無効であるため、<br />リクエストは受け付けられません。|
      |<span class="mp-oas-code">405</span>|アクセスエラー|HTTPメソッドが<span class="mp-oas-code">POST</span>ではないため、<br />リクエストは受け付けられません。|
      |<span class="mp-oas-code">415</span>|アクセスエラー|<span class="mp-oas-code">Content-Type</span>ヘッダーが正しくないため、<br />リクエストは受け付けられません。<br /><span class="mp-oas-code">application/json</span>のみに対応しています。|
      |<span class="mp-oas-code">429</span>|アクセスエラー|同時処理数が規定値を超えているため、<br />リクエストは受け付けられません。|
      |<span class="mp-oas-code">500</span>|当サービス内部のシステムエラー|当サービスのサーバーで問題が発生したため、<br />リクエストを処理できませんでした。|
      |<span class="mp-oas-code">503</span>|サービス利用不可|当サービスがメンテナンス中のため、<br />リクエストは受け付けられません。<br />このコードを返すメンテナンス情報は、<br />6ヶ月前に加盟店様に通知します。|

      ### 処理結果コード一覧  
      処理結果コード<span class="mp-oas-code">legacyCode</span>パラメーターの一覧は以下の通りです。

      |コード|意味|
      |:---|:---|
      |<span class="mp-oas-code">000</span>|MPクレカトークン取得正常終了|
      |<span class="mp-oas-code">100</span>|カード番号必須チェックエラー|
      |<span class="mp-oas-code">101</span>|カード番号フォーマットエラー(数字以外を含む)|
      |<span class="mp-oas-code">102</span>|カード番号フォーマットエラー(10-16桁の範囲外)|
      |<span class="mp-oas-code">110</span>|有効期限必須チェックエラー|
      |<span class="mp-oas-code">111</span>|有効期限フォーマットエラー(数字以外を含む)|
      |<span class="mp-oas-code">112</span>|有効期限フォーマットエラー(6または4桁以外)|
      |<span class="mp-oas-code">113</span>|有効期限フォーマットエラー(月が13以上)|
      |<span class="mp-oas-code">121</span>|セキュリティコードフォーマットエラー(数字以外を含む)|
      |<span class="mp-oas-code">122</span>|セキュリティコード桁数エラー|
      |<span class="mp-oas-code">131</span>|カード名義人フォーマットエラー(半角英数字、一部の記号以外を含む)|
      |<span class="mp-oas-code">132</span>|カード名義人フォーマットエラー(51桁以上)|
      |<span class="mp-oas-code">141</span>|MPクレカトークン発行数フォーマットエラー(数字以外を含む)|
      |<span class="mp-oas-code">142</span>|MPクレカトークン発行数フォーマットエラー(1-10の範囲外)|
      |<span class="mp-oas-code">150</span>|カード情報オブジェクト必須チェックエラー|
      |<span class="mp-oas-code">160</span>|APIキー必須チェックエラー|
      |<span class="mp-oas-code">161</span>|APIキーフォーマットエラー|
      |<span class="mp-oas-code">180</span>|APIキーが無効|
      |<span class="mp-oas-code">190</span>|カード情報オブジェクトが復号できない|
      |<span class="mp-oas-code">191</span>|カード情報オブジェクトフォーマットエラー|
      |<span class="mp-oas-code">901</span>|当サービス内部のシステムエラー|
      |<span class="mp-oas-code">902</span>|処理が混み合っている|
  - name: creditcard
    x-displayName: クレカ払い
    description: |
      クレカ払いで利用するAPIです。  
      ### ご利用可能なカード
      以下の国際ブランドがついたクレジットカード・デビットカード、およびそのカード情報を登録したApple Pay、Google Payのお支払いに対応します。 
      - VISA
      - Mastercard
      - JCB
      - American Express
      - Diners Club  

      ### テストカード番号
      テスト環境で利用可能なカード番号は、[テストカード一覧](/mulpay/docs/payment-method/credit/card/test-cards)  
      上記ページの「カード登録・初回決済は成功するが後続処理でエラーとなるテスト手順」は、OpenAPIタイプでも利用可能です。  

      ### 仮売上と確定
      「仮売上」については、こちらの[FAQページ](https://mp-faq.gmo-pg.com/s/article/F00024)を参照ください。  
      支払い要求のタイプ<span class="mp-oas-code">creditChargeOptions.authorizationMode</span>が仮売上<span class="mp-oas-code">AUTH</span>の取引は、[確定処理](/mulpay/apis/openapi-type/order-capture)により売上が確定します。  
      仮売上の有効期限は60日後の23時59分59秒であり、詳細な日時は支払い完了後に返る仮売上有効日時<span class="mp-oas-code">creditResult.captureExpiryDateTime</span>を確認してください。  
      例えば2020/1/8 17:00に仮売上の支払いをした場合、確定処理の期限は2020/3/8 23:59:59です。  
      支払い要求のタイプ<span class="mp-oas-code">creditChargeOptions.authorizationMode</span>が即時売上<span class="mp-oas-code">CAPTURE</span>の取引は、即座に売上が確定するため、確定処理は必要ありません。  

      ### 処理シーケンス
      都度支払い、随時支払い、有効性確認の処理の流れは以下を参照してください。  
      - [支払い 決済処理シーケンス](/mulpay/docs/connection-method/openapi-type/flow-openapi/flow-openapi-credit-payment)
      - [会員カード登録 決済処理シーケンス](/mulpay/docs/connection-method/openapi-type/flow-openapi/flow-openapi-credit-member-card)
      処理のシーケンスは、3Dセキュア認証([EMV 3-D Secure](https://www.emvco.com/emv-technologies/3-d-secure/))と自動オーソリの有無で異なります。  
      不正検知サービスを利用する場合は、非同期モードの設定により処理のシーケンスが変わります。  
      いずれの場合も、[カード情報のトークン化](/mulpay/docs/payment-method/credit/card/tokenization)は本APIの呼び出し前に行ってください。  

  - name: wallet
    x-displayName: Pay払い
    description: |
      Pay払いで利用するAPIです。  

      ### 処理シーケンス
      処理シーケンスは以下を参照してください。  
      - [決済処理シーケンス](/mulpay/docs/connection-method/openapi-type/flow-openapi/flow-openapi-wallet)

  - name: cash
    x-displayName: 現金払い
    description: |
      現金払いで利用するAPIです。
  - name: deferredpay
    x-displayName: 後払い
    description: |
      後払いで利用するAPIです。  
      アトカラでは下記シーケンスの結果表示までをJavaScript SDKを用いて行います。
      詳細は[こちら](/mulpay/docs/payment-method/deferredpay/atokara/overview)を参考ください。

      ### 処理シーケンス
      <details>
      <summary>後払いのシーケンス</summary>
      <br />

      <br /><br />

      ```mermaid
      %%{
       init: {
        'theme': 'base',
        'themeVariables': {
          'primaryColor': '#f0f2f5',
          'primaryTextColor': '#001C40',
          'noteBkgColor': '#d9f4fc',
          'noteTextColor': '#001C40',
          'noteBorderColor': '#54C5E8'
        }
       }
      }%%
      sequenceDiagram
      actor pyr as お客様
      participant brw as ブラウザ
      participant mer as 加盟店様
      participant psp as 決済代行(当サービス)
      participant pcp as 後払い事業者
      pyr->>+brw:「支払い」<br />ボタンクリック
      brw->>+pcp: 認証要求
      pcp-->>-brw: 
      brw-->>-pyr: 認証情報入力画面表示
      pyr->>+brw: TEL/メールアドレス入力
      brw->>+pcp: 
      pcp-->>+psp: 取引情報連携
      pcp-->>-pyr: 認証コード送信
      pyr->>+brw: 認証コード入力
      brw->>+pcp: 与信要求
      pcp-->>+psp: 与信審査結果連携
      pcp-->>-brw: 与信審査結果連携
      brw-->>-pyr: 結果表示
      opt 与信審査結果の通知
        pcp->>+psp: Webhook通知
        psp->>+mer: Webhook通知   
      end
      ```

      </details>
  - name: order
    x-displayName: 取引管理
    description: |
      各種取引管理のAPIです。
  - name: member
    x-displayName: 会員管理
    description: |
      各種会員管理のAPIです。
  - name: events
    x-displayName: Webhook
    description: |
      加盟店様のサーバーで当サービスから送信するWebhookを受け取るためのAPI仕様です。
  - name: verify
    x-displayName: 本人確認
    description: |
      本人確認機能で利用するAPIです。  
      <br />

      ### 処理シーケンス
      認証手段ごとの処理の流れを説明します。  

      <details>
      <summary>SMS認証</summary>
      <br />

      <br /><br />

      ```mermaid
      %%{
       init: {
        'theme': 'base',
        'themeVariables': {
          'primaryColor': '#f0f2f5',
          'primaryTextColor': '#001C40',
          'noteBkgColor': '#d9f4fc',
          'noteTextColor': '#001C40',
          'noteBorderColor': '#54C5E8'
        }
       }
      }%%
      sequenceDiagram
      actor pyr as お客様
      participant brw as ブラウザ
      participant mer as 加盟店様
      participant psp as 決済代行<br />(当サービス)
      participant sms as SMS配信事業者
      pyr->>+brw:「認証開始」<br />ボタン押下
      brw->>+mer: 認証開始
      mer->>+psp: /verification/start<br />リクエスト
      psp-->>-mer: リダイレクト情報
      mer->>-brw: 開始URLへのリダイレクト
      brw->>brw: 
      brw->>+psp: 
      psp-->>-brw:認証コード入力画面 
      brw-->>-pyr: 認証コード<br />入力画面を表示
      brw-)+psp: SMS送信リクエスト
      psp->>+sms: SMS送信リクエスト
      sms-->>psp: 結果
      psp--)-brw: 結果
      sms->>-pyr: 認証コードをSMSで通知
      opt 認証コードの再送信が行われた場合
        pyr->>+brw: 「再送信」<br />ボタン押下
        brw->>+psp: SMS送信リクエスト
        psp->>+sms: SMS送信リクエスト
        sms-->>psp: 結果
        psp-->>-brw: 結果
        brw-->>-pyr: 「再送信」<br />完了メッセージ
        sms->>-pyr: 認証コードをSMSで通知
      end
      pyr->>+brw: 認証コード入力
      brw->>+psp: 認証コードの確認リクエスト
      psp->>-brw: 加盟店様のコールバックURLへのリダイレクト
      brw->>brw: 
      brw->>+mer: 
      mer-->>-brw: 次画面
      brw-->>-pyr: 次画面を表示
      ```
      </details>
      <br />

      ### テスト環境の認証コード
      テスト環境ではSMS送信が行われないため、試験シナリオに応じた認証コードを入力してください。  

      <table>
        <thead>
          <tr>
            <th rowspan="2">シナリオ</th>
            <th colspan="2" >認証コード</th>
            <th rowspan="2">説明</th>
          </tr>
          <tr>
            <th >6桁</th>
            <th >4桁</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <th>認証コード誤り</th>
            <td >777777</td>
            <td >7777</td>
            <td>認証コードの照合に失敗します。<br />リトライ回数上限を超えた場合、<br />加盟店コールバックURLに遷移します。<br />認証ステータスは認証失敗<span class="mp-oas-code">FAILURE</span>になります。</td>
          </tr>
          <tr>
            <th>SMS送信失敗</th>
            <td >888888</td>
            <td >8888</td>
            <td>認証コード入力画面への遷移後に<br />SMS送信が失敗した振る舞いをします。<br />画面にSMS送信ができなかった旨のメッセージが表示され、<br />加盟店コールバックURLには遷移しません。</td>
          </tr>
          <tr>
            <th>当サービス<br />サーバエラー</th>
            <td >999999</td>
            <td >9999</td>
            <td>認証コード入力後に、当サービスで<br />エラーが発生した振る舞いをします。<br />画面にエラーが発生した旨のメッセージが表示され、<br />加盟店コールバックURLには遷移しません。</td>
          </tr>
          <tr>
            <th>認証成功</th>
            <td >上記以外</td>
            <td >上記以外</td>
            <td>認証に成功し、加盟店コールバックURLに遷移します。<br />認証ステータスは認証成功<span class="mp-oas-code">SUCCESS</span>になります。</td>
          </tr>
        </tbody>
      </table>

      <br />

      ### SMSの文面
      本番環境でお客様の携帯電話に送信されるSMSメッセージは以下です。
      ```html
      認証コード:123456  
      このコードを認証画面で入力してください。
      ```
  - name: faq
    x-displayName: よくあるご質問(FAQ)
    description: |
      [PGマルチペイメントサービス 加盟店用 FAQサイト](https://mp-faq.gmo-pg.com/s/)を参照ください。
  - name: correspondence
    x-displayName: プロトコルタイプ対応表
    description: |
      従来の接続方式であるプロトコルタイプからOpenAPIタイプへ移行する加盟店様向けの情報です。  
      各ユースケースに対応するエンドポイント及びその使用方法は以下の通りです。  
      ## クレジットカード決済  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*<br />- お客様によるカード<br />&nbsp;&nbsp;情報入力<br />- トークン化あり<br />- 3Dセキュアなし<br />- 即時に売上を確定|1. カード情報をトークン化<br />2. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />3. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- 1で取得したトークンを設定|1. カード情報をトークン化<br />2. 都度支払い [/credit/charge](/mulpay/apis/openapi-type/credit-charge)<br />&nbsp;&nbsp;- 1で取得したトークンを設定<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span>|
      |*お支払い*<br />- 登録済みのカード<br />&nbsp;&nbsp;情報を利用<br />- 3Dセキュアなし<br />- あとで売上を確定|1. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"AUTH"</span><br />2. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- 会員IDを設定<br />3. 決済変更 [/AlterTran.idPass](/mulpay/apis/protocol-type/idpass/alter-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"SALES"</span>|1. 随時支払い [/credit/on-file/charge](/mulpay/apis/openapi-type/credit-onfile-charge)<br />&nbsp;&nbsp;- 会員IDを設定<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"AUTH"</span><br />2. 確定 [/order/capture](/mulpay/apis/openapi-type/order-capture)|
      |*お支払い*<br />- お客様によるカード<br />&nbsp;&nbsp;情報入力<br />- トークン化なし<br />- 3Dセキュアあり<br />- 自動オーソリなし|1. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />2. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- カード情報を設定<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL<br />4. 3DS2.0認証後決済実行 [/SecureTran2.idPass](/mulpay/apis/protocol-type/idpass/secure-tran-2)|1. 都度支払い [/credit/charge](/mulpay/apis/openapi-type/credit-charge)<br />&nbsp;&nbsp;- カード情報を設定<br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 3Dセキュア後の支払い [/tds2/finalizeCharge](/mulpay/apis/openapi-type/tds-2-finalize-charge)|
      |*お支払い*<br />- 登録済みのカード<br />&nbsp;&nbsp;情報を利用<br />- 3Dセキュアあり<br />- 自動オーソリあり|-<br />※プロトコルタイプは自動オーソリ<br />機能がありません。|1. 随時支払い [/credit/on-file/charge](/mulpay/apis/openapi-type/credit-onfile-charge)<br />&nbsp;&nbsp;- 会員IDを設定<br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*有効性確認*<br />- お客様によるカード<br />&nbsp;&nbsp;情報入力<br />- トークン化あり<br />- 3Dセキュアなし|1. カード情報をトークン化<br />2. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CHECK"</span><br />3. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- 1で取得したトークンを設定|1. カード情報をトークン化<br />2. 有効性確認 [/credit/verifyCard](/mulpay/apis/openapi-type/credit-verify-card)<br />&nbsp;&nbsp;- 1で取得したトークンを設定|
      |*有効性確認*<br />- お客様によるカード<br />&nbsp;&nbsp;情報入力<br />- トークン化なし<br />- 3Dセキュアあり<br />- 自動オーソリなし|1. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CHECK"</span><br />2. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- カード情報を設定<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL<br />4. 3DS2.0認証後決済実行 [/SecureTran2.idPass](/mulpay/apis/protocol-type/idpass/secure-tran-2)|1. 有効性確認 [/credit/verifyCard](/mulpay/apis/openapi-type/credit-verify-card)<br />&nbsp;&nbsp;- カード情報を設定<br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 3Dセキュア後の有効性確認 [/tds2/finalizeVerification](/mulpay/apis/openapi-type/tds-2-finalize-verification)|
      |*有効性確認とカード登録*<br />- お客様によるカード<br />&nbsp;&nbsp;情報入力<br />- トークン化あり<br />- 3Dセキュアなし|1. 会員登録 [/SaveMember.idPass](/mulpay/apis/protocol-type/idpass/save-member)<br />2. カード情報をトークン化<br />3. カード登録 [/SaveCard.idPass](/mulpay/apis/protocol-type/idpass/save-card)<br />&nbsp;&nbsp;- 2で取得したトークンを設定|1. カード情報をトークン化<br />2. 有効性確認 [/credit/verifyCard](/mulpay/apis/openapi-type/credit-verify-card)<br />&nbsp;&nbsp;- 1で取得したトークンを設定<br />&nbsp;&nbsp;- <span class="mp-oas-code">"createNewMember":true</span>|
      |*有効性確認とカード登録*<br />- お客様によるカード<br />&nbsp;&nbsp;情報入力<br />- トークン化なし<br />- 3Dセキュアあり<br />- 自動オーソリなし|1. 会員登録 [/SaveMember.idPass](/mulpay/apis/protocol-type/idpass/save-member)<br />2. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CHECK"</span><br />3. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- カード情報を設定<br />4. リダイレクト<br />&nbsp;&nbsp;- 3で返されたURL<br />5. 3DS2.0認証後決済実行 [/SecureTran2.idPass](/mulpay/apis/protocol-type/idpass/secure-tran-2)<br />6. 決済後カード登録 [/TradedCard.idPass](/mulpay/apis/protocol-type/idpass/traded-card)|1. 有効性確認 [/credit/verifyCard](/mulpay/apis/openapi-type/credit-verify-card)<br />&nbsp;&nbsp;- カード情報を設定<br />&nbsp;&nbsp;- <span class="mp-oas-code">"createNewMember":true</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 3Dセキュア後の有効性確認 [/tds2/finalizeVerification](/mulpay/apis/openapi-type/tds-2-finalize-verification)|
      |*お支払い後のカード登録*<br />- お客様によるカード<br />&nbsp;&nbsp;情報入力<br />- トークン化あり<br />- 3Dセキュアなし|1. カード情報をトークン化<br />2. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />3. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- 1で取得したトークンを設定<br />4. 会員登録 [/SaveMember.idPass](/mulpay/apis/protocol-type/idpass/save-member)<br />5. 決済後カード登録 [/TradedCard.idPass](/mulpay/apis/protocol-type/idpass/traded-card)<br />&nbsp;&nbsp;- 2で返された取引IDを設定|1. カード情報をトークン化<br />2. 都度支払い [/credit/charge](/mulpay/apis/openapi-type/credit-charge)<br />3. カード登録 [/credit/storeCard](/mulpay/apis/openapi-type/credit-store-card)<br />&nbsp;&nbsp;- 2で返された取引IDを設定|
      |*お支払い後のキャンセル*<br />- 登録済みのカード<br />&nbsp;&nbsp;情報を利用<br />- 3Dセキュアなし|1. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />2. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- 会員IDを設定<br />3. 決済変更 [/AlterTran.idPass](/mulpay/apis/protocol-type/idpass/alter-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CANCEL"</span>|1. 随時支払い [/credit/on-file/charge](/mulpay/apis/openapi-type/credit-onfile-charge)<br />&nbsp;&nbsp;- 会員IDを設定<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />2. キャンセル [/order/cancel](/mulpay/apis/openapi-type/order-cancel)|
      |*お支払い後の金額変更*<br />- 登録済みのカード<br />&nbsp;&nbsp;情報を利用<br />- 3Dセキュアなし|1. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />2. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- 会員IDを設定<br />3. 金額変更 [/ChangeTran.idPass](/mulpay/apis/protocol-type/idpass/change-tran)<br />&nbsp;&nbsp;- 変更後の金額を設定|1. 随時支払い [/credit/on-file/charge](/mulpay/apis/openapi-type/credit-onfile-charge)<br />&nbsp;&nbsp;- 会員IDを設定<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />2. 金額変更 [/order/update](/mulpay/apis/openapi-type/order-update)<br />&nbsp;&nbsp;- 変更後の金額を設定|

      ## Google Pay  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*<br />- 3Dセキュアなし<br />- 即時に売上を確定|1. Google Payトークンを取得<br />2. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />3. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"TokenType":"2"</span><br />&nbsp;&nbsp;- 1で取得したトークンを設定|1. Google Payトークンを取得<br />2. 都度支払い [/credit/charge](/mulpay/apis/openapi-type/credit-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"tokenizedCard.type":"GOOGLE_PAY_TOKEN"</span><br />&nbsp;&nbsp;- 1で取得したトークンを設定<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span>|
      |*お支払い*<br />- 3Dセキュアあり<br />- 自動オーソリなし<br />- あとで売上を確定|1. Google Payトークンを取得<br />2. 取引登録 [/EntryTran.idPass](/mulpay/apis/protocol-type/idpass/entry-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"AUTH"</span><br />3. 決済実行 [/ExecTran.idPass](/mulpay/apis/protocol-type/idpass/exec-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"TokenType":"2"</span><br />&nbsp;&nbsp;- 1で取得したトークンを設定<br />4. リダイレクト<br />&nbsp;&nbsp;- 3で返されたURL<br />5. 3DS2.0認証後決済実行 [/SecureTran2.idPass](/mulpay/apis/protocol-type/idpass/secure-tran-2)<br />6. 決済変更 [/AlterTran.idPass](/mulpay/apis/protocol-type/idpass/alter-tran)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"SALES"</span>|1. Google Payトークンを取得<br />2. 都度支払い [/credit/charge](/mulpay/apis/openapi-type/credit-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"tokenizedCard.type":"GOOGLE_PAY_TOKEN"</span><br />&nbsp;&nbsp;- 1で取得したトークンを設定<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL<br />4. 3Dセキュア後の支払い [/tds2/finalizeCharge](/mulpay/apis/openapi-type/tds-2-finalize-charge)<br />5. 確定 [/order/capture](/mulpay/apis/openapi-type/order-capture)|

      ## Apple Pay  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*<br />- 即時に売上を確定|1. Apple Payトークンを取得<br />2. 取引登録 [/EntryTranBrandtoken.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-brandtoken)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />3. 決済実行 [/ExecTranBrandtoken.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-brandtoken)<br />&nbsp;&nbsp;- 1で取得したトークンを設定|1. Apple Payトークンを取得<br />2. 都度支払い [/credit/charge](/mulpay/apis/openapi-type/credit-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"tokenizedCard.type":"APPLE_PAY_TOKEN"</span><br />&nbsp;&nbsp;- 1で取得したトークンを設定<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span>|

      ## PayPay  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*<br />- あとで売上を確定|1. 取引登録 [/EntryTranPaypay.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-paypay)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"AUTH"</span><br />2. 決済実行 [/ExecTranPaypay.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-paypay)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"AUTH"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*お支払い*<br />- 即時に売上を確定|1. 取引登録 [/EntryTranPaypay.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-paypay)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />2. 決済実行 [/ExecTranPaypay.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-paypay)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*お支払い*<br />- PayPay画面への遷移なし<br />- あとで売上を確定|1. 取引登録 [/EntryTranPaypaySmart.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-paypay-smart)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"AUTH"</span><br />2. 決済実行 [/ExecTranPaypaySmart.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-paypay-smart)<br />3. 加盟店様画面上でお客様がお支払い<br />4.決済検証|1. 都度支払い（フロントエンド方式） [/wallet/front-end/charge](/mulpay/apis/openapi-type/wallet-frontend-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"AUTH"</span><br />2. 加盟店様画面上でお客様がお支払い<br />3. 支払い後検証（フロントエンド方式）[/wallet/front-end/verifyCharge](/mulpay/apis/openapi-type/wallet-frontend-verify-charge)<br />4. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*お支払い*<br />- PayPay画面への遷移なし<br />- 即時に売上を確定|1. 取引登録 [/EntryTranPaypaySmart.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-paypay-smart)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />2. 決済実行 [/ExecTranPaypaySmart.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-paypay-smart)<br />3. 加盟店様画面上でお客様がお支払い<br />4.決済検証|1. 都度支払い（フロントエンド方式） [/wallet/front-end/charge](/mulpay/apis/openapi-type/wallet-frontend-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />2. 加盟店様画面上でお客様がお支払い<br />3. 支払い後検証（フロントエンド方式）[/wallet/front-end/verifyCharge](/mulpay/apis/openapi-type/wallet-frontend-verify-charge)<br />4. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|

      ## d払い  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*<br />- あとで売上を確定|1. 取引登録 [/EntryTranDocomo.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-docomo)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"AUTH"</span><br />2. 決済実行 [/ExecTranDocomo.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-docomo)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"DOCOMO"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"AUTH"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*お支払い*<br />- 即時に売上を確定|1. 取引登録 [/EntryTranDocomo.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-docomo)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />2. 決済実行 [/ExecTranDocomo.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-docomo)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"DOCOMO"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|

      ## Amazon Pay V2  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*<br />- あとで売上を確定|1. 住所情報参照 [/SearchAddressAmazonpay.idPass](/mulpay/apis/protocol-type/idpass/search-address-amazonpay)<br />2. 取引登録 [/EntryTranAmazonpay.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-amazonpay)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"AUTH"</span><br />3. 決済実行 [/ExecTranAmazonpay.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-amazonpay)<br />4. リダイレクト<br />&nbsp;&nbsp;- 3で返されたURL|1. 購入者情報取得 [/wallet/getCustomerData](/mulpay/apis/openapi-type/wallet-get-customer-data)<br />2. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"AMAZON"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"AUTH"</span><br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL<br />4. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*お支払い*<br />- 即時に売上を確定|1. 取引登録 [/EntryTranAmazonpay.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-amazonpay)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />2. 決済実行 [/ExecTranAmazonpay.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-amazonpay)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"AMAZON"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*確定後のキャンセル*|1. キャンセル [/AmazonpayCancel.idPass](/mulpay/apis/protocol-type/idpass/amazonpay-cancel)<br />2. 返金完了通知を受信 [結果通知](/mulpay/apis/protocol-type/idpass/amazonpay-notification)|1. キャンセル [/order/cancel](/mulpay/apis/openapi-type/order-cancel)<br />2. Amazon Pay V2キャンセル結果通知を受信 [Webhook](/mulpay/apis/openapi-type/amazon-pay-cancel-webhook)|

      ## 楽天ペイ(オンライン決済)V2  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*<br />- あとで売上を確定|1. 取引登録 [/EntryTranRakutenpay.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-rakutenpay)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"AUTH"</span><br />2. 決済実行 [/ExecTranRakutenpay.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-rakutenpay)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"RAKUTEN"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"AUTH"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*お支払い*<br />- 即時に売上を確定|1. 取引登録 [/EntryTranRakutenpay.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-rakutenpay)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />2. 決済実行 [/ExecTranRakutenpay.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-rakutenpay)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"RAKUTEN"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|

      ## au PAY(ネット支払い)アプリ方式
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*<br />- あとで売上を確定|1. 取引登録 [/EntryTranAupayApp.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-aupay-app)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"AUTH"</span><br />2. 決済実行 [/ExecTranAupayApp.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-aupay-app)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"AU_APP"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"AUTH"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*お支払い*<br />- 即時に売上を確定|1. 取引登録 [/EntryTranAupayApp.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-aupay-app)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />2. 決済実行 [/ExecTranAupayApp.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-aupay-app)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"AU_APP"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|

      ## メルペイ  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*<br />- あとで売上を確定|1. 取引登録 [/EntryTranMerpay.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-merpay)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"AUTH"</span><br />2. 決済実行 [/ExecTranMerpay.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-merpay)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"MERPAY"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"AUTH"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|
      |*お支払い*<br />- 即時に売上を確定|1. 取引登録 [/EntryTranMerpay.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-merpay)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"JobCode":"CAPTURE"</span><br />2. 決済実行 [/ExecTranMerpay.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-merpay)<br />3. リダイレクト<br />&nbsp;&nbsp;- 2で返されたURL|1. 都度支払い [/wallet/charge](/mulpay/apis/openapi-type/wallet-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"walletType":"MERPAY"</span><br />&nbsp;&nbsp;- <span class="mp-oas-code">"authorizationMode":"CAPTURE"</span><br />2. リダイレクト<br />&nbsp;&nbsp;- 1で返されたURL<br />3. 照会 [/order/inquiry](/mulpay/apis/openapi-type/order-inquiry)|

      ## コンビニ決済  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*|1. 取引登録 [/EntryTranCvs.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-cvs)<br />2. 決済実行 [/ExecTranCvs.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-cvs)<br />3. 入金通知を受信 [結果通知](/mulpay/apis/protocol-type/idpass/cvs-notification)|1. 支払い番号発行 [/cash/charge](/mulpay/apis/openapi-type/cash-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"cashType":"KONBINI"</span><br />2. 現金払い支払い完了通知を受信 [Webhook](/mulpay/apis/openapi-type/cash-webhook)|

      ## Pay-easy決済  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*|1. 取引登録 [/EntryTranPayEasy.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-payeasy)<br />2. 決済実行 [/ExecTranPayEasy.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-payeasy)<br />3. 入金通知を受信 [結果通知](/mulpay/apis/protocol-type/idpass/payeasy-notification)|1. 支払い番号発行 [/cash/charge](/mulpay/apis/openapi-type/cash-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"cashType":"PAYEASY"</span><br />2. 現金払い支払い完了通知を受信 [Webhook](/mulpay/apis/openapi-type/cash-webhook)|

      ## 銀行振込(バーチャル口座)  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*|1. 取引登録 [/EntryTranVirtualaccount.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-virtualaccount)<br />2. 決済実行 [/ExecTranVirtualaccount.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-virtualaccount)<br />3. 入金通知を受信 [結果通知](/mulpay/apis/protocol-type/idpass/virtualaccount-notification)|1. 支払い番号発行 [/cash/charge](/mulpay/apis/openapi-type/cash-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"cashType":"BANK_TRANSFER_SMBC"</span><br />2. 現金払い支払い完了通知を受信 [Webhook](/mulpay/apis/openapi-type/cash-webhook)|

      ## 銀行振込(バーチャル口座 あおぞら)  
      |ユースケース|プロトコルタイプの<br />エンドポイント及びその利用方法|OpenAPIタイプの<br />エンドポイント及びその利用方法|
      |---|---|---|
      |*お支払い*|1. 取引登録 [/EntryTranGANB.idPass](/mulpay/apis/protocol-type/idpass/entry-tran-ganb)<br />2. 決済実行 [/ExecTranGANB.idPass](/mulpay/apis/protocol-type/idpass/exec-tran-ganb)<br />3. 入金通知を受信 [結果通知](/mulpay/apis/protocol-type/idpass/ganb-notification)|1. 支払い番号発行 [/cash/charge](/mulpay/apis/openapi-type/cash-charge)<br />&nbsp;&nbsp;- <span class="mp-oas-code">"cashType":"BANK_TRANSFER_GMO_AOZORA"</span><br />2. 現金払い支払い完了通知を受信 [Webhook](/mulpay/apis/openapi-type/cash-webhook)|
  - name: common-parameters
    x-displayName: 共通パラメーター表
    description: |-
      <span class="mp-oas-code">merchant</span> <span class="mp-oas-code">order</span> <span class="mp-oas-code">payer</span>は、全ての支払いタイプで共通のパラメーターです。  
      設定した値は、各決済手段ごとに以下の目的で利用されます。  
      その決済手段で利用されないパラメーターは「-」で表しており、設定した値は無視されます。

      ## クレカ払い

      ###  merchant
      ||クレジットカード決済|Google Pay|Apple Pay|ReD Shield|Forter|
      |---|---|---|---|---|---|
      |name|3Dセキュア認証画面に表示|-|-|-|-|
      |nameKana|-|-|-|-|-|
      |nameAlphabet|3Dセキュアの認証画面に表示<br />※nameが正しく表示<br />できない場合|-|-|-|-|
      |nameShort|-|-|-|-|-|
      |contactName|-|-|-|-|-|
      |contactEmail|-|-|-|-|-|
      |contactUrl|-|-|-|-|-|
      |contactPhone|-|-|-|-|-|
      |contactOpeningHours|-|-|-|-|-|
      |stores.id|-|-|-|-|-|
      |stores.name|-|-|-|-|-|

      ###  order
      ||クレジットカード決済|Google Pay|Apple Pay|ReD Shield|Forter|
      |---|---|---|---|---|---|
      |currency|-|-|-|不正審査に利用|-|
      |items.name|-|-|-|不正審査に利用|不正審査に利用|
      |items.description|-|-|-|不正審査に利用|-|
      |items.quantity|-|-|-|不正審査に利用|不正審査に利用|
      |items.type|-|-|-|不正審査に利用|不正審査に利用|
      |items.price|-|-|-|不正審査に利用|不正審査に利用|
      |items.category|-|-|-|不正審査に利用|不正審査に利用|
      |items.productId|-|-|-|不正審査に利用|-|
      |items.productCode|-|-|-|不正審査に利用|不正審査に利用|
      |transactionType|-|-|-|-|-|
      |shippingAddress.name|-|-|-|不正審査に利用|不正審査に利用|
      |shippingAddress.line1|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|
      |shippingAddress.line2|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|
      |shippingAddress.line3|3Dセキュア認証に利用|-|-|不正審査に利用|-|
      |shippingAddress.city|3Dセキュア認証に利用|-|-|-|不正審査に利用|
      |shippingAddress.state|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|
      |shippingAddress.postCode|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|
      |shippingAddress.country|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|
      |billingAddress.name|-|-|-|不正審査に利用|不正審査に利用|
      |billingAddress.line1|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|
      |billingAddress.line2|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|
      |billingAddress.line3|3Dセキュア認証に利用|-|-|不正審査に利用|-|
      |billingAddress.city|3Dセキュア認証に利用|-|-|-|不正審査に利用|
      |billingAddress.state|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|
      |billingAddress.postCode|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|
      |billingAddress.country|3Dセキュア認証に利用|-|-|不正審査に利用|不正審査に利用|

      ###  payer
      ||クレジットカード決済|Google Pay|Apple Pay|ReD Shield|Forter|
      |---|---|---|---|---|---|
      |name|-|-|-|-|-|
      |nameKana|-|-|-|-|-|
      |nameAlphabet|-|-|-|-|不正審査に利用|
      |gender|-|-|-|不正審査に利用|-|
      |dateOfBirth|-|-|-|不正審査に利用|-|
      |email|3Dセキュア認証に利用 <sup>*1</sup>|-|-|不正審査に利用|不正審査に利用|
      |deliveryEmail|3Dセキュア認証に利用|-|-|-|-|
      |phones.type|3Dセキュア認証に利用 <sup>*1 *2 *3</sup>|-|-|-|-|
      |phones.countryCode|3Dセキュア認証に利用 <sup>*1 *2 *3</sup>|-|-|-|-|
      |phones.number|3Dセキュア認証に利用 <sup>*1 *2 *3</sup>|-|-|不正審査に利用|不正審査に利用|
      |accountId|-|-|-|-|不正審査に利用|
      |ip|-|-|-|不正審査に利用|不正審査に利用|
      |deviceType|-|-|-|-|不正審査に利用|
      |httpUserAgent|-|-|-|-|不正審査に利用|

      *1：3Dセキュア認証時にはお客様のメールアドレス、電話番号いずれかの設定が必要です。未設定でもエラーにはなりませんが、この仕様は変更になる可能性があります。  
      *2：3Dセキュア認証で利用するためには<span class="mp-oas-code">phones.type</span>、<span class="mp-oas-code">phones.countryCode</span>、<span class="mp-oas-code">phones.number</span>の3つ全ての設定が必要です。<span class="mp-oas-code">phones.type</span>は<span class="mp-oas-code">MOBILE</span>/<span class="mp-oas-code">HOME</span>/<span class="mp-oas-code">WORK</span>のいずれかを設定してください。  
      *3：複数指定した場合は1番目の要素を使用します。  

      ## Pay払い

      ###  merchant
      ||PayPay|d払い|楽天ペイ(オンライン決済)V2|Amazon Pay V2|au PAY(ネット支払い)アプリ方式|メルペイ|Alipay|AEON Pay|
      |---|---|---|---|---|---|---|---|---|
      |name|-|決済画面、レシートメール、<br />利用明細に表示<br />※EUC-JPで32byteを超える部分は切り捨てられます|-|-|-|-|決済画面に表示|-|
      |nameKana|-|-|-|-|-|-|-|-|
      |nameAlphabet|-|-|-|-|-|-|-|-|
      |nameShort|-|-|-|-|-|-|-|-|
      |contactName|-||-|-|-|-|-|-|
      |contactEmail|-|レシートメール、利用明細に表示|-|-|-|-|-|-|
      |contactUrl|-|レシートメール、利用明細に表示|-|-|-|-|-|-|
      |contactPhone|-|レシートメール、利用明細に表示|-|-|-|-|-|-|
      |contactOpeningHours|-|-|-|-|-|-|-|-|
      |stores.id|-|-|-|-|-|決済事業者での店舗判別に利用|-|-|
      |stores.name|-|-|-|-|-|決済事業者での店舗判別に利用|-|-|

      ###  order
      ||PayPay|d払い|楽天ペイ(オンライン決済)V2|Amazon Pay V2|au PAY(ネット支払い)アプリ方式|メルペイ|Alipay|AEON Pay|
      |---|---|---|---|---|---|---|---|---|
      |currency|-|-|-|-|-|-|-|-|
      |items.name|-|-|都度支払いでは楽天ペイ管理画面に表示 <sup>*2</sup><br />※セミコロンで連結して300桁を超えた場合、超えた要素は切り捨てられます<br />利用承諾では楽天ペイの認証画面および申込履歴上に表示|-|-|かんたん出品連携に利用<br />利用承諾のみメルカリアプリに表示 <br />※20桁を超える部分は切り捨てられます<br />※複数指定時は1番目の要素のみアプリに表示されます|-|-|
      |items.description|-|-|-|-|-|かんたん出品連携に利用<br />利用承諾のみメルカリアプリに表示<br />※複数指定時は1番目の要素のみアプリに表示されます|決済画面に表示 <sup>*2</sup>|-|
      |items.quantity|-|-|-|-|-|かんたん出品連携に利用|-|-|
      |items.type|-|-|-|-|-|-|-|-|
      |items.price|-|-|-|-|-|かんたん出品連携に利用|-|-|
      |items.category|-|-|-|-|-|かんたん出品連携に利用|-|-|
      |items.productId|-|-|-|-|-|かんたん出品連携に利用|-|-|
      |items.productCode|-|-|-|-|-|かんたん出品連携に利用|-|-|
      |transactionType|-|-|-|-|-|-|-|-|
      |shippingAddress.name|-|-|-|決済画面に表示、支払い保証ポリシーの検証に利用 <sup>*1</sup><br />※UTF-8で50byteを超える部分は切り捨てられます|-|-|-|-|
      |shippingAddress.line1|-|-|-| 決済画面に表示、支払い保証ポリシーの検証に利用 <sup>*1</sup>|-|-|-|-|
      |shippingAddress.line2|-|-|-|決済画面に表示、支払い保証ポリシーの検証に利用 <sup>*1</sup><br />※UTF-8で60byteを超える部分は切り捨てられます|-|-|-|-|
      |shippingAddress.line3|-|-|-|決済画面に表示、支払い保証ポリシーの検証に利用 <sup>*1</sup><br />※UTF-8で60byteを超える部分は切り捨てられます|-|-|-|-|
      |shippingAddress.city|-|-|-|決済画面に表示、支払い保証ポリシーの検証に利用 <sup>*1</sup>|-|-|-|-|
      |shippingAddress.state|-|-|-|決済画面に表示、支払い保証ポリシーの検証に利用 <sup>*1</sup>|-|-|-|-|
      |shippingAddress.postCode|-|-|-| 決済画面に表示、支払い保証ポリシーの検証に利用 <sup>*1</sup>|-|-|-|-|
      |shippingAddress.country|-|-|-|決済画面に表示、支払い保証ポリシーの検証に利用 <sup>*1</sup>|-|-|-|-|
      |billingAddress.name|-|-|-|-|-|-|-|-|
      |billingAddress.line1|-|-|-|-|-|-|-|-|
      |billingAddress.line2|-|-|-|-|-|-|-|-|
      |billingAddress.line3|-|-|-|-|-|-|-|-|
      |billingAddress.city|-|-|-|-|-|-|-|-|
      |billingAddress.state|-|-|-|-|-|-|-|-|
      |billingAddress.postCode|-|-|-|-|-|-|-|-|
      |billingAddress.country|-|-|-|-|-|-|-|-|

      *1：物販など住所情報を使用する場合(<span class="mp-oas-code">walletInformation.amazonPay.apbType</span>が<span class="mp-oas-code">PayAndShip</span>のとき)に利用します。  
      *2：複数指定した場合は1番目の要素を使用します。  

      ###  payer
      ||PayPay|d払い|楽天ペイ(オンライン決済)V2|Amazon Pay V2|au PAY(ネット支払い)アプリ方式|メルペイ|Alipay|AEON Pay|
      |---|---|---|---|---|---|---|---|---|
      |name|-|-|-|-|-|-|-|-|
      |nameKana|-|-|-|-|-|-|-|-|
      |nameAlphabet|-|-|-|-|-|-|-|-|
      |gender|-|-|-|-|-|-|-|-|
      |dateOfBirth|-|-|-|-|-|-|-|-|
      |email|-|-|-|-|-|-|-|-|
      |deliveryEmail|-|-|-|-|-|-|-|-|
      |phones.type|-|-|-|-|-|-|-|-|
      |phones.countryCode|-|-|-|-|-|-|-|-|
      |phones.number|-|-|-|決済画面に表示、支払い保証ポリシーの検証に利用 <sup>*1 *2</sup>|-|-|-|-|
      |accountId|-|-|-|-|-|-|-|-|
      |ip|-|-|-|-|-|-|-|-|
      |deviceType|-|-|-|-|-|-|-|-|
      |osType|-|-|-|-|-|-|<span class="mp-oas-code">transitionType</span>が<span class="mp-oas-code">APP_LINK</span>の場合、デバイスのOS判定に利用|-|
      |httpUserAgent|-|-|-|-|-|流入経路解析に利用|-|-|

      *1：物販など住所情報を使用する場合(<span class="mp-oas-code">walletInformation.amazonPay.apbType</span>が<span class="mp-oas-code">PayAndShip</span>のとき)に利用します。  
      *2：複数指定した場合は1番目の要素を使用します。

      ## 現金払い

      ###  merchant
      ||コンビニ決済|Pay-easy決済|銀行振込(バーチャル口座)|銀行振込(バーチャル口座 あおぞら)|マイペイメント|
      |---|---|---|---|---|---|
      |name|-|-|-|-|-|
      |nameKana|-|-|-|-|-|
      |nameAlphabet|-|-|-|-|-|
      |nameShort|-|-|-|-|-|
      |contactName|Loppi・ファミリーマートのマルチ<br />コピー機支払い後の受領書に表示<br />※EUC-JPで42byteを超える部分は切り捨てられます|-|-|-|-|
      |contactEmail|-|-|-|-|-|
      |contactUrl|-|-|-|-|バーコード表示URLに表示される<br />「請求元からのお知らせ」の遷移先です|
      |contactPhone|Loppi・ファミリーマートのマルチ<br />コピー機支払い後の受領書に表示|-|-|-|-|
      |contactOpeningHours|Loppi・ファミリーマートのマルチ<br />コピー機支払い後の受領書に表示|-|-|-|-|
      |stores.id|-|-|-|-|-|
      |stores.name|-|-|-|-|-|

      ###  order
      ||コンビニ決済|Pay-easy決済|銀行振込(バーチャル口座)|銀行振込(バーチャル口座 あおぞら)|マイペイメント|
      |---|---|---|---|---|---|
      |currency|-|-|-|-|-|
      |items.name|-|-|振込依頼メールに表示<sup>*1</sup><br />※EUC-JPで64byteを超える部分は切り捨てられます|振込依頼メールに表示<sup>*1</sup><br />※64桁を超える部分は切り捨てられます|バーコード表示URLに表示<br />※SJISで30byteを超える部分は切り捨てられます|
      |items.description|-|-|-|-|-|
      |items.quantity|-|-|-|-|-|
      |items.type|-|-|-|-|-|
      |items.price|-|-|-|-|-|
      |items.category|-|-|-|-|-|
      |items.productId|-|-|-|-|-|
      |items.productCode|-|-|-|-|-|
      |transactionType|-|-|-|-|-|
      |shippingAddress.name|-|-|-|-|-|
      |shippingAddress.line1|-|-|-|-|-|
      |shippingAddress.line2|-|-|-|-|-|
      |shippingAddress.line3|-|-|-|-|-|
      |shippingAddress.city|-|-|-|-|-|
      |shippingAddress.state|-|-|-|-|-|
      |shippingAddress.postCode|-|-|-|-|-|
      |shippingAddress.country|-|-|-|-|-|
      |billingAddress.name|-|-|-|-|-|
      |billingAddress.line1|-|-|-|-|-|
      |billingAddress.line2|-|-|-|-|-|
      |billingAddress.line3|-|-|-|-|-|
      |billingAddress.city|-|-|-|-|-|
      |billingAddress.state|-|-|-|-|-|
      |billingAddress.postCode|-|-|-|-|-|
      |billingAddress.country|-|-|-|-|-|

      *1：複数指定した場合は1番目の要素を使用します。  

      ####  payer
      ||コンビニ決済|Pay-easy決済|銀行振込(バーチャル口座)|銀行振込(バーチャル口座 あおぞら)|マイペイメント|
      |---|---|---|---|---|---|
      |name|支払い画面、払込票に表示<br />※EUC-JPで40byteを超える部分は切り捨てられます|ATM画面、利用明細に表示<br />※EUC-JPで40byteを超える部分は切り捨てられます|振込依頼メールに表示|振込依頼メールに表示|-|
      |nameKana|-|-|-|-|-|
      |nameAlphabet|-|-|-|-|-|
      |gender|-|-|-|-|-|
      |dateOfBirth|-|-|-|-|-|
      |email|「コンビニ決済お支払番号のお知らせ」メール送信先|「Pay-easy決済お支払番号のお知らせ」メール送信先|振込依頼メール送信先|振込依頼メール送信先|「マイペイメント バーコード表示URLのご案内」メール送信先|
      |deliveryEmail|-|-|-|-|-|
      |phones.type|-|-|-|-|-|
      |phones.countryCode|-|-|-|-|-|
      |phones.number|ファミリーマートのレシートにマスク表示<sup>*1</sup>|利用明細に表示<sup>*1</sup>|-|-|-|
      |accountId|-|-|-|-|-|
      |ip|-|-|-|-|-|
      |deviceType|-|-|-|-|-|
      |httpUserAgent|-|-|-|-|-|

      *1：複数指定した場合は1番目の要素を使用します。  

      ## 後払い

      ###  order
      ||アトカラ|
      |---|---|
      |items.name|明細項目として審査に利用|
      |items.description|-|
      |items.quantity|明細項目として審査に利用|
      |items.type|-|
      |items.price|明細項目として審査に利用|
      |items.category|明細項目として審査に利用|
      |items.productId|-|
      |items.productCode|-|
      |transactionType|-|
      |shippingAddress.name|配送先情報として審査に利用|
      |shippingAddress.line1|配送先情報として審査に利用<sup>*1</sup>|
      |shippingAddress.line2|配送先情報として審査に利用<sup>*1</sup>|
      |shippingAddress.line3|配送先情報として審査に利用<sup>*1</sup><br />配送先の会社名として審査に利用|
      |shippingAddress.city|配送先情報として審査に利用<sup>*1</sup>|
      |shippingAddress.state|配送先情報として審査に利用<sup>*1</sup>|
      |shippingAddress.postCode|配送先情報として審査に利用|
      |shippingAddress.country|-|
      |billingAddress.name|-|
      |billingAddress.line1|購入者情報として審査に利用<sup>*2</sup>|
      |billingAddress.line2|購入者情報として審査に利用<sup>*2</sup>|
      |billingAddress.line3|購入者情報として審査に利用<sup>*2</sup><br />購入者の会社名として審査に利用|
      |billingAddress.city|購入者情報として審査に利用<sup>*2</sup>|
      |billingAddress.state|購入者情報として審査に利用<sup>*2</sup>|
      |billingAddress.postCode|購入者情報として審査に利用|
      |billingAddress.country|-|

      *1：state(都道府県コードから日本語名称に変換),city,line1,line2,line3を連結して配送先の住所として利用する。  
      *2：state(都道府県コードから日本語名称に変換),city,line1,line2,line3を連結して購入者の住所として利用する。

      ###  payer
      ||アトカラ|
      |---|---|
      |name|購入者情報として審査に利用|
      |nameKana|購入者情報として審査に利用|
      |nameAlphabet|-|
      |gender|購入者情報として審査に利用|
      |dateOfBirth|購入者情報として審査に利用|
      |email|購入者情報として審査に利用|
      |deliveryEmail|-|
      |phones.type|-|
      |phones.countryCode|-|
      |phones.number|購入者情報として審査に利用|
      |accountId|購入者情報として審査に利用|
      |ip|-|
      |deviceType|-|
      |osType|-|
      |httpUserAgent|-|
  - name: changelog
    x-displayName: 変更履歴
    description: |
      ## ＡＰＩリファレンスバージョン

      ### v1.13.0 - 2026-03-17
      - クレカ払い 都度支払い、クレカ払い 随時支払いのForter利用時に設定するEnterprise加盟店様のリクエストに<span class="mp-oas-code">fraudDetectionInformation.fraudDetectionForterData.additionalIdentifiers</span>を追加しました。
      - クレカ払い 都度支払い、クレカ払い 随時支払いのレスポンス<span class="mp-oas-code">fraudDetectionResult.screeningType</span>に<span class="mp-oas-code">FORTER</span>を追加しました。
      - Pay払い 購入者情報取得のレスポンスに<span class="mp-oas-code">shippingInformation.city</span>を追加しました。

      ### v1.12.0 - 2026-02-17
      - Webhook Pay払い決済結果通知に対応する決済手段を追加しました。
      - Webhook 利用承諾結果通知を追加しました。
      - Pay払い 処理シーケンス「都度支払い」と「随時支払いのための利用承諾」のシーケンスにWebhook通知を追記しました。

      ### v1.11.0 - 2026-01-20
      - Alipayを本番環境で利用可能になる時期を**2026年1月以降**から**調整中**に変更しました
      - 海外住所を指定できるよう、 <span class="mp-oas-code">shippingAddress.state</span>、<span class="mp-oas-code">shippingAddress.city</span>、<span class="mp-oas-code">shippingAddress.postCode</span>　
      <span class="mp-oas-code">billingAddress.state</span>、<span class="mp-oas-code">billingAddress.city</span>、<span class="mp-oas-code">billingAddress.postCode</span>の書式、説明を修正しました。
        - クレジットカード(3Dセキュア認証利用時)、クレジットカード(Red Shiled利用時)において指定することができます。
      - Pay払い 都度支払いで、決済事業者へのリダイレクト方式が指定可能な決済手段にau PAY(ネット支払い)アプリ方式、メルペイを追加しました。
      - Pay払い 利用承諾リクエストに<span class="mp-oas-code">walletAuthorizationInformation.walletAuthorizationOptions.transitionType</span>を追加しました。  
      メルペイを利用する際に設定することで、決済事業者へのリダイレクト方式を指定することができます。　
      - 現金払い 支払い番号発行の<span class="mp-oas-code">cashInformation.cashOptions</span>に<span class="mp-oas-code">useRecurringAccount</span>を追加しました。
      - クレカ払い 都度支払い、クレカ払い 有効性確認、クレカ払い カード登録で、<span class="mp-oas-code">GOOGLE_PAY_TOKEN</span>を利用する際に、カード名義人が指定できるようになりました。<span class="mp-oas-code">creditInformation.tokenizedCard.cardholderName</span>に指定した名前が利用できます。

      ### v1.10.0 - 2025-11-26
      - 予定している変更セクションの2025-07-23の内容を適用し、記載を削除しました。
        - 現金払い 支払い番号発行の
        <span class="mp-oas-code">cashOptions.paymentExpiryDateTime</span>(支払い期限日時)で時間単位・分単位での指定ができなくなりました。  
        HHMM部分は切り捨てられて、指定した日付の23:59までが支払い期限となります。
        - 取引管理 キャンセルでPay-easy決済の取引をキャンセルすることができなくなりました。
        - 現金払いの支払い期間(日)<span class="mp-oas-code">paymentPeriod</span>パラメーター、支払い期限日時<span class="mp-oas-code">cashInformation.cashOptions.paymentExpiryDateTime</span>パラメーターの<span class="mp-oas-code">PAYEASY</span>の説明を修正しました。
      - Pay払い 利用承諾リクエストに<span class="mp-oas-code">additionalOptions.acceptType</span>を追加しました。
      - Pay払い 随時支払いリクエストに<span class="mp-oas-code">additionalOptions.paymentType</span>を追加しました。

      ### v1.9.1 - 2025-11-04
      - クレカ払いの処理シーケンス「不正検知（Forter利用時）」に、<span class="mp-oas-code">connectionInformation.forterTokenCookie</span>に関する説明を追記しました。
      - <span class="mp-oas-code">connectionInformation.forterTokenCookie</span>の説明を改善しました。
      - クレカ払い 都度支払い、クレカ払い 随時支払いのForter利用時に設定するBasic加盟店様向けのパラメーターに、<span class="mp-oas-code">connectionInformation</span>プロパティの説明を追記しました。

      ### v1.9.0 - 2025-10-07
      - クレジットカード決済に不正な取引を検知するサービス「Forter」を設定できる機能を追加しました。
        - クレカ払いに処理シーケンス「不正検知（Forter利用時）」を追加しました。OpenAPIタイプで「Forter」を利用するフローが確認できます。
        - クレカ払い 都度支払い、クレカ払い 随時支払いの<span class="mp-oas-code">fraudDetectionInformation.fraudDetectionOptions.screeningType</span>に<span class="mp-oas-code">FORTER</span>を追加しました。  
          <span class="mp-oas-code">fraudDetectionInformation.fraudDetectionForterData</span>を追加しました。Forter向けのパラメーターを定義しています。  
          <span class="mp-oas-code">fraudDetectionInformation.fraudDetectionOptions.screeningType</span>に<span class="mp-oas-code">FORTER</span>を設定して、<span class="mp-oas-code">fraudDetectionInformation.fraudDetectionForterData</span>を設定することでForterを利用できます。  
        - 共通パラメーター表に「Forter」の列を追加しました。「Forter」で利用する共通パラメーターを確認できます。

      ### v1.8.4 - 2025-10-06
      - 会員管理の認証情報削除APIリクエストサンプルについて、<span class="mp-oas-code">onfileType</span>の設定値を修正しました。
      - 決済手段「メルペイ」を利用する場合の制限事項について、不足していた説明を追記しました。  
        <span class="mp-oas-code">merchant.stores.id</span>、<span class="mp-oas-code">merchant.stores.name</span>は両方指定するか、両方未指定である必要があります。
        - 対象のAPI: Pay払い 都度支払い、Pay払い 都度支払い（フロントエンド方式）、Pay払い 随時支払い、Pay払い 利用承諾

      ### v1.8.3 - 2025-09-30
      - Alipayを本番環境で利用可能になる時期を**2025年8月以降**から**2026年1月以降**に変更しました
      - AEON Payを随時支払いで利用可能になる時期を**2026年3月以降**と明記しました

      ### v1.8.2 - 2025-09-24
      - 取引管理の照会APIのレスポンスに<span class="mp-oas-code">konbiniPaymentInformation.storeCode</span>を追加。お客様がお支払いしたコンビニ店舗を特定可能な「店舗コード」を確認できるようになりました。

      ### v1.8.1 - 2025-07-23
      - クレカ払いの都度支払い、随時支払い、有効性確認で、HTTPステータスコードが<span class="mp-oas-code">201</span>,<span class="mp-oas-code">202</span>でレスポンスが異なるため、OpenAPI Generatorで生成されたAPI実行メソッドが処理できない問題を回避するための対応を行いました。  
      この変更はOpenAPI Specificationの定義の変更であり、APIの動作に影響はありません。
        - クレカ払い 都度支払いのレスポンスに<span class="mp-oas-code">creditResult</span>、<span class="mp-oas-code">fraudDetectionResult</span>、<span class="mp-oas-code">redirectInformation</span>を追加しました。
        - クレカ払い 随時支払いのレスポンスに<span class="mp-oas-code">creditResult</span>、<span class="mp-oas-code">fraudDetectionResult</span>、<span class="mp-oas-code">redirectInformation</span>を追加しました。
        - クレカ払い 有効性確認のレスポンスに<span class="mp-oas-code">creditResult</span>、<span class="mp-oas-code">onfileCardResult</span>、<span class="mp-oas-code">redirectInformation</span>を追加しました。
      - 予定している変更セクションを追加しました。将来的な仕様変更がある場合はこのセクションに記載されます。

      ### v1.8.0 - 2025-06-24
      - 現金払い 支払い番号発行の<span class="mp-oas-code">cashType</span>に<span class="mp-oas-code">MYPAYMENT</span>を追加
      - Webhook 現金払い完了通知に現金払い支払い取消を追加
      - <span class="mp-oas-code">merchant.stores</span>を追加

      ### v1.7.0 - 2025-05-27
      - Pay払い 都度支払いの<span class="mp-oas-code">WalletType</span>に<span class="mp-oas-code">AEON</span>を追加。AEON Payによる決済に対応
      - Webhook Pay払い決済結果通知を追加。AEON Payの決済結果をWebhookで受け取ることができるようになりました。
      - 支払いタイプ後払いを追加して、決済手段「アトカラ」による決済に対応しました。
        - 後払い 出荷報告、後払い 出荷取消、後払い 出荷変更、後払い 取引変更の4APIを追加
        - Webhook アトカラ与信結果通知を追加。アトカラ取引登録で行われた与信結果をWebhookで受け取ることができるようになりました。
        - <span class="mp-oas-code">orderReference.chargeType</span>には<span class="mp-oas-code">DEFERRED</span>(後払い)が追加。
        - アトカラの決済では<span class="mp-oas-code">deferredpayInformation.deferredpayType</span>に<span class="mp-oas-code">ATOKARA</span>(アトカラ)を指定します。

      ### v1.6.2 - 2025-03-18
      - <span class="mp-oas-code">allowAttempt</span>の説明を修正
      - <span class="mp-oas-code">enableDuplicationCheck</span>の説明を修正

      ### v1.6.1 - 2025-02-25
      - リクエスト・レスポンスパラメーターの説明を改善
        - <span class="mp-oas-code">cashInformation.cashOptions.paymentPeriod</span>の説明を修正
        - <span class="mp-oas-code">shippingAddress.line1</span>、<span class="mp-oas-code">shippingAddress.line2</span>、<span class="mp-oas-code">shippingAddress.line3</span>の説明を修正
      - 共通パラメーター表の説明を追加
        - <span class="mp-oas-code">payer.phones</span>、<span class="mp-oas-code">order.items</span>などオブジェクトの配列で複数の要素が設定された場合に制限があるパラメーターについて説明を追加

      ### v1.6.0 - 2025-01-29
      - Pay払い 都度支払いの<span class="mp-oas-code">WalletType</span>に<span class="mp-oas-code">ALIPAY</span>を追加
      - Pay払い 都度支払いのリクエストに購入者のデバイスのOS<span class="mp-oas-code">osType</span>、Pay払いの決済事業者へのリダイレクト方式 <span class="mp-oas-code">transitionType</span> を追加
      - レスポンスパラメーターのサンプルにおける<span class="mp-oas-code">cardNumber</span>の誤りを修正
      - 表記揺れの修正、用語の統一

      ### v1.5.2 - 2024-11-25
      - <span class="mp-oas-code">merchant.contactEmail</span>スキーマを必須パラメータから任意パラメータに変更
      - <span class="mp-oas-code">amount</span>スキーマの正規表現パターンを追加
      - 表記揺れを修正し、「返す」「戻す」「返却」を「返る」に統一

      ### v1.5.1 - 2024-10-21
      - <span class="mp-oas-code">MemberId</span>と<span class="mp-oas-code">accountId</span>スキーマの正規表現パターンを修正
      - <span class="mp-oas-code">VerificationId</span>、<span class="mp-oas-code">csrfToken</span>、<span class="mp-oas-code">OrderId</span>、<span class="mp-oas-code">userId</span>、<span class="mp-oas-code">jws</span>スキーマの正規表現パターンを改善
      - <span class="mp-oas-code">useTds2</span>と<span class="mp-oas-code">skipNotEnrolledCard</span>プロパティの説明を明確化
      - <span class="mp-oas-code">ClientCardBinData</span>プロパティの説明にあるリンクを修正
      - スキーマをすべて展開するよう変更し、ページ上の検索機能を無効化

      ### v1.5.0 - 2024-09-24
      - 本人確認APIを追加
      - Pay払い 都度支払い（フロントエンド方式）APIを追加
      - 各APIのレスポンスパラメーター<span class="mp-oas-code">OrderReference</span>のスキーマ定義を変更
      - 同時接続数の制限の説明を追加
      - セキュリティのIPアドレス制限に関する説明を追加
      - 冪等処理の説明を改善
      - APIの認証のアクセストークン方式に関する説明を改善
      - リクエスト・レスポンスパラメーターの説明を改善
      - 表記揺れの修正、用語の統一

      ### v1.4.0 - 2024-08-19
      - クレカ払い 随時支払い、クレカ払い 有効性確認のリクエストにカード名義人<span class="mp-oas-code">cardholderName</span>パラメーターを追加
      - クレカ払いの各APIのレスポンスにカード名義人<span class="mp-oas-code">cardholderName</span>パラメーターを追加
      - パラメーターの設定、Webhook通知の説明を改善
      - クレカ払いの処理シーケンスを分かりやすいように用語を改善
      - 表記揺れの修正、用語の統一

      ### v1.3.2 - 2024-07-30
      - 決済手段ごとの制約を各パラメータの説明に追記
      - <span class="mp-oas-code">payer.nameAlphabet</span>の書式を修正
      - <span class="mp-oas-code">order.clientField1</span>、<span class="mp-oas-code">order.clientField2</span>、<span class="mp-oas-code">order.clientField3</span>の最大長を修正
      - Pay払いの都度支払い、利用承諾のレスポンス<span class="mp-oas-code">redirectInformation</span>にリダイレクトの時限を追記
      - 現金払い支払い完了通知の説明を追記
      - 共通パラメーター表の記載場所を変更
      - 共通パラメーター表に一部パラメーターは切り捨てて連携する説明を追記
      - 変更履歴のフォーマットを修正

      ### v1.3.1 - 2024-06-10
      - Pay払いの購入者情報取得のレスポンス<span class="mp-oas-code">shippingInformation.line1</span>、<span class="mp-oas-code">shippingInformation.line2</span>、<span class="mp-oas-code">shippingInformation.line3</span>の項目名及びレスポンスサンプルを修正
      - テスト環境申し込みページのURLを変更

      ### v1.3.0 - 2024-05-27
      - 分かりやすい表現、名称に変更
      - プロトコルタイプ/モジュールタイプからの移行にカード登録に関する説明を追加
      - HTTPステータスコードの<span class="mp-oas-code">409</span>と<span class="mp-oas-code">503</span>に関する説明を追加、また<span class="mp-oas-code">409</span>は各APIのresponsesに記載
      - テストカード番号の説明を追加
      - 3Dセキュア認証の必須パラメーターについて説明を追加
      - <span class="mp-oas-code">cardNumber</span>の桁数を20→16に変更
      - 取引管理のキャンセルAPIのレスポンス<span class="mp-oas-code">orderReference.status</span>に、<span class="mp-oas-code">STOP</span>を追加
      - 会員管理の認証情報削除APIに、楽天ペイ(オンライン決済)V2利用不可の説明を追加
      - <span class="mp-oas-code">orderId</span>に関する説明を追加

      ### v1.2.3 - 2024-04-16
      - クレカ払いの有効性確認、カード登録にカード番号重複チェック機能を追加
      - クレカ払いにカード詳細情報取得APIを追加
      - 取引管理の照会APIにオーダーIDパラメーターを追加
      - お問い合わせの多い事項について説明を追加

      ### v1.2.2 - 2024-03-18
      - HTTPステータスコードの説明を追加
      - Pay払い 都度支払い、Pay払い 利用承諾、現金払い 支払い番号発行の支払い手続きエラーHTTPステータスコード誤りを修正
      - セキュリティスキーマ<span class="mp-oas-code">パスワード方式</span>、<span class="mp-oas-code">アクセストークン方式</span>を<span class="mp-oas-code">Passward</span>、<span class="mp-oas-code">AccessToken</span>に変更
      - numberやintegerだがmaxLengthを指定していたフィールド<span class="mp-oas-code">order.items.quantity</span>、<span class="mp-oas-code">Tds2Information.tds2Data.nbPurchaseAccount</span>、<span class="mp-oas-code">Tds2Information.tds2Data.provisionAttemptsDay</span>、<span class="mp-oas-code">Tds2Information.tds2Data.txnActivityDay</span>、<span class="mp-oas-code">Tds2Information.tds2Data.txnActivityYear</span>、<span class="mp-oas-code">Tds2Information.tds2Data.giftCardAmount</span>、<span class="mp-oas-code">Tds2Information.tds2Data.giftCardCount</span>をmaximumに修正

      ### v1.2.1 - 2024-01-30
      - <span class="mp-oas-code">walletInformation.amazonPay</span>、<span class="mp-oas-code">walletAuthorizationInformation.amazonPay</span>に<span class="mp-oas-code">noteToBuyer</span>、<span class="mp-oas-code">apbType</span>を追加
      - <span class="mp-oas-code">walletOnfileInformation</span>に<span class="mp-oas-code">amazonPay</span>を追加

      ### v1.2.0 - 2023-12-20
      - 文言の修正
      - APIの認証にアクセストークン方式を追加、アクセストークンAPIを追加
      - クレカ払いのカード情報トークン化の説明追加
      - Pay払い随時支払いにau PAY(ネット支払い)アプリ方式を追加
      - 現金払いの支払い期間(日)<span class="mp-oas-code">paymentPeriod</span>パラメーターの機能拡張、支払い期限日時<span class="mp-oas-code">cashInformation.cashOptions.paymentExpiryDateTime</span>パラメーターを追加
      - 金額変更の対応表を修正
      - Pay払い購入者情報取得APIのレスポンスパラメーターの説明追加
      - ページ内のリンクはブラウザの別タブを開かないよう変更

      ### v1.1.2 - 2023-10-31
      - クレカ払い、Pay払い、現金払いに共通パラメーターの説明を追加

      ### v1.1.1 - 2023-09-26
      - <span class="mp-oas-code">order.items.description</span>の最大長を120⇒180byteに変更
      - <span class="mp-oas-code">fraudDetectionInformation.fraudDetectionData.userId</span>の桁数を16→60に変更
      - エラーの情報の説明を修正

      ### v1.1.0 - 2023-08-22
      - 文言の修正
      - クレカ払いに不正検知パラメーターを追加
      - 取引管理の照会APIのレスポンスに<span class="mp-oas-code">fraudDetectionResult</span>、<span class="mp-oas-code">bankTransferPaymentInformation.depositAmount</span>、<span class="mp-oas-code">bankTransferPaymentInformation.bankTransferCode</span>を追加
      - Pay払い利用承諾の<span class="mp-oas-code">walletAuthorizationInformation</span>を修正
      - カード情報にブランド<span class="mp-oas-code">brand</span>を追加
      - カード番号のマスク書式を修正
      - <span class="mp-oas-code">order.items</span>に<span class="mp-oas-code">description</span>,<span class="mp-oas-code">productCode</span>を追加
      - <span class="mp-oas-code">payer</span>に<span class="mp-oas-code">gender</span>,<span class="mp-oas-code">dateOfBirth</span>を追加
      - 現金払い支払い番号発行の<span class="mp-oas-code">registerDisplay1~8</span>、<span class="mp-oas-code">receiptDisplay1~10</span>の説明を追記

      ### v1.0.2 - 2023-07-25
      - 文言の修正
      - プロトコルタイプ/モジュールタイプからの移行の注意点を追加
      - バージョン管理の説明を追加
      - オーダーID<span class="mp-oas-code">orderId</span>の書式を修正
      - 現金払いの支払期限日数<span class="mp-oas-code">paymentPeriod</span>、POSレジ表示欄<span class="mp-oas-code">registerDisplay1~8</span>、明細表示欄<span class="mp-oas-code">receiptDisplay1~10</span>の書式を修正
      - 金額変更の支払い要求タイプ<span class="mp-oas-code">authorizationMode</span>からrequiredを削除、説明を追加
      - 「TLS通信の暗号スイート」メニュー名を「セキュリティ」に変更、説明を追加

      ### v1.0.1 - 2023-06-06
      - 文言の修正
      - クレカ払いの支払い要求タイプ<span class="mp-oas-code">authorizationMode</span>から簡易オーソリ<span class="mp-oas-code">SAUTH</span>を削除
      - APIバージョンの説明を追加

      ### v1.0.0 - 2023-05-30
      - 初版

      <br />
      <br />

      ## ＡＰＩバージョン

      ### 2023-06 - 2023-05-30
      - 初回リリース

  - name: scheduled-changes
    x-displayName: 予定している変更
    description: |+
      OpenAPIタイプで今後予定されている仕様変更について記載します。  
      見出しは追記した日付を記載しています。



paths:
  /payment/CreateToken.json:
    post:
      security: []
      tags:
        - card-token-v2
      deprecated: false
      operationId: create-token
      summary: MPクレカトークン発行
      description: |
        クレジットカードのカード番号・有効期限等をトークン化し、**MPクレカトークン**を発行します。  
        発行されたトークンを決済APIに渡すことで、加盟店様サーバーでカード情報を保持せずに決済処理が可能です。  
        カード情報のトークン化については、[トークン決済v2 概要](/mulpay/docs/developer-support/sdk/overview)を参照してください。  
         <br />
         ※Apple Pay、Google PayのトークンはこのAPIでは発行できません。
      servers:
        - url: https://stg.token.mul-pay.jp
          description: PGマルチペイメントサービス トークン決済v2 テスト環境
        - url: https://token.mul-pay.jp
          description: PGマルチペイメントサービス トークン決済v2 本番環境
      requestBody:
        description: ''
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createTokenRequest'
      responses:
        '200':
          x-summary: 成功
          description: |
            MPクレカトークンの発行が成功したときのレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createTokenResponse'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由によりトークン発行できない時のレスポンス  
            各項目の詳細は[エラー情報](#tag/apierrors)を参照ください。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/400Problem'
        '500':
          x-summary: 当サービス内部のシステムエラー
          description: |
            当サービスのシステムで予期せぬエラーが発生した時のレスポンス  
            各項目の詳細は[エラー情報](#tag/apierrors)を参照ください。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/500Problem'
  /token:
    post:
      tags:
        - access-token
      deprecated: false
      operationId: token
      summary: アクセストークン発行
      description: |
        アクセストークン方式の認証に利用するアクセストークンを発行するために呼び出すAPIです。  
        認証の詳細は[APIの認証](/mulpay/docs/connection-method/openapi-type/auth-security)を参照ください。
      servers:
        - url: https://stg.oauth.mul-pay.jp
          description: PGマルチペイメントサービス 認可サーバー テスト環境
        - url: https://oauth.mul-pay.jp
          description: PGマルチペイメントサービス 認可サーバー 本番環境
      security:
        - Password: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TokenRequest'
            examples:
              tokenRequestExample:
                $ref: '#/components/examples/tokenRequestExample'
      responses:
        '201':
          x-summary: アクセストークン発行成功
          description: |
            アクセストークン発行が成功した場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
              examples:
                tokenResponseExample:
                  $ref: '#/components/examples/tokenResponseExample'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りや該当取引のステータスが受付可能な状態でない等の理由により有効性確認リクエストを進められない場合のレスポンス  
            エラーの原因は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The parameter value is invalid.(grant_type)
                instance: /token
        '500':
          $ref: '#/components/responses/500Response'
  /credit/charge:
    post:
      tags:
        - creditcard
      deprecated: false
      operationId: creditCharge
      summary: 都度支払い
      description: |
        カード情報を都度設定して支払う場合に呼び出すAPIです。  
        Apple Pay、Google Payでのお支払いもこのAPIを利用します。  
        <span >※ApplePayでは3Dセキュアおよび不正検知のご利用ができません。</span>
        <br />
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          カード情報の設定方法は以下のいずれかです。  
          1. トークン化して設定    
              - MPクレカトークン  
                当サービス標準のカード情報トークンです。  
                詳細は[カード情報トークン化](/mulpay/docs/payment-method/credit/card/tokenization/)を参照ください。  

              - Apple Payトークン  
                Apple Payに対応した端末で取得したApple PayのPayment tokenをbase64エンコードした値です。  
                詳細は[Apple Pay開発ガイド](/mulpay/docs/payment-method/credit/applepay/dev-guide)を参照ください。  
                
              - Google Payトークン  
                Google Pay APIで取得したPayment tokenをbase64エンコードした値です。  
                当サービスが提供する<span class="mp-oas-code">MpToken.js</span>を利用してトークンを取得することができます。  
                詳細は[カード情報トークン化](/mulpay/docs/payment-method/credit/card/tokenization/)を参照ください。  
                Google Payに関する詳細は[デベロッパー向けドキュメント](https://developers.google.com/pay/api)を参照ください。  

          2. 直接設定  
          [PCI DSS](https://ja.wikipedia.org/wiki/PCI_DSS)の認定を得ている加盟店様のみが利用できます。  
          本番環境で利用するためにはお申し込みが必要です。  

          3Dセキュア認証利用時には、以下のカード会員の情報を必ず設定してください。  
          未設定でもエラーにはなりませんが、変更になる可能性があります。  
            - カード会員の名前  
              - トークン化して設定  
                MPクレカトークンの「カード名義人」が利用されます。  
                Google Payトークンの場合は、<span class="mp-oas-code">creditInformation.tokenizedCard.cardholderName</span>が利用されます。
              - 直接設定  
                <span class="mp-oas-code">creditInformation.card.cardholderName</span>が利用されます。  
            - カード会員のメールアドレスまたは電話番号  
              <span class="mp-oas-code">payer</span>に設定した値が利用されます。  
              詳細は[共通パラメーター対応表 - クレカ払い](/mulpay/apis/openapi-type/common-parameters#クレカ払い)を参照ください。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditChargeRequest'
      callbacks:
        callbackTds2Charge:
          $ref: '#/components/callbacks/callbackTds2Charge'
      responses:
        '201':
          x-summary: 支払い成功
          description: |
            - 3Dセキュアを利用せず、支払いが成功した場合
            - 仕向先カード会社が3Dセキュア認証に未対応のために、認証スキップして支払いが成功した場合
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditChargeResponse'
              examples:
                creditChargeResponseExample1:
                  summary: 仮売上
                  $ref: '#/components/examples/creditChargeResponseExample1'
                creditChargeResponseExample2:
                  summary: 即時売上
                  $ref: '#/components/examples/creditChargeResponseExample2'
        '202':
          x-summary: 3Dセキュアに進む
          description: |
            3Dセキュアを利用して認証処理に進む場合のレスポンス  
            リクエストパラメーターで自動オーソリが有効になっている場合、3Dセキュア認証後にオーソリをします。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditChargeTds2Response'
              examples:
                creditChargeTds2ResponseExample1:
                  summary: 3Dセキュア
                  $ref: '#/components/examples/creditChargeTds2ResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により、支払いリクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The parameter value is invalid.(order.amount)
                instance: /credit/charge
        '402':
          x-summary: 支払いエラー
          description: |
            オーソリ(信用照会)に進んだ後に、カード会社等の外部事業者から拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: card_declined
                detail: This card cannot be used for transactions.(G12)
                instance: /credit/charge
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /credit/on-file/charge:
    post:
      tags:
        - creditcard
      deprecated: false
      operationId: creditOnfileCharge
      summary: 随時支払い
      description: |
        登録されているカード情報を使って支払う場合に呼び出すAPIです。  
        対応している決済手段はクレジットカード、Apple Payです。  
        ただしVISAブランドのカード番号が登録されたApple Payはご利用になれません。  
        また、VISA以外のブランドについても、将来的に利用できなくなる可能性があります。  
        <span >※ApplePayでは3Dセキュアおよび不正検知のご利用ができません。</span>  
        Google Payについては、アカウント情報を当サービスに保管できません。  
        都度支払い時にGoogle Payで使用されたクレジットカード情報を保管することで、通常のクレジットカードとして随時支払いが利用可能です。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          カードのタイプは<span class="mp-oas-code">creditOnfileInformation.onfileCard.type</span>で設定します。  
          プロトコルタイプとは異なりカード登録連番を物理モードで設定できません。  

          3Dセキュア認証利用時には、以下のカード会員の情報を必ず設定してください。  
          未設定でもエラーにはなりませんが、変更になる可能性があります。  
          - カード会員の名前  
            リクエストパラメーター<span class="mp-oas-code">creditOnfileInformation.onfileCard.cardholderName</span>が設定されている場合は、その値が利用されます。  
            設定されていない場合は、登録されているカード情報の「カード名義人」が利用されます。  
            カードの登録については、[有効性確認(/credit/verifyCard)](/mulpay/apis/openapi-type/credit-verify-card)、[カード登録(/credit/storeCard)](/mulpay/apis/openapi-type/credit-store-card)を参照ください。
          - カード会員のメールアドレスまたは電話番号  
            <span class="mp-oas-code">payer</span>に設定した値が利用されます。  
          詳細は[共通パラメーター対応表 - クレカ払い](/mulpay/apis/openapi-type/common-parameters#クレカ払い)を参照ください。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditOnfileChargeRequest'
      callbacks:
        callbackTds2Charge:
          $ref: '#/components/callbacks/callbackTds2Charge'
      responses:
        '201':
          x-summary: 支払い成功
          description: |
            - 3Dセキュアを利用せず、支払いが成功した場合
            - 仕向先カード会社が3Dセキュア認証に未対応のために、認証スキップして支払いが成功した場合
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditChargeResponse'
              examples:
                creditChargeResponseExample1:
                  summary: 仮売上
                  $ref: '#/components/examples/creditChargeResponseExample1'
                creditChargeResponseExample2:
                  summary: 即時売上
                  $ref: '#/components/examples/creditChargeResponseExample2'
        '202':
          x-summary: 3Dセキュアに進む
          description: |
            3Dセキュアを利用して認証処理に進む場合のレスポンス  
            リクエストパラメーターで自動オーソリが有効になっている場合、3Dセキュア認証後にオーソリをします。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditChargeTds2Response'
              examples:
                creditChargeTds2ResponseExample1:
                  summary: 3Dセキュア
                  $ref: '#/components/examples/creditChargeTds2ResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により支払いリクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: Incorrect card number or payment method.
                instance: /credit/on-file/charge
        '402':
          x-summary: 支払いエラー
          description: |
            オーソリ(信用照会)に進んだ後に、カード会社等の外部事業者から拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed due to incorrect security code.(G44)
                instance: /credit/on-file/charge
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /tds2/finalizeCharge:
    post:
      tags:
        - creditcard
      deprecated: false
      operationId: tds2FinalizeCharge
      summary: 3Dセキュア後の支払い
      description: |
        3Dセキュアに進んだ後に最終的に支払いをするためのAPIです。  
        Chargeリクエスト時に自動オーソリなしの場合には、コールバック後にこのAPIで支払いを完了してください。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          対象の取引のID
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tds2FinalizeChargeRequest'
      responses:
        '201':
          x-summary: 支払い成功
          description: |
            3Dセキュアの認証が成功してオーソリ(信用照会)に進み、支払いが成功した場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tds2FinalizeChargeResponse'
              examples:
                creditTds2FinalizeChargeResponseExample1:
                  summary: 仮売上
                  $ref: '#/components/examples/creditTds2FinalizeChargeResponseExample1'
                creditTds2FinalizeChargeResponseExample2:
                  summary: 即時売上
                  $ref: '#/components/examples/creditTds2FinalizeChargeResponseExample2'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りや該当取引のステータスが受付可能な状態でない等の理由により支払いリクエストを進められない場合のレスポンス  
            エラーの原因は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_status
                detail: The transaction has already been processed.
                instance: /tds2/finalizeCharge
        '402':
          x-summary: 認証/支払いエラー
          description: |
            3Dセキュアの結果、認証が成功しなかった場合のレスポンス、もしくは3Dセキュアは成功し、オーソリ(信用照会)に進んだ後に、カード会社等の外部事業者から拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://mp-faq.gmo-pg.com/s/article/F00941
                title: processing_failure
                detail: 3D secure authentication failed.
                instance: /tds2/finalizeCharge
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /credit/verifyCard:
    post:
      tags:
        - creditcard
      deprecated: false
      operationId: creditVerifyCard
      summary: 有効性確認
      description: |
        カード情報の有効性確認をするためのAPIです。    
        加えて有効性の確認が取れたカード情報を会員に紐づけて登録できます。  
        利用可能な決済手段はクレジットカード、Google Payであり、**Apple Payは利用できません。**  
        Google Payは通常のクレジットカードとして会員に紐づけて登録します。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          カード情報の設定方法は以下のいずれかです。  
          1. トークン化して設定  
              - MPクレカトークン  
                当サービス標準のカード情報トークンです。  
                詳細は[カード情報トークン化](/mulpay/docs/payment-method/credit/card/tokenization/)を参照ください。  

              - Google Payトークン  
                Google Pay APIで取得したPayment tokenをbase64エンコードした値です。  
                当サービスが提供する<span class="mp-oas-code">MpToken.js</span>を利用してトークンを取得することができます。  
                詳細は[カード情報トークン化](/mulpay/docs/payment-method/credit/card/tokenization/)を参照ください。  
                Google Payに関する詳細は[デベロッパー向けドキュメント](https://developers.google.com/pay/api)を参照ください。  

          2. 登録済み情報を設定  
          登録されているカード情報を利用します。  
          対象の会員IDが必要です。  

          3. 直接設定  
          [PCI DSS](https://ja.wikipedia.org/wiki/PCI_DSS)の認定を得ている加盟店様のみが利用できます。  
          本番環境で利用するためにはお申し込みが必要です。

          3Dセキュア認証利用時には、以下のカード会員の情報を必ず設定してください。  
          未設定でもエラーにはなりませんが、変更になる可能性があります。  
            - カード会員の名前  
              - トークン化して設定  
                MPクレカトークンの「カード名義人」が利用されます。  
                Google Payトークンの場合は、<span class="mp-oas-code">creditVerificationInformation.tokenizedCard.cardholderName</span>が利用されます。
              - 登録済み情報を設定  
                リクエストパラメーター<span class="mp-oas-code">creditVerificationInformation.onfileCard.cardholderName</span>が設定されている場合は、その値が利用されます。  
                設定されていない場合は、登録されているカード情報の「カード名義人」が利用されます。
              - 直接設定  
                <span class="mp-oas-code">creditVerificationInformation.card.cardholderName</span>が利用されます。
            - カード会員のメールアドレスまたは電話番号  
              <span class="mp-oas-code">payer</span>に設定した値が利用されます。
              詳細は[共通パラメーター対応表 - クレカ払い](/mulpay/apis/openapi-type/common-parameters#クレカ払い)を参照ください。

          有効性確認後にカード情報を会員に紐づけて登録した場合、設定した「カード名義人」が登録されます。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditVerifyCardRequest'
      callbacks:
        callbackTds2Verification:
          $ref: '#/components/callbacks/callbackTds2Verification'
      responses:
        '201':
          x-summary: 有効性確認成功
          description: |
            - 3Dセキュアを利用せず、有効性確認が成功した場合
            - 仕向先カード会社が3Dセキュア認証に未対応のために、認証スキップした場合
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditVerifyCardResponse'
              examples:
                creditVerifyCardResponseExample1:
                  summary: カード登録あり
                  $ref: '#/components/examples/creditVerifyCardResponseExample1'
                creditVerifyCardResponseExample2:
                  summary: カード登録なし
                  $ref: '#/components/examples/creditVerifyCardResponseExample2'
        '202':
          x-summary: 3Dセキュアに進む
          description: |
            3Dセキュアを利用して認証処理に進む場合のレスポンス  
            リクエストパラメーターで自動オーソリが有効になっている場合、3Dセキュア認証後にオーソリをします。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditVerifyCardTds2Response'
              examples:
                creditVerifyCardTds2ResponseExample1:
                  summary: 3Dセキュア
                  $ref: '#/components/examples/creditVerifyCardTds2ResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により有効性確認リクエストを進められない場合のレスポンス  
            エラーの原因は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: missing_parameter
                detail: Missing required request parameters.
                instance: /credit/verifyCard
        '402':
          x-summary: 有効性確認エラー
          description: |
            オーソリ(信用照会)に進んだ後に、カード会社等の外部事業者から拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: card_declined
                detail: This card cannot be used for transactions.(G12)
                instance: /credit/verifyCard
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /tds2/finalizeVerification:
    post:
      tags:
        - creditcard
      deprecated: false
      operationId: tds2FinalizeVerification
      summary: 3Dセキュア後の有効性確認
      description: |
        3Dセキュア認証に進んだ後に最終的に有効性確認とカード登録をするためのAPIです。  
        有効性リクエスト時に自動オーソリなしの場合には、コールバック後にこのAPIで処理を完了してください。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          対象の取引のID
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tds2FinalizeVerificationRequest'
      responses:
        '201':
          x-summary: 有効性確認成功
          description: |
            3Dセキュアの認証が成功してオーソリ(信用照会)に進み、有効性確認が成功した場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tds2FinalizeVerificationResponse'
              examples:
                creditTds2FinalizeVerificationResponseExample1:
                  summary: カード登録あり
                  $ref: '#/components/examples/creditTds2FinalizeVerificationResponseExample1'
                creditTds2FinalizeVerificationResponseExample2:
                  summary: カード登録なし
                  $ref: '#/components/examples/creditTds2FinalizeVerificationResponseExample2'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りや該当取引のステータスが受付可能な状態でない等の理由により有効性確認リクエストを進められない場合のレスポンス  
            エラーの原因は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_status
                detail: The transaction data does not exist.
                instance: /tds2/finalizeVerification
        '402':
          x-summary: 認証/有効性確認エラー
          description: |
            3Dセキュアの結果、認証が成功しなかった場合のレスポンス、もしくは3Dセキュアは成功し、オーソリ(信用照会)に進んだ後に、カード会社等の外部事業者から拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://mp-faq.gmo-pg.com/s/article/D00923
                title: processing_failure
                detail: 3D secure authentication failed.
                instance: /tds2/finalizeVerification
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /credit/storeCard:
    post:
      tags:
        - creditcard
      deprecated: false
      operationId: creditStoreCard
      summary: カード登録
      description: |
        カード情報を会員に紐づけて登録するためのAPIです。  
        Apple Pay、Google Payでのカード登録もこのAPIを利用します。  
        Apple Payは「成功した取引を設定」する方法のみに対応してます。  
        Google Payは、通常のクレジットカードとして会員に紐づけて登録します。  
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          カード情報の設定方法は以下のいずれかです。  
          1. 成功した取引を設定  
          成功した支払いや有効性確認時に返る取引ID<span class="mp-oas-code">accessId</span>を設定することで、該当の取引で利用されたカード情報を登録します。  

          2. トークン化して設定  
              - MPクレカトークン  
                当サービス標準のカード情報トークンです。  
                詳細は[カード情報トークン化](/mulpay/docs/payment-method/credit/card/tokenization/)を参照ください。  

              - Google Payトークン  
                Google Pay APIで取得したPayment tokenをbase64エンコードした値です。  
                当サービスが提供する<span class="mp-oas-code">MpToken.js</span>を利用してトークンを取得することができます。  
                詳細は[カード情報トークン化](/mulpay/docs/payment-method/credit/card/tokenization/)を参照ください。  
                Google Payに関する詳細は[デベロッパー向けドキュメント](https://developers.google.com/pay/api)を参照ください。  

          3. 直接設定  
          [PCI DSS](https://ja.wikipedia.org/wiki/PCI_DSS)の認定を得ている加盟店様のみが利用できます。  
          本番環境で利用するためにはお申し込みが必要です。  

          登録したカード情報で3Dセキュア認証をする場合、「カード名義人」を含めて登録する必要があります。  
          - 成功した取引を設定  
            該当の取引で設定した「カード名義人」が登録されます。  
          - トークン化して設定  
            MPクレカトークンの「カード名義人」が登録されます。  
            Google Payトークンの場合は、<span class="mp-oas-code">creditStoringInformation.tokenizedCard.cardholderName</span>が利用されます。
          - 直接設定  
            <span class="mp-oas-code">creditStoringInformation.card.cardholderName</span>が登録されます。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditStoreCardRequest'
      responses:
        '201':
          x-summary: カード登録成功
          description: |
            カードの登録が成功した場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditStoreCardReponse'
              examples:
                creditStoreCardResponseExample1:
                  $ref: '#/components/examples/creditcreditStoreCardResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤り等の理由によりカード登録リクエストを進められない場合のレスポンス  
            エラーの原因は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(orderid)
                instance: /credit/storeCard
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /credit/getCardDetails:
    post:
      tags:
        - creditcard
      deprecated: false
      operationId: creditGetCardDetails
      summary: カード詳細情報取得
      description: |
        カードの詳細情報を取得するためのAPIです。  
        「MPクレカトークン」または「会員ID＋カードID」から紐づいたカード情報を取得します。  

        #### 制限事項
        - 利用可能な決済手段はクレジットカードのみです。  
        - 本番環境で利用するためには、オプション契約が必要です。  
          プロトコルタイプ/モジュールタイプとは異なり、「会員ID＋カードID」を指定する場合でも、本APIを呼び出すショップIDに契約が必要です。  
        - テスト環境で利用する場合、事前に機能の有効化が必要です。  
          有効化の方法は、こちらの[FAQページ](https://mp-faq.gmo-pg.com/s/article/F00127)を参照ください。
      requestBody:
        description: |
          カード情報の設定方法は以下のいずれかです。  
          1. トークン化して設定  
              - MPクレカトークン  
                当サービス標準のカード情報トークンです。  
                本APIではトークンを利用しても無効化されず、支払いAPIで同じMPクレカトークンを設定できます。  
                詳細は[カード情報トークン化](/mulpay/docs/payment-method/credit/card/tokenization/)を参照ください。

          2. 登録済み情報を設定  
          登録されているカード情報を利用します。  
          対象の会員IDが必要です。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditGetCardDetailsRequest'
      responses:
        '200':
          x-summary: 成功
          description: |
            カード詳細情報取得が正常に返る場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditGetCardDetailsResponse'
              examples:
                creditGetCardDetailsResponseExample1:
                  $ref: '#/components/examples/creditGetCardDetailsResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤り等の理由によりカード詳細情報取得リクエストを進められない場合のレスポンス  
            エラーの原因は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(token)
                instance: /credit/getCardDetails
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /wallet/charge:
    post:
      tags:
        - wallet
      deprecated: false
      operationId: walletCharge
      summary: 都度支払い
      description: |
        都度のお手続きをしてPay払いで支払う場合に呼び出すAPIです。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          どのPay払いを利用するかは<span class="mp-oas-code">walletInformation.walletType</span>で設定します。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletChargeRequest'
      callbacks:
        callbackWalletCharge:
          $ref: '#/components/callbacks/callbackWalletCharge'
      responses:
        '202':
          x-summary: Pay払いの決済事業者にリダイレクトする
          description: |
            Pay払いの決済事業者が提供するWebサイトやモバイルアプリにリダイレクトして支払い手続きに進む場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletChargeResponse'
              examples:
                walletChargeResponseExample1:
                  $ref: '#/components/examples/walletChargeResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により支払いリクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(orderId)
                instance: /wallet/charge
        '402':
          x-summary: 支払い手続きエラー
          description: |
            Pay払いの決済事業者への支払い開始手続き処理で何らかのエラーが返り、リダイレクトに進めない場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /wallet/charge
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /wallet/front-end/charge:
    post:
      tags:
        - wallet
      deprecated: false
      operationId: walletFrontendCharge
      summary: 都度支払い（フロントエンド方式）
      description: |
        決済事業者画面への遷移なく、加盟店様の画面上で都度支払いを行う場合に呼び出すAPIです。  
        現時点ではPay払いタイプ<span class="mp-oas-code">PAYPAY</span>（[PayPayスマートペイメント](https://developer.paypay.ne.jp/products/docs/smartpayment)）のみ利用可能です。  
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          どのPay払いを利用するかは<span class="mp-oas-code">walletFrontendInformation.walletType</span>で設定します。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletFrontendChargeRequest'
      responses:
        '202':
          x-summary: 決済番号（フロントエンド利用）の払い出し成功
          description: |
            加盟店様画面上でのPay払い手続きに必要な情報を払い出すことに成功した場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletFrontendChargeResponse'
              examples:
                walletFrontendChargeResponseExample1:
                  $ref: '#/components/examples/walletFrontendChargeResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により支払いリクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(orderId)
                instance: /wallet/front-end/charge
        '401':
          x-summary: 支払い手続きエラー
          description: |
            Pay払いの決済事業者にて拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /wallet/front-end/charge
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /wallet/front-end/verifyCharge:
    post:
      tags:
        - wallet
      deprecated: false
      operationId: walletFrontendVerifyCharge
      summary: 支払い後検証（フロントエンド方式）
      description: |
        都度支払い（フロントエンド方式）の取引を検証するためのAPIです。  
        現時点ではPay払いタイプ<span class="mp-oas-code">PAYPAY</span>（[PayPayスマートペイメント](https://developer.paypay.ne.jp/products/docs/smartpayment)）のみ利用可能です。  
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          どのPay払いを利用するかは<span class="mp-oas-code">walletFrontendInformation.walletType</span>で設定します。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletFrontendVerifyChargeRequest'
      responses:
        '201':
          x-summary: 支払い後検証成功
          description: |
            支払い後の検証が成功した場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletFrontendVerifyChargeResponse'
              examples:
                walletFrontendChargeResponseExample1:
                  summary: 仮売上
                  $ref: '#/components/examples/walletFrontendVerifyChargeResponseExample1'
                walletOnfileChargeResponseExample2:
                  summary: 即時売上
                  $ref: '#/components/examples/walletFrontendVerifyChargeResponseExample2'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により支払いリクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(jws)
                instance: /wallet/front-end/verifyCharge
        '402':
          x-summary: 支払い後検証エラー
          description: |
            Pay払いの決済事業者にて拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /wallet/front-end/verifyCharge
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /wallet/on-file/charge:
    post:
      tags:
        - wallet
      deprecated: false
      operationId: walletOnfileCharge
      summary: 随時支払い
      description: |
        事前に承認済の認証情報を使ってPay払いで支払う場合に呼び出すAPIです。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          どのPay払いを利用するかは<span class="mp-oas-code">walletOnfileInformation.onfileWallet</span>で設定します。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletOnfileChargeRequest'
      responses:
        '201':
          x-summary: 支払い成功
          description: |
            Pay払いの決済事業者にて支払いが成功した場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletOnfileChargeResponse'
              examples:
                walletOnfileChargeResponseExample1:
                  summary: 仮売上
                  $ref: '#/components/examples/walletOnfileChargeResponseExample1'
                walletOnfileChargeResponseExample2:
                  summary: 即時売上
                  $ref: '#/components/examples/walletOnfileChargeResponseExample2'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により支払いリクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(orderId)
                instance: /wallet/on-file/charge
        '402':
          x-summary: 支払いエラー
          description: |
            Pay払いの決済事業者にて拒否された場合のレスポンス    
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /wallet/on-file/charge
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /wallet/authorizeAccount:
    post:
      tags:
        - wallet
      deprecated: false
      operationId: walletAuthorizeAccount
      summary: 利用承諾
      description: |
        随時決済のための利用承諾手続き時に呼び出すAPIです。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          どのPay払いを利用するかは<span class="mp-oas-code">walletInformation.walletType</span>で設定します。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletAuthorizationRequest'
      callbacks:
        callbackWalletApproval:
          $ref: '#/components/callbacks/callbackWalletApproval'
      responses:
        '202':
          x-summary: Pay払いの決済事業者にリダイレクトする
          description: |
            Pay払いの決済事業者が提供するWebサイトやモバイルアプリにリダイレクトして利用承諾手続きに進む場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletAuthorizationResponse'
              examples:
                walletAuthorizeAccountResponseExample1:
                  $ref: '#/components/examples/walletAuthorizeAccountResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により利用承諾リクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(orderId)
                instance: /wallet/authorizeAccount
        '402':
          x-summary: 支払い手続きエラー
          description: |
            Pay払いの決済事業者への利用承諾開始手続き処理にて何らかのエラーが返り、リダイレクトに進めない場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /wallet/authorizeAccount
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /wallet/getCustomerData:
    post:
      tags:
        - wallet
      deprecated: false
      operationId: walletGetCustomerData
      summary: 購入者情報取得
      description: |
        決済事業者で保持している購入者情報を取得するためのAPIです。  
        現時点ではAmazon Pay V2のみ利用可能です。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/walletGetCustomerDataRequest'
      responses:
        '200':
          x-summary: 成功
          description: |
            購入者情報が正常に返る場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletGetCustomerDataResponse'
              examples:
                walletGetCustomerDataResponseExample1:
                  $ref: '#/components/examples/walletGetCustomerDataResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りや対象取引の状態などの理由により照会処理ができない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /order/inquiry
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /cash/charge:
    post:
      tags:
        - cash
      deprecated: false
      operationId: cashCharge
      summary: 支払い番号発行
      description: |
        コンビニ決済や銀行振込などの現金払いでのお支払い時に利用するAPIです。  
        支払いの結果は、非同期で加盟店様がリクエスト時に設定した[Webhook URLにHTTPメソッド<span class="mp-oas-code">POST</span>で通知](/mulpay/apis/openapi-type/cash-webhook)します。  
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          どの現金払いを利用するかは<span class="mp-oas-code">cashInformation.cashType</span>で設定します。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CashChargeRequest'
      responses:
        '202':
          x-summary: 支払い番号払い出し成功
          description: |
            現金での支払い手続きに必要な情報が払い出された場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashChargeResponse'
              examples:
                cashChargeResponseExample1:
                  summary: コンビニ決済
                  $ref: '#/components/examples/cashChargeResponseExample1'
                cashChargeResponseExample2:
                  summary: Pay-easy
                  $ref: '#/components/examples/cashChargeResponseExample2'
                cashChargeResponseExample3:
                  summary: 銀行振込(バーチャル口座)
                  $ref: '#/components/examples/cashChargeResponseExample3'
                cashChargeResponseExample4:
                  summary: 銀行振込(バーチャル口座 あおぞら)
                  $ref: '#/components/examples/cashChargeResponseExample4'
                cashChargeResponseExample5:
                  summary: マイペイメント
                  $ref: '#/components/examples/cashChargeResponseExample5'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により番号払い出しリクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(orderId)
                instance: /cash/charge
        '402':
          x-summary: 支払い手続きエラー
          description: |
            決済事業者への番号払い出し手続き処理にて何らかのエラーが返る場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /cash/charge
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /deferredpay/shipping:
    post:
      tags:
        - deferredpay
      deprecated: false
      operationId: deferredpayShipping
      summary: 出荷報告
      description: |
        出荷報告時に利用します。  
        アトカラの場合は、[アトカラ取引登録](/mulpay/docs/payment-method/deferredpay/atokara/register)を実行後、  
        与信審査が完了してステータスが<span class="mp-oas-code">AUTH</span>(仮売上)になったら利用できます。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          どの後払いを利用するかは<span class="mp-oas-code">deferredpayInformation.deferredpayType</span>で設定します。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deferredpayShippingRequest'
      responses:
        '201':
          x-summary: 出荷報告成功
          description: |
            出荷報告が成功したときのレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deferredpayShippingResponse'
              examples:
                deferredpayShippingResponseExample1:
                  summary: 後払い
                  $ref: '#/components/examples/deferredpayShippingResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により出荷報告リクエストを進められない時のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /deferredpay/shipping
        '402':
          x-summary: 出荷報告エラー
          description: |
            決済事業者への出荷報告処理にて何らかのエラーが返る時のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: unauthorized_request
                detail: The request is unauthorized.
                instance: /deferredpay/shipping
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /deferredpay/shippingCancel:
    post:
      tags:
        - deferredpay
      deprecated: false
      operationId: deferredpayShippingCancel
      summary: 出荷取消
      description: |
        出荷報告を取消する時に利用します。   
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deferredpayShippingCancelRequest'
      responses:
        '201':
          x-summary: 出荷取消成功
          description: |
            出荷取消が成功したときのレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deferredpayShippingCancelResponse'
              examples:
                deferredpayShippingCancelResponseExample1:
                  summary: 後払い
                  $ref: '#/components/examples/deferredpayShippingCancelResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により出荷取消リクエストを進められない時のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /deferredpay/shippingCancel
        '402':
          x-summary: 出荷取消エラー
          description: |
            決済事業者への出荷取消処理にて何らかのエラーが返る時のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: unauthorized_request
                detail: The request is unauthorized.
                instance: /deferredpay/shippingCancel
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /deferredpay/shippingUpdate:
    post:
      tags:
        - deferredpay
      deprecated: false
      operationId: deferredpayShippingUpdate
      summary: 出荷変更
      description: |
        出荷情報を変更する時に利用します  
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deferredpayShippingUpdateRequest'
      responses:
        '201':
          x-summary: 出荷変更成功
          description: |
            出荷変更が成功したときのレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deferredpayShippingUpdateResponse'
              examples:
                deferredpayShippingUpdateResponseExample1:
                  summary: 後払い
                  $ref: '#/components/examples/deferredpayShippingUpdateResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により出荷変更リクエストを進められない時のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /deferredpay/shippingUpdate
        '402':
          x-summary: 出荷変更エラー
          description: |
            決済事業者への出荷変更処理にて何らかのエラーが返る時のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: unauthorized_request
                detail: The request is unauthorized.
                instance: /deferredpay/shippingUpdate
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /deferredpay/orderUpdate:
    post:
      tags:
        - deferredpay
      deprecated: false
      operationId: deferredpayOrderUpdate
      summary: 取引変更
      description: |
        すでに支払い済みの取引の情報を変更します。  
        後払いでは、[金額変更API(/order/update)](/mulpay/apis/openapi-type/order-update)を利用せず、金額変更の場合も当APIを利用します。また金額を変更しない場合も<span class="mp-oas-code">amount</span>は必須です。
        <br />
        取引状態により変更可能な項目が異なります。それぞれ変更可能な項目は以下の通りです。<br /><br />
        <span class="mp-oas-code">status</span>が <span class="mp-oas-code">AUTH</span>の場合<br />
        - **配送先情報**  
        <span class="mp-oas-code">shppingAddress</span>,<span class="mp-oas-code">atokaraInformation.shippingNameKana</span>, <span class="mp-oas-code">atokaraInformation.shippingDepartmentName</span>,<span class="mp-oas-code">atokaraInformation.shippingPhone</span><br />
        - **購入者情報**  
        <span class="mp-oas-code">billingAddress</span>,<span class="mp-oas-code">atokaraInformation.payerDepartmentName</span>, <span class="mp-oas-code">atokaraInformation.payerSecondaryEmail</span><br />
        - **明細情報**  
        <span class="mp-oas-code">items</span>,<span class="mp-oas-code">atokaraInformation.brands.name</span><br />
        - **金額**  
        <span class="mp-oas-code">amount</span><br />

        <span class="mp-oas-code">status</span>が <span class="mp-oas-code">SALES</span>,<span class="mp-oas-code">CAPTURE</span>の場合<br />
        - **明細情報**  
        <span class="mp-oas-code">items</span>,<span class="mp-oas-code">atokaraInformation.brands.name</span><br />
        - **金額**  
        <span class="mp-oas-code">amount</span> ※増額不可<br /><br />

        共通項目(<span class="mp-oas-code">items</span>,<span class="mp-oas-code">shippingAddress</span>,<span class="mp-oas-code">billingAddress</span>)で利用する項目は  
        詳細は[共通パラメーター対応表 - 後払い](/mulpay/apis/openapi-type/common-parameters#後払い)を参照ください。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deferredpayOrderUpdateRequest'
      responses:
        '201':
          x-summary: 取引変更成功
          description: |
            取引変更が成功したときのレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deferredpayOrderUpdateResponse'
              examples:
                deferredpayOrderUpdateResponseExample1:
                  summary: 後払い
                  $ref: '#/components/examples/deferredpayOrderUpdateResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により取引変更リクエストを進められない時のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /deferredpay/orderUpdate
        '402':
          x-summary: 取引変更エラー
          description: |
            決済事業者への取引変更処理にて何らかのエラーが返る時のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: unauthorized_request
                detail: The request is unauthorized.
                instance: /deferredpay/orderUpdate
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /order/capture:
    post:
      tags:
        - order
      deprecated: false
      operationId: orderCapture
      summary: 確定
      description: |
        決済確定のためのAPIです。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderCaptureRequest'
      responses:
        '201':
          x-summary: 確定成功
          description: |
            取引の確定が成功した場合のレスポンス
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/OrderCaptureResponseCredit'
                  - $ref: '#/components/schemas/OrderCaptureResponseWallet'
              examples:
                orderCaptureCreditResponseExample1:
                  summary: クレカ払い
                  $ref: '#/components/examples/orderCaptureCreditResponseExample1'
                orderCaptureWalletResponseExample1:
                  summary: Pay払い
                  $ref: '#/components/examples/orderCaptureWalletResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りや対象取引の状態などの理由により確定リクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /order/capture
        '402':
          x-summary: 確定エラー
          description: |
            外部事業者にて拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /order/capture
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /order/update:
    post:
      tags:
        - order
      deprecated: false
      operationId: orderUpdate
      summary: 金額変更
      description: |
        すでに支払い済みの取引の金額を変更します。また、一部の決済手段では  
        同じ金額を設定して呼び出すことで仮売上有効日時を延長できます。  

        **金額を変更する**  
        決済手段と取引状態により変更できる内容が異なります。  
        クレジットカードの場合は、当サービス内部で取消と再オーソリ(信用照会)の処理を実施します。  
        お客様の信用状態によっては、再オーソリ(信用照会)が失敗する場合があり、その場合は取消は無効となり金額変更APIを呼び出す前の状態に戻ります。  

        |||仮売上<br />の減額|仮売上<br />の増額|実売上<br />の減額|実売上<br />の増額|即時売上<br />の減額|即時売上<br />の増額|
        |:-------|:------------|:-:|:-:|:-:|:-:|:-:|:-:|
        |クレカ払い|クレジットカード  | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 |
        |         |Google Pay | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 |
        |         |Apple Pay  | △<sup>*1</sup> | △<sup>*1</sup> | △<sup>*1</sup> | △<sup>*1</sup> | △<sup>*1</sup> | △<sup>*1</sup> |
        |Pay払い  |PayPay     | × | × | 〇 | × | 〇 | × |
        |         |d払い      | × | × | 〇 | △<sup>*2</sup> | 〇 | △<sup>*2</sup> |
        |         |楽天ペイ(オンライン決済)V2 | 〇 | 〇 | 〇 | 〇 | 〇 | 〇 |
        |         |Amazon Pay V2 | 〇 | 〇 | 〇 | × | 〇 | × |
        |         |au PAY(ネット支払い)アプリ方式  | 〇 | 〇 | 〇 | × | 〇 | × |
        |         |Alipay    | × | × | × | × | 〇 | × |
        |         |メルペイ    | × | × | 〇 | × | 〇 | × |
        |         |AEON Pay    | × | × | × | × | 〇 | 〇 |
        |現金払い  |コンビニ   | × | × | × | × | × | × |
        |         |Pay-easy   | × | × | × | × | × | × |
        |         |銀行振込    | × | × | × | × | × | × |
        |         |マイペイメント<sup>*3</sup> | × | × | × | × | × | × |
        |後払い   |アトカラ<sup>*4</sup>   | × | × | × | × | × | × |

        ○：可能　△：条件付きで可能　✖：不可  

        *1：Visaブランドのカードは増額・減額ができません。  
        *2：減額した取引に限り、元取引金額までの決済金額の増額ができます。  
        *3：<span class="mp-oas-code">status</span> が <span class="mp-oas-code">REQSUCCESS</span> の取引に限り、金額変更ができます。  
        *4：[取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で金額変更ができます。

        **仮売上有効日時を延長する**  
        同じ金額を設定して呼び出すと、仮売上有効日時を延長できます。  
        対応している決済手段は以下の通りです。

        | | | 仮売上有効日時の延長 |
        | :---------- | :---------- | :----------: |
        | クレカ払い | クレジットカード | 〇 |
        | | Google Pay | × |
        | | Apple Pay | × |
        | Pay払い | PayPay | × |
        | | d払い | × |
        | | 楽天ペイ(オンライン決済)V2 | 〇 |
        | | Amazon Pay V2 | 〇 |
        | | au PAY(ネット支払い)アプリ方式 | × |
        | | Alipay | × |
        | | メルペイ | × |
        | | AEON Pay | × |
        | 現金払い | コンビニ | × |
        | | Pay-easy | × |
        | | 銀行振込 | × |
        | | マイペイメント | × |
        | 後払い | アトカラ | × |

        ○：可能　△：条件付きで可能　✖：不可  
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderUpdateRequest'
      responses:
        '201':
          x-summary: 金額変更成功
          description: |
            支払い金額の変更が成功した場合のレスポンス
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/OrderUpdateResponseCredit'
                  - $ref: '#/components/schemas/OrderUpdateResponseWallet'
                  - $ref: '#/components/schemas/OrderUpdateResponseCash'
              examples:
                orderUpdateCreditResponseExample1:
                  summary: クレカ払い(AUTH)
                  $ref: '#/components/examples/orderUpdateCreditResponseExample1'
                orderUpdateCreditResponseExample2:
                  summary: クレカ払い(CAPTURE)
                  $ref: '#/components/examples/orderUpdateCreditResponseExample2'
                orderUpdateWalletResponseExample1:
                  summary: Pay払い
                  $ref: '#/components/examples/oderUpdateWalletResponseExample1'
                orderUpdateCashResponseExample1:
                  summary: 現金払い
                  $ref: '#/components/examples/oderUpdateCashResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りや対象取引の状態などの理由により金額変更リクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /order/update
        '402':
          x-summary: 金額変更エラー
          description: |
            外部事業者にて拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /order/update
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /order/cancel:
    post:
      tags:
        - order
      deprecated: false
      operationId: orderCancel
      summary: キャンセル
      description: |
        支払いを取り消すためのAPIです。<br /><br />
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderCancelRequest'
      responses:
        '201':
          x-summary: キャンセル成功
          description: |
            支払いのキャンセルが成功した場合のレスポンス
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/OrderCancelResponseCredit'
                  - $ref: '#/components/schemas/OrderCancelResponseWallet'
                  - $ref: '#/components/schemas/OrderCancelResponseCash'
                  - $ref: '#/components/schemas/OrderCancelResponseDeferredpay'
              examples:
                orderCancelCreditResponseExample1:
                  summary: クレカ払い
                  $ref: '#/components/examples/orderCancelCreditResponseExample1'
                orderCancelWalletResponseExample1:
                  summary: Pay払い
                  $ref: '#/components/examples/orderCancelWalletResponseExample1'
                orderCancelCashResponseExample1:
                  summary: 現金払い
                  $ref: '#/components/examples/orderCancelCashResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りや対象取引の状態などの理由によりキャンセルリクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /order/cancel
        '402':
          x-summary: キャンセルエラー
          description: |
            外部事業者に拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /order/cancel
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /order/inquiry:
    post:
      tags:
        - order
      deprecated: false
      operationId: orderInquiry
      summary: 照会
      description: |
        取引を照会するためのAPIです。  
        accessIdとorderIdのどちらかは必ず設定してください。  
        accessIdとorderIdの両方を設定した場合は両方に一致する取引情報が返ります。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderInquiryRequest'
      responses:
        '200':
          x-summary: 成功
          description: |
            取引情報が正常に返る場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderInquiryResponse'
              examples:
                orderInquiryCreditResponseExample1:
                  summary: クレカ払い
                  $ref: '#/components/examples/orderInquiryCreditResponseExample1'
                orderInquiryWalletResponseExample1:
                  summary: Pay払い
                  $ref: '#/components/examples/orderInquiryWalletResponseExample1'
                orderInquiryCashResponseExample1:
                  summary: 現金払い
                  $ref: '#/components/examples/orderInquiryCashResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りや対象取引の状態などの理由により照会処理ができない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /order/inquiry
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /member/create:
    post:
      tags:
        - member
      deprecated: false
      operationId: memberCreate
      summary: ID登録
      description: |
        会員を登録するためのAPIです。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberCreateRequest'
      responses:
        '201':
          x-summary: 会員登録成功
          description: |
            会員の登録が成功した場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberCreateResponse'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により登録処理ができない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(memberId)
                instance: /member/create
        '500':
          $ref: '#/components/responses/500Response'
  /member/inquiry:
    post:
      tags:
        - member
      deprecated: false
      operationId: memberInquiry
      summary: 照会
      description: |
        会員情報を照会するためのAPIです。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberInquiryRequest'
      responses:
        '200':
          x-summary: 成功
          description: |
            会員情報が正常に返る場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberInquiryResponse'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により照会処理ができない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /member/inquiry
        '500':
          $ref: '#/components/responses/500Response'
  /member/delete:
    post:
      tags:
        - member
      deprecated: false
      operationId: memberDelete
      summary: 全削除
      description: |
        会員情報を削除するためのAPIです。  
        Pay払いの認証情報も含まれます。  
        一度削除した会員ID、認証情報は二度と利用できないため、ご注意ください。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberDeleteRequest'
      responses:
        '202':
          x-summary: 削除受け付け成功
          description: |
            会員の全情報削除のリクエストを受け付けた場合のレスポンス  
            Pay払いの認証情報は非同期処理で削除します。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberDeleteResponse'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により削除処理ができない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(memberId)
                instance: /member/delete
        '500':
          $ref: '#/components/responses/500Response'
  /member/deleteItem:
    post:
      tags:
        - member
      deprecated: false
      operationId: memberDeleteItem
      summary: 認証情報削除
      description: |
        会員に登録されている情報を削除するためのAPIです。  
        楽天ペイ(オンライン決済)V2ではご利用いただけません。
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/MemberDeleteItemRequestCard'
                - $ref: '#/components/schemas/MemberDeleteItemRequestWallet'
            examples:
              card:
                summary: カード
                value:
                  memberId: member-001
                  onfileType: CARD
                  onfileCardType: CREDIT_CARD
                  cardId: '0'
                  additionalOptions: {}
              wallet:
                summary: Pay払い利用承諾
                value:
                  memberId: member-001
                  onfileType: WALLET
                  onfileWalletType: PAYPAY
                  additionalOptions: {}
      responses:
        '201':
          x-summary: 削除成功
          description: |
            認証情報の削除が成功した場合のレスポンス
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/MemberDeleteItemResponseCard'
                  - $ref: '#/components/schemas/MemberDeleteItemResponseWallet'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により削除処理ができない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(memberId)
                instance: /member/deleteItem
        '402':
          x-summary: 削除エラー
          description: |
            外部事業者にて拒否された場合のレスポンス  
            詳細な理由は<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: processing_failure
                detail: Processing failed upstream.
                instance: /order/deleteItem
        '500':
          $ref: '#/components/responses/500Response'
        '502':
          $ref: '#/components/responses/502Response'
  /verification/start:
    post:
      tags:
        - verify
      deprecated: false
      operationId: verificationStart
      summary: 認証開始
      description: |
        認証開始時に呼び出すAPIです。
        <br />
      parameters:
        - $ref: '#/components/parameters/headerIdempotencyKey'
      requestBody:
        description: |
          どの認証方法を利用するかは<span class="mp-oas-code">verificationInformation.type</span>で設定します。
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerificationStartRequest'
      callbacks:
        callbackVerificationStart:
          $ref: '#/components/callbacks/callbackVerificationStart'
      responses:
        '202':
          x-summary: 認証コード入力画面に進む
          description: |
            認証開始が成功した場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationStartResponse'
              examples:
                verificationStartResponseExample1:
                  summary: 本人確認
                  $ref: '#/components/examples/verificationStartResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により認証リクエストを進められない場合のレスポンス  
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The parameter value is invalid.(verificationInformation.verificationId)
                instance: /verification/start
        '409':
          $ref: '#/components/responses/409Response'
        '500':
          $ref: '#/components/responses/500Response'
  /verification/inquiry:
    post:
      tags:
        - verify
      deprecated: false
      operationId: verificationInquiry
      summary: 照会
      description: |
        認証情報を照会するためのAPIです。  
        accessIdとverificationIdのどちらかは必ず設定してください。  
        accessIdとverificationIdの両方を設定した場合は両方に一致する取引情報が返ります。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerificationInquiryRequest'
      responses:
        '200':
          x-summary: 成功
          description: |
            認証情報が正常に返る場合のレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationInquiryResponse'
              examples:
                verificationInquiryResponseExample1:
                  summary: 本人確認
                  $ref: '#/components/examples/verificationInquiryResponseExample1'
        '400':
          x-summary: リクエストパラメーターエラー
          description: |
            パラメーターの誤りなどの理由により照会処理ができない場合のレスポンス    
            エラーの原因と該当のパラメーター名は、<span class="mp-oas-code">detail</span>フィールドで確認できます。
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                title: invalid_parameter
                detail: The value provided for parameter is invalid.(accessId)
                instance: /order/inquiry
        '500':
          $ref: '#/components/responses/500Response'
x-webhooks:
  cashWebhook:
    post:
      summary: 現金払い完了通知
      operationId: cashWebhook
      tags:
        - events
      security: []
      requestBody:
        description: |
          現金払い完了通知  
          お客様の支払いが完了または取消された際に通知します。  
          銀行振込では、同一取引に対して複数回の入金がされた場合、それぞれの入金ごとに通知します。  
          マイペイメントのみ、支払い完了後に取消となる場合があるため取消を通知します。  
          取引リクエスト時に加盟店様が設定したWebhookURLに以下のパラメーターを送信します。  
          Webhookの詳細については[結果通知（Webhook）](/mulpay/docs/developer-support/notification/overview)を参照ください。
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CashWebhookRequest'
      responses:
        2xx:
          description: 正常に処理をした後は、HTTPステータス200番台を返してください。レスポンスのボディは不要です。
  amazonPayCancelWebhook:
    post:
      summary: Amazon Pay V2キャンセル結果通知
      operationId: amazonPayCancelWebhook
      tags:
        - events
      security: []
      requestBody:
        description: |
          Amazon Pay V2のキャンセル結果通知  
          Amazon Pay V2のキャンセルリクエストの結果を通知します。  
          取引リクエスト時に加盟店様が設定したWebhookURLに以下のパラメーターを送信します。  
          Webhookの詳細については[結果通知（Webhook）](/mulpay/docs/developer-support/notification/overview)を参照ください。
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AmazonPayCancelWebhookRequest'
      responses:
        2xx:
          description: 正常に処理をした後は、HTTPステータス200番台を返してください。レスポンスのボディは不要です。
  walletChargeWebhook:
    post:
      summary: Pay払い決済結果通知
      operationId: walletChargeWebhook
      tags:
        - events
      security: []
      requestBody:
        description: |
          Pay払いの決済結果通知  
          Pay払いでの決済結果を通知します。  
          取引リクエスト時に加盟店様が設定したWebhookURLに以下のパラメーターを送信します。  
          Webhookの詳細については[結果通知（Webhook）](/mulpay/docs/developer-support/notification/overview)を参照ください。  

          #### 対応している決済手段
          ・PayPay
          ・d払い
          ・楽天ペイ(オンライン決済)V2
          ・Amazon Pay V2
          ・au PAY(ネット払い)アプリ方式
          ・メルペイ
          ・Alipay
          ・AEON Pay
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletChargeWebhook'
      responses:
        2xx:
          description: 正常に処理をした後は、HTTPステータス200番台を返してください。レスポンスのボディは不要です。
  walletAcceptWebhook:
    post:
      summary: Pay払い利用承諾結果通知
      operationId: walletAcceptWebhook
      tags:
        - events
      security: []
      requestBody:
        description: |
          Pay払いの利用承諾結果通知  
          Pay払いでの利用承諾結果を通知します。  
          取引リクエスト時に加盟店様が設定したWebhookURLに以下のパラメーターを送信します。  
          Webhookの詳細については[結果通知（Webhook）](/mulpay/docs/developer-support/notification/overview)を参照ください。  

          #### 対応している決済手段
          ・PayPay
          ・d払い
          ・楽天ペイ(オンライン決済)V2
          ・Amazon Pay V2
          ・au PAY(ネット払い)アプリ方式
          ・メルペイ
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletAcceptWebhook'
      responses:
        2xx:
          description: 正常に処理をした後は、HTTPステータス200番台を返してください。レスポンスのボディは不要です。
  walletFrontendWebhook:
    post:
      summary: 都度支払い（フロントエンド方式）決済結果通知
      operationId: walletFrontendWebhook
      tags:
        - events
      security: []
      requestBody:
        description: |
          都度支払い（フロントエンド方式）の決済結果通知  
          都度支払い（フロントエンド方式）での決済結果を通知します。  
          基本的には決済結果通知が加盟店様に送信される前に[支払い後検証](/mulpay/apis/openapi-type/wallet-frontend-verify-charge)を実行した場合、この通知は送信されません。  
          ただし、[支払い後検証](/mulpay/apis/openapi-type/wallet-frontend-verify-charge)を行う処理のタイミングによっては通知が送信される場合があります。  
          取引リクエスト時に加盟店様が設定したURLに以下のパラメーターを送信します。  
          Webhookの詳細については[結果通知（Webhook）](/mulpay/docs/developer-support/notification/overview)を参照ください。  
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WalletFrontendWebhook'
      responses:
        2xx:
          description: 正常に処理をした後は、HTTPステータス200番台を返してください。レスポンスのボディは不要です。
  atokaraWebhook:
    post:
      summary: アトカラ与信結果通知
      operationId: atokaraWebhook
      tags:
        - events
      security: []
      requestBody:
        description: |
          アトカラ与信結果通知  
          アトカラでは[アトカラ取引登録](/mulpay/docs/payment-method/deferredpay/atokara/register)を行った後に、与信審査の結果を通知します。  
          [アトカラ取引登録](/mulpay/docs/payment-method/deferredpay/atokara/register)で加盟店様が設定したWenhookURLに以下のパラメーターを送信します。  
          詳細については[与信審査の仕組み](/mulpay/docs/payment-method/deferredpay/atokara/overview#与信審査の仕組み)を参照ください。  
          Webhookについては[結果通知（Webhook）](/mulpay/docs/developer-support/notification/overview)を参照ください。  
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtokaraWebhook'
      responses:
        2xx:
          description: 正常に処理をした後は、HTTPステータス200番台を返してください。レスポンスのボディは不要です。
components:
  securitySchemes:
    Password:
      type: http
      scheme: basic
      description: |
        詳細は[APIの認証](/mulpay/docs/connection-method/openapi-type/auth-security)を参照ください。
    AccessToken:
      type: oauth2
      description: |
        詳細は[APIの認証](/mulpay/docs/connection-method/openapi-type/auth-security)、[アクセストークン発行](/mulpay/apis/openapi-type/token)APIを参照ください。
      flows:
        clientCredentials:
          tokenUrl: 上記参照
          scopes:
            openapi: OpenAPIタイプ
  parameters:
    headerIdempotencyKey:
      name: Idempotency-Key
      in: header
      description: |
        冪等キー  
        リクエスト毎にユニークな最大36桁の任意の文字列。  
        詳細は[冪等処理](/mulpay/docs/connection-method/openapi-type/request-spec#idempotence)を参照ください。
      schema:
        type: string
        maxLength: 36
  schemas:
    createTokenRequest:
      description: トークン発行のリクエストパラメーター
      type: object
      required:
        - encryptionParameters
        - encryptedData
      properties:
        encryptionParameters:
          type: object
          description: |
            暗号化情報
          required:
            - type
            - apiKey
          properties:
            type:
              type: string
              description: |
                暗号化方式  
                <span class="mp-oas-code">UNIQUE_PK</span>を設定してください。
              enum:
                - UNIQUE_PK
              example: UNIQUE_PK
            apiKey:
              type: string
              format: byte
              description: |
                APIキー  
                トークン決済v2の[認証情報](/mulpay/docs/developer-support/sdk/overview#認証情報)であるAPIキーを設定します。  
                テスト環境、本番環境それぞれの管理画面で事前に登録します。
              example: xxxxxxxxxxxxxxxxx
        encryptedData:
          type: string
          description: |
            カード情報オブジェクト  
            カード情報を[作成ガイド](/mulpay/apis/openapi-type/encrypteddata)の方法で暗号化した値を設定してください。
          example: xxxxxxxxxxxxxxxxx
        createCount:
          type: string
          pattern: ^([1-9]|10)$
          maxLength: 2
          description: |
            MPクレカトークン発行数  
            発行するトークンの数を1～10の間で設定します。  
            省略時は<span class="mp-oas-code">"1"</span>です。
          example: '1'
          default: '1'
    createTokenResponse:
      type: object
      required:
        - result
        - maskedCardNumber
        - tokenExpiryDate
        - isSecurityCodeSet
        - tokenList
      properties:
        result:
          type: string
          enum:
            - success
          description: |
            処理結果
            成功時は必ず<span class="mp-oas-code">success</span>です。
          example: success
        maskedCardNumber:
          type: string
          description: |
            マスク済みカード番号  
            16桁のカード番号の場合は上6桁、下4桁以外の6桁をアスタリスクに置き換えた値です。  
            例) <span class="mp-oas-code">411111******1111</span>  
            16桁未満の場合、上桁の表示部が短くなります。  
            例) <span class="mp-oas-code">31111******1111</span>, <span class="mp-oas-code">3111******1111</span>
          example: 411111******1111
        tokenExpiryDate:
          type: string
          description: |
            MPクレカトークン有効期限  
            トークンの有効期限です。
            詳細は[トークンの有効期間](/mulpay/docs/developer-support/sdk/overview#トークンの有効期限)を参照ください。  
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された形式です。  
            例) 2024-05-28T12:34:56+09:00
          example: '2024-05-28T12:34:56+09:00'
        isSecurityCodeSet:
          type: boolean
          description: |
            セキュリティコード設定有無  
            セキュリティコードが設定されていた場合は<span class="mp-oas-code">true</span>を返却します。
          example: true
        tokenList:
          type: array
          description: |
            MPクレカトークン一覧
            <span class="mp-oas-code">createCount</span>で指定した数のトークン文字列の配列を返却します。
          items:
            type: string
            example: edf3dd725dcc9999f54bb61bc6b5db9001b48d93ceb8b7efdd546116f80af46e
    400Problem:
      type: object
      required:
        - result
        - errorList
      properties:
        result:
          description: |
            処理結果  
            処理結果を表します。
            - <span class="mp-oas-code">validation_error</span>：リクエストパラーメーターのチェックでエラーが発生
            - <span class="mp-oas-code">decryption_error</span>：カード情報オブジェクトの復号時にエラーが発生
          enum:
            - validation_error
            - decryption_error
          type: string
          example: validation_error
        errorList:
          type: array
          description: |
            エラー情報一覧
          items:
            type: object
            required:
              - title
              - detail
            properties:
              title:
                type: string
                maxLength: 32
                enum:
                  - missing_parameter
                  - invalid_parameter
                description: |
                  エラー内容サマリー  
                  エラーコードとして取り扱えます。
                  - <span class="mp-oas-code">missing_parameter</span>：必須パラメーターが設定されていません。
                  - <span class="mp-oas-code">invalid_parameter</span>：リクエストパラメーターの書式または桁数が不正です。
                example: missing_parameter
              field:
                type: string
                maxLength: 30
                description: |
                  エラーパラメーター  
                  エラーが発生したリクエストパラメーター名です。
                example: encryptionParameters.apiKey
              detail:
                type: string
                maxLength: 256
                description: |
                  エラー詳細  
                  エラーメッセージとして取り扱えます。全て英文です。
                example: Field parameter is invalid.
              legacyCode:
                type: string
                maxLength: 3
                description: |
                  処理結果コード  
                  一覧は[エラー情報](#tag/apierrors)を参照ください。
                  エラーの内容によっては値は返却されません。
                example: '100'
    500Problem:
      type: object
      required:
        - result
        - errorList
      properties:
        result:
          description: |
            処理結果  
            処理結果を表します。
            - <span class="mp-oas-code">system_error</span>：当サービスのシステムで予期せぬエラーが発生
          enum:
            - system_error
          type: string
          example: system_error
        errorList:
          type: array
          description: |
            エラー情報一覧
          items:
            type: object
            required:
              - title
              - detail
              - legacyCode
            properties:
              title:
                type: string
                maxLength: 32
                enum:
                  - internal_server_error
                description: |
                  エラー内容サマリー  
                  エラーコードとして取り扱えます。
                  - <span class="mp-oas-code">internal_server_error</span>：当サービスのサーバーで問題が発生したため、リクエストを処理できませんでした。
                example: internal_server_error
              detail:
                type: string
                maxLength: 256
                description: |
                  エラー詳細  
                  エラーメッセージとして取り扱えます。全て英文です。
                example: An internal server error has occurred.
              legacyCode:
                type: string
                pattern: ^[0-9]{3}$
                description: |
                  処理結果コード  
                  一覧は[エラー情報](#tag/apierrors)を参照ください。
                  エラーの内容によっては値は返却されません。
                example: '901'
    TokenRequest:
      description: アクセストークン発行(/token)のリクエストパラメーター
      type: object
      required:
        - grant_type
        - scope
      properties:
        grant_type:
          type: string
          description: |
            グラントタイプ  
            <span class="mp-oas-code">client_credentials</span>を設定してください。
          enum:
            - client_credentials
          example: client_credentials
        scope:
          type: string
          description: |
            スコープ
            <span class="mp-oas-code">openapi</span>を設定してください。
          enum:
            - openapi
          example: openapi
    TokenResponse:
      description: アクセストークン発行(/token)成功時のレスポンスパラメーター
      type: object
      properties:
        access_token:
          type: string
          maxLength: 68
          description: |
            アクセストークン  
        expires_in:
          type: string
          maxLength: 6
          default: '3600'
          description: |
            有効期間(秒)  
            アクセストークンの有効期間が秒数で返ります。
        scope:
          type: string
          description: |
            スコープ  
            <span class="mp-oas-code">openapi</span>が返ります。
          enum:
            - openapi
        token_type:
          type: string
          description: |
            アクセストークンのタイプ  
            <span class="mp-oas-code">bearer</span>が返ります。
          enum:
            - bearer
    CreditChargeRequest:
      description: クレカ払い 都度支払い(/credit/charge)のリクエストパラメーター
      type: object
      required:
        - merchant
        - order
        - payer
        - creditInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        order:
          $ref: '#/components/schemas/Order'
        payer:
          $ref: '#/components/schemas/Payer'
        creditInformation:
          $ref: '#/components/schemas/CreditInformation'
          description: クレカ払い情報
        tds2Information:
          $ref: '#/components/schemas/Tds2Information'
        fraudDetectionInformation:
          $ref: '#/components/schemas/FraudDetectionInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    CreditChargeResponse:
      description: クレカ払い 都度支払い・随時支払い(/credit/charge, /credit/on-file/charge)のオーソリ成功時のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            仮売上成功時は<span class="mp-oas-code">CAPTURE</span>、即時売上成功時は<span class="mp-oas-code">NO_ACTION</span>です。
            - <span class="mp-oas-code">CAPTURE</span>：確定処理が必要
            - <span class="mp-oas-code">NO_ACTION</span>：後続処理なし
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは以下の値が返ります。
                - 仮売上成功時: <span class="mp-oas-code">AUTH</span>
                - 即時売上成功時: <span class="mp-oas-code">CAPTURE</span>
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">CREDIT</span>です。
        creditResult:
          $ref: '#/components/schemas/CreditResult'
          description: クレカ払いの結果情報
        fraudDetectionResult:
          $ref: '#/components/schemas/FraudDetectionResult'
          description: |
            不正検知の結果情報  
            非同期モードが<span class="mp-oas-code">true</span>の場合は<span class="mp-oas-code">screeningType</span>のみが返ります。  
            ただし、Forter利用時は非同期モードによらずfraudDetectionResult配下のすべての項目が返ります。
        redirectInformation:
          $ref: '#/components/schemas/RedirectInformation'
          description: |
            リダイレクト情報  
            オーソリ成功時(HTTPステータスコードが201の時)は返りません。  
            [OpenAPI Generator](https://openapi-generator.tech/)のために追加しています。
    CreditChargeTds2Response:
      description: クレカ払い 都度支払い・随時支払い(/credit/charge, /credit/on-file/charge)の3Dセキュアリダイレクト時のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            3Dセキュアリダイレクト時は必ず<span class="mp-oas-code">REDIRECT</span>です。
            - <span class="mp-oas-code">REDIRECT</span>：リダイレクトが必要
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは、3Dセキュア開始前であるため<span class="mp-oas-code">AUTHENTICATED</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">CREDIT</span>です。
        redirectInformation:
          $ref: '#/components/schemas/RedirectInformation'
          description: |
            リダイレクト情報  
            3Dセキュアに進むためのリダイレクトの情報です。  
            <span class="mp-oas-code">redirectType</span>フィールドは必ず<span class="mp-oas-code">TDS2</span>です。  
            お客様のブラウザを<span class="mp-oas-code">redirectUrl</span>にリダイレクトしてください。
        fraudDetectionResult:
          $ref: '#/components/schemas/FraudDetectionResult'
          description: |
            不正検知の結果情報  
            3Dセキュアリダイレクト時(HTTPステータスコードが202の時)は返りません。  
            [OpenAPI Generator](https://openapi-generator.tech/)のために追加しています。
        creditResult:
          $ref: '#/components/schemas/CreditResult'
          description: |
            クレカ払いの結果情報  
            3Dセキュアリダイレクト時(HTTPステータスコードが202の時)は返りません。  
            [OpenAPI Generator](https://openapi-generator.tech/)のために追加しています。
    CreditOnfileChargeRequest:
      description: クレカ払い 随時支払い(/credit/on-file/charge)のリクエストパラメーター
      type: object
      required:
        - merchant
        - order
        - payer
        - creditOnfileInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        order:
          $ref: '#/components/schemas/Order'
        payer:
          $ref: '#/components/schemas/Payer'
        creditOnfileInformation:
          $ref: '#/components/schemas/CreditOnfileInformation'
        tds2Information:
          $ref: '#/components/schemas/Tds2Information'
        fraudDetectionInformation:
          $ref: '#/components/schemas/FraudDetectionInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    Tds2FinalizeChargeRequest:
      description: クレカ払い 3Dセキュア後支払い(/tds2/finalizeCharge)のリクエストパラメーター
      type: object
      required:
        - accessId
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 3Dセキュアにリダイレクトする前の支払いリクエスト時に返る取引ID
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    Tds2FinalizeChargeResponse:
      description: クレカ払い 3Dセキュア後支払い(/tds2/finalizeCharge)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            仮売上成功時は<span class="mp-oas-code">CAPTURE</span>、即時売上成功時は<span class="mp-oas-code">NO_ACTION</span>です。
            - <span class="mp-oas-code">CAPTURE</span>：確定処理が必要
            - <span class="mp-oas-code">NO_ACTION</span>：後続処理なし
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールド以下の値が返ります。
                - 仮売上成功時: <span class="mp-oas-code">AUTH</span>
                - 即時売上成功時: <span class="mp-oas-code">CAPTURE</span>
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">CREDIT</span>です。
        creditResult:
          $ref: '#/components/schemas/CreditResult'
          description: |
            クレカ払いの結果情報  
            3Dセキュア後支払いでは、3Dセキュア認証の利用有無<span class="mp-oas-code">useTds2</span>は必ず<span class="mp-oas-code">true</span>です。
        tds2Result:
          $ref: '#/components/schemas/Tds2Result'
        fraudDetectionResult:
          $ref: '#/components/schemas/FraudDetectionResult'
          description: |
            不正検知の結果情報  
            非同期モードが<span class="mp-oas-code">true</span>の場合は<span class="mp-oas-code">screeningType</span>のみが返ります。  
            ただし、Forter利用時は非同期モードによらずfraudDetectionResult配下のすべての項目が返ります。
    CreditVerifyCardRequest:
      description: クレカ払い 有効性確認(/credit/verifyCard)のリクエストパラメーター
      type: object
      required:
        - merchant
        - order
        - payer
        - creditVerificationInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        order:
          $ref: '#/components/schemas/OrderWithoutAmount'
        payer:
          $ref: '#/components/schemas/Payer'
        creditVerificationInformation:
          $ref: '#/components/schemas/CreditVerificationInformation'
        tds2Information:
          $ref: '#/components/schemas/Tds2Information'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    CreditVerifyCardResponse:
      description: クレカ払い 有効性確認(/credit/verifyCard)のオーソリ成功時のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            有効性確認成功時は<span class="mp-oas-code">NO_ACTION</span>です。
            - <span class="mp-oas-code">NO_ACTION</span>：後続処理なし
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            有効性確認リクエストの取引情報  
              - <span class="mp-oas-code">amount</span>フィールドは返りません。
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">CHECK</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">CREDIT</span>です。
        creditResult:
          $ref: '#/components/schemas/CreditResult'
        onfileCardResult:
          $ref: '#/components/schemas/OnfileCardResult'
        redirectInformation:
          $ref: '#/components/schemas/RedirectInformation'
          description: |
            リダイレクト情報  
            オーソリ成功時(HTTPステータスコードが201の時)は返りません。  
            [OpenAPI Generator](https://openapi-generator.tech/)のために追加しています。
    CreditVerifyCardTds2Response:
      description: クレカ払い 有効性確認(/credit/verifyCard)の3Dセキュアリダイレクト時のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            3Dセキュアリダイレクト時は必ず<span class="mp-oas-code">REDIRECT</span>です。
            - <span class="mp-oas-code">REDIRECT</span>：リダイレクトが必要
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            有効性確認リクエストの取引情報  
              - <span class="mp-oas-code">amount</span>フィールドは返りません。
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">AUTHENTICATED</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">CREDIT</span>です。
        redirectInformation:
          $ref: '#/components/schemas/RedirectInformation'
          description: |
            リダイレクト情報  
            3Dセキュアに進むためのリダイレクトの情報です。  
            <span class="mp-oas-code">redirectType</span>フィールドは必ず<span class="mp-oas-code">TDS2</span>です。  
            お客様のブラウザを<span class="mp-oas-code">redirectUrl</span>にリダイレクトしてください。
        creditResult:
          $ref: '#/components/schemas/CreditResult'
          description: |
            クレカ払いの結果情報  
            3Dセキュアリダイレクト時(HTTPステータスコードが202の時)は返りません。  
            [OpenAPI Generator](https://openapi-generator.tech/)のために追加しています。
        onfileCardResult:
          $ref: '#/components/schemas/OnfileCardResult'
          description: |
            カードの登録結果情報  
            3Dセキュアリダイレクト時(HTTPステータスコードが202の時)は返りません。  
            [OpenAPI Generator](https://openapi-generator.tech/)のために追加しています。
    CreditVerificationInformation:
      oneOf:
        - $ref: '#/components/schemas/CreditVerificationTokenInformation'
        - $ref: '#/components/schemas/CreditVerificationReferrerInformation'
        - $ref: '#/components/schemas/CreditVerificationPanInformation'
    CreditVerificationPanInformation:
      title: 直接設定
      type: object
      description: クレカ払い 有効性確認(/credit/verifyCard)のリクエストパラメーター(直接版)
      properties:
        card:
          $ref: '#/components/schemas/Card'
        creditVerificationOptions:
          $ref: '#/components/schemas/CreditVerificationOptions'
        onfileCardOptions:
          $ref: '#/components/schemas/OnfileCardOptions'
    CreditVerificationTokenInformation:
      title: トークン化して設定
      type: object
      description: クレカ払い 有効性確認(/credit/verifyCard)のリクエストパラメーター(トークン版)
      properties:
        tokenizedCard:
          $ref: '#/components/schemas/TokenizedCard'
          description: |
            トークン化されたカード情報  
            **有効性確認(/credit/verifyCard)においては、Apple Payトークンは利用できません。**
        creditVerificationOptions:
          $ref: '#/components/schemas/CreditVerificationOptions'
        onfileCardOptions:
          $ref: '#/components/schemas/OnfileCardOptions'
    CreditVerificationReferrerInformation:
      title: 登録済み情報を設定
      type: object
      description: クレカ払い 有効性確認(/credit/verifyCard)のリクエストパラメーター(登録済み版)
      properties:
        onfileCard:
          $ref: '#/components/schemas/OnfileCard'
          description: |
            登録されているカード情報  
            **有効性確認(/credit/verifyCard)においては、登録済みのApple Pay情報は利用できません。**
        creditVerificationOptions:
          $ref: '#/components/schemas/CreditVerificationOptions'
        onfileCardOptions:
          $ref: '#/components/schemas/OnfileCardOptions'
    Tds2FinalizeVerificationRequest:
      description: クレカ払い 3Dセキュア後有効性確認(/tds2/finalizeVerification)のリクエストパラメーター
      type: object
      required:
        - accessId
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 3Dセキュアにリダイレクトする前の有効性確認リクエスト時に返る取引ID
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    Tds2FinalizeVerificationResponse:
      description: クレカ払い 3Dセキュア後有効性確認(/tds2/finalizeVerification)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            有効性確認成功時は<span class="mp-oas-code">NO_ACTION</span>です。
            - <span class="mp-oas-code">NO_ACTION</span>：後続処理なし
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            有効性確認リクエストの取引情報  
              - <span class="mp-oas-code">amount</span>フィールドは返りません。
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">CHECK</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">CREDIT</span>です。
        creditResult:
          $ref: '#/components/schemas/CreditResult'
          description: |
            クレカ払いの結果情報  
            3Dセキュア後有効性確認では、3Dセキュア認証の利用有無<span class="mp-oas-code">useTds2</span>は必ず<span class="mp-oas-code">true</span>です。
        onfileCardResult:
          $ref: '#/components/schemas/OnfileCardResult'
        tds2Result:
          $ref: '#/components/schemas/Tds2Result'
    CreditStoreCardRequest:
      description: クレカ払い カード登録(/credit/storeCard)のリクエストパラメーター
      type: object
      required:
        - merchant
        - creditStoringInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        creditStoringInformation:
          $ref: '#/components/schemas/CreditStoringInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    CreditStoreCardReponse:
      description: クレカ払い カード登録(/credit/storeCard)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            カード登録成功時は<span class="mp-oas-code">NO_ACTION</span>です。
            - <span class="mp-oas-code">NO_ACTION</span>：後続処理なし
        onfileCardResult:
          $ref: '#/components/schemas/OnfileCardResult'
        cardResult:
          $ref: '#/components/schemas/CardResult'
    CreditStoringInformation:
      oneOf:
        - $ref: '#/components/schemas/CreditStoringReferrerInformation'
        - $ref: '#/components/schemas/CreditStoringTokenInformation'
        - $ref: '#/components/schemas/CreditStoringPanInformation'
    CreditStoringPanInformation:
      title: 直接設定
      type: object
      description: クレカ払い カード登録(/credit/storeCard)のリクエストパラメーター(直接版)
      required:
        - card
        - onfileCardOptions
      properties:
        card:
          $ref: '#/components/schemas/Card'
        onfileCardOptions:
          $ref: '#/components/schemas/OnfileCardOptions'
    CreditStoringTokenInformation:
      title: トークン化して設定
      type: object
      description: クレカ払い カード登録(/credit/storeCard)のリクエストパラメーター(トークン版)
      required:
        - tokenizedCard
        - onfileCardOptions
      properties:
        tokenizedCard:
          $ref: '#/components/schemas/TokenizedCard'
          description: |
            トークン化されたカード情報  
            **カード登録(/credit/storeCard)においては、Apple Payトークンは利用できません。**
        onfileCardOptions:
          $ref: '#/components/schemas/OnfileCardOptions'
    CreditStoringReferrerInformation:
      title: 成功した取引を設定
      type: object
      description: クレカ払い カード登録(/credit/storeCard)のリクエストパラメーター(成功取引版)
      required:
        - referrer
        - onfileCardOptions
      properties:
        referrer:
          $ref: '#/components/schemas/Referrer'
        onfileCardOptions:
          $ref: '#/components/schemas/OnfileCardOptions'
          description: |
            カード登録オプション情報
    CreditGetCardDetailsRequest:
      description: クレカ払い カードの詳細情報返却(/credit/getCardDetails)のリクエストパラメーター
      type: object
      required:
        - cardInformation
      properties:
        cardInformation:
          $ref: '#/components/schemas/CardInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    CreditGetCardDetailsResponse:
      description: クレカ払い カードの詳細情報返却(/credit/getCardDetails)の成功時のレスポンスパラメーター
      type: object
      properties:
        cardDetailResult:
          $ref: '#/components/schemas/CardDetailResult'
    CardInformation:
      oneOf:
        - $ref: '#/components/schemas/CreditGetCardDetailsTokenInformation'
        - $ref: '#/components/schemas/CreditGetCardDetailsReferrerInformation'
    CreditGetCardDetailsTokenInformation:
      title: トークン化して設定
      type: object
      description: クレカ払い カードの詳細情報返却(/credit/getCardDetails)のリクエストパラメーター(トークン版)
      required:
        - tokenizedCard
        - onfileCardOptions
      properties:
        tokenizedCard:
          $ref: '#/components/schemas/TokenizedCard'
          description: |
            トークン化されたカード情報  
            **Apple PayトークンおよびGoogle Payトークンは利用できません。**
    CreditGetCardDetailsReferrerInformation:
      title: 登録済み情報を設定
      type: object
      description: クレカ払い カードの詳細情報返却(/credit/getCardDetails)のリクエストパラメーター(登録済み版)
      properties:
        onfileCard:
          $ref: '#/components/schemas/OnfileCardWithoutCardholderName'
          description: |
            登録されているカード情報  
            **登録済みのApple Pay情報は利用できません。**
    WalletChargeRequest:
      description: Pay払い 都度支払い(/wallet/charge)のリクエストパラメーター
      type: object
      required:
        - merchant
        - order
        - payer
        - walletInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        order:
          $ref: '#/components/schemas/Order'
        payer:
          $ref: '#/components/schemas/Payer'
        walletInformation:
          $ref: '#/components/schemas/WalletInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    WalletChargeResponse:
      description: Pay払い 都度支払い(/wallet/charge)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            Pay払いの都度支払い時は必ず<span class="mp-oas-code">REDIRECT</span>です。
            - <span class="mp-oas-code">REDIRECT</span>：リダイレクトが必要
        orderReference:
          $ref: '#/components/schemas/OrderReferenceWallet'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">REQSUCCESS</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">WALLET</span>です。
        redirectInformation:
          $ref: '#/components/schemas/RedirectInformation'
          description: |
            リダイレクト情報  
            Pay払いの決済事業者のWebサイト、モバイルアプリに進むためのリダイレクトの情報です。  
            <span class="mp-oas-code">redirectType</span>フィールドは必ず<span class="mp-oas-code">WALLET_CHARGE</span>です。  
            お客様のブラウザを<span class="mp-oas-code">redirectUrl</span>にリダイレクトしてください。  
            リダイレクトせずに120秒経過すると<span class="mp-oas-code">redirectUrl</span>は無効となります。
    AmazonPayCancelWebhookRequest:
      description: Amazon Pay V2のキャンセル結果通知リクエストパラメーター
      type: object
      required:
        - accessId
        - event
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: |
            取引ID  
            キャンセルリクエスト時に設定した取引IDです。
        event:
          type: string
          description: |
            Webhookイベントタイプ  
            - <span class="mp-oas-code">REFUND_SUCCEEDED</span>：キャンセル成功
            - <span class="mp-oas-code">REFUND_FAILED</span>：キャンセル失敗
          enum:
            - REFUND_SUCCEEDED
            - REFUND_FAILED
        csrfToken:
          type: string
          description: |
            Webhook任意パラメーター  
            chargeリクエスト時に加盟店様が設定した任意の値です。  
            CSRF対策のために利用してください。
          example: bdb04c5f-42f0-29e2-0979-edae3e7760bf
    WalletFrontendChargeRequest:
      description: Pay払い 都度支払い（フロントエンド方式）(/wallet/front-end/charge)のリクエストパラメーター
      required:
        - merchant
        - order
        - payer
        - walletFrontendInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        order:
          $ref: '#/components/schemas/Order'
        payer:
          $ref: '#/components/schemas/Payer'
        walletFrontendInformation:
          $ref: '#/components/schemas/WalletFrontendInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    WalletFrontendChargeResponse:
      description: Pay払い 都度支払い（フロントエンド方式）(/wallet/front-end/charge)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            都度支払い（フロントエンド方式）の場合は必ず<span class="mp-oas-code">AWAIT</span>です。
            - <span class="mp-oas-code">AWAIT</span>：お客様の決済待ち
        orderReference:
          $ref: '#/components/schemas/OrderReferenceWallet'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">REQSUCCESS</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">WALLET</span>です。
        walletFrontendResult:
          $ref: '#/components/schemas/WalletFrontendResult'
    WalletFrontendVerifyChargeRequest:
      description: Pay払い 都度支払い（フロントエンド方式）(/wallet/front-end/verifyCharge)のリクエストパラメーター
      type: object
      required:
        - accessId
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 取引リクエスト時に返る取引ID
        payPay:
          $ref: '#/components/schemas/PayPay'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    WalletFrontendVerifyChargeResponse:
      description: Pay払い 都度支払い（フロントエンド方式）(/wallet/front-end/verifyCharge)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            仮売上成功時は<span class="mp-oas-code">CAPTURE</span>、即時売上成功時は<span class="mp-oas-code">NO_ACTION</span>です。
            - <span class="mp-oas-code">NO_ACTION</span>：後続処理なし
        orderReference:
          $ref: '#/components/schemas/OrderReferenceWallet'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは以下の値が返ります。
                - 仮売上成功時: <span class="mp-oas-code">AUTH</span>
                - 即時売上成功時: <span class="mp-oas-code">CAPTURE</span>
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">WALLET</span>です。
        walletFrontendResult:
          $ref: '#/components/schemas/WalletFrontendResult'
    WalletChargeWebhook:
      description: Pay払い決済結果通知リクエストパラメーター
      type: object
      required:
        - accessId
        - event
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: |
            取引ID  
            取引リクエスト時に返る取引IDです。
        event:
          type: string
          description: |
            Webhookイベントタイプ  
            - <span class="mp-oas-code">WALLET_PAID</span>：Pay払い支払い完了
            - <span class="mp-oas-code">WALLET_FAILED</span>：Pay払い支払い失敗
          enum:
            - WALLET_PAID
            - WALLET_FAILED
        csrfToken:
          type: string
          description: |
            Webhook任意パラメーター  
            chargeリクエスト時に加盟店様が設定した任意の値です。  
            CSRF対策のために利用してください。
          example: bdb04c5f-42f0-29e2-0979-edae3e7760bf
    WalletAcceptWebhook:
      description: Pay払い利用承諾結果通知リクエストパラメーター
      type: object
      required:
        - accessId
        - event
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: |
            取引ID  
            取引リクエスト時に返る取引IDです。
        event:
          type: string
          description: |
            Webhookイベントタイプ  
            - <span class="mp-oas-code">WALLET_ACCEPTED</span>：Pay払い利用承諾完了
            - <span class="mp-oas-code">WALLET_FAILED</span>：Pay払い利用承諾失敗
          enum:
            - WALLET_ACCEPTED
            - WALLET_FAILED
        csrfToken:
          type: string
          description: |
            Webhook任意パラメーター  
            authorizeAccountリクエスト時に加盟店様が設定した任意の値です。  
            CSRF対策のために利用してください。
          example: bdb04c5f-42f0-29e2-0979-edae3e7760bf
    WalletFrontendWebhook:
      description: 都度支払い（フロントエンド方式）決済結果通知リクエストパラメーター
      type: object
      required:
        - accessId
        - event
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: |
            取引ID  
            取引リクエスト時に返る取引IDです。
        event:
          type: string
          description: |
            Webhookイベントタイプ  
            - <span class="mp-oas-code">WALLET_PAID</span>：Pay払い支払い完了
          enum:
            - WALLET_PAID
        csrfToken:
          type: string
          description: |
            Webhook任意パラメーター  
            chargeリクエスト時に加盟店様が設定した任意の値です。  
            CSRF対策のために利用してください。
          example: bdb04c5f-42f0-29e2-0979-edae3e7760bf
    WalletOnfileChargeRequest:
      description: Pay払い 随時支払い(/wallet/on-file/charge)のリクエストパラメーター
      required:
        - merchant
        - order
        - payer
        - walletOnfileInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        order:
          $ref: '#/components/schemas/Order'
        payer:
          $ref: '#/components/schemas/Payer'
        walletOnfileInformation:
          $ref: '#/components/schemas/WalletOnfileInformation'
        additionalOptions:
          allOf:
            - $ref: '#/components/schemas/PaymentAdditionalOptions'
            - type: object
    WalletOnfileChargeResponse:
      description: Pay払い 随時支払い(/wallet/on-file/charge)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            仮売上成功時は<span class="mp-oas-code">CAPTURE</span>、即時売上成功時は<span class="mp-oas-code">NO_ACTION</span>です。
            - <span class="mp-oas-code">NO_ACTION</span>：後続処理なし
        orderReference:
          $ref: '#/components/schemas/OrderReferenceWallet'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは以下の値が返ります。
                - 仮売上成功時: <span class="mp-oas-code">AUTH</span>
                - 即時売上成功時: <span class="mp-oas-code">CAPTURE</span>
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">WALLET</span>です。
        walletResult:
          $ref: '#/components/schemas/WalletResult'
    WalletAuthorizationRequest:
      description: Pay払い 利用承諾(/wallet/authorizeAccount)のリクエストパラメーター
      type: object
      required:
        - merchant
        - order
        - payer
        - walletAuthorizationInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        order:
          $ref: '#/components/schemas/OrderWithoutAmount'
        payer:
          $ref: '#/components/schemas/Payer'
        walletAuthorizationInformation:
          $ref: '#/components/schemas/WalletAuthorizationInformation'
        additionalOptions:
          allOf:
            - $ref: '#/components/schemas/AcceptAdditionalOptions'
            - type: object
    WalletAuthorizationResponse:
      description: Pay払い 利用承諾(/wallet/authorizeAccount)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            Pay払いの利用承諾時は必ず<span class="mp-oas-code">REDIRECT</span>です。
            - <span class="mp-oas-code">REDIRECT</span>：リダイレクトが必要
        orderReference:
          $ref: '#/components/schemas/OrderReferenceWallet'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">REQSUCCESS</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">WALLET</span>です。
        redirectInformation:
          $ref: '#/components/schemas/RedirectInformation'
          description: |
            リダイレクト情報  
            Pay払いの決済事業者のWebサイト、モバイルアプリに進むためのリダイレクトの情報です。  
            <span class="mp-oas-code">redirectType</span>フィールドは必ず<span class="mp-oas-code">WALLET_AUTHORIZE</span>です。  
            お客様のブラウザを<span class="mp-oas-code">redirectUrl</span>にリダイレクトしてください。  
            リダイレクトせずに120秒経過すると<span class="mp-oas-code">redirectUrl</span>は無効となります。
    walletGetCustomerDataRequest:
      description: /wallet/getCustomerData request body
      type: object
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 取引リクエスト時に返る取引ID
        amazonPay:
          $ref: '#/components/schemas/CustomerDataAmazonPay'
          description: |
            Amazon Pay V2専用パラメーター
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    WalletGetCustomerDataResponse:
      description: /wallet/getCustomerData response body
      type: object
      properties:
        buyerId:
          $ref: '#/components/schemas/BuyerId'
          description: 購入者のID
        name:
          type: string
          description: 購入者の氏名
        email:
          type: string
          description: 購入者のメールアドレス
        remarks:
          $ref: '#/components/schemas/Remarks'
          description: 備考<br />Amazon Pay V2ではお支払い情報が設定されます。
        shippingInformation:
          $ref: '#/components/schemas/CustomerShippingAddress'
          description: 配送先情報
        billingInformation:
          $ref: '#/components/schemas/CustomerBillingAddress'
          description: 請求先情報
    CashChargeRequest:
      description: 現金払い(/cash/charge)のリクエストパラメーター
      type: object
      required:
        - merchant
        - order
        - payer
        - cashInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        order:
          $ref: '#/components/schemas/Order'
        payer:
          $ref: '#/components/schemas/Payer'
        cashInformation:
          $ref: '#/components/schemas/CashInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    CashChargeResponse:
      description: 現金払い(/cash/charge)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            現金払いは必ず<span class="mp-oas-code">AWAIT</span>です。
            - <span class="mp-oas-code">AWAIT</span>：入金結果待ち
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCash'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは以下の値が返ります。
                - <span class="mp-oas-code">REQSUCCESS</span>：コンビニ、Pay-easy、マイペイメント
                - <span class="mp-oas-code">TRADING</span>：銀行振込
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">CASH</span>です。
        cashResult:
          $ref: '#/components/schemas/CashResult'
    CashWebhookRequest:
      description: 現金払いの支払い完了通知リクエストパラメーター
      type: object
      required:
        - accessId
        - event
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: |
            取引ID  
            取引リクエスト時に返る取引IDです。
        event:
          type: string
          description: |
            Webhookイベントタイプ  
            - <span class="mp-oas-code">CASH_PAID</span>：現金払い支払い完了
            - <span class="mp-oas-code">CASH_RETURN</span>：現金払い支払い取消
          enum:
            - CASH_PAID
            - CASH_RETURN
        csrfToken:
          type: string
          description: |
            Webhook任意パラメーター  
            chargeリクエスト時に加盟店様が設定した任意の値です。  
            CSRF対策のために利用してください。
          example: bdb04c5f-42f0-29e2-0979-edae3e7760bf
    deferredpayShippingRequest:
      description: /deferredpay/shipping request body
      type: object
      required:
        - accessId
        - deferredpayInformation
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 取引リクエスト時に返る取引ID
        deferredpayInformation:
          $ref: '#/components/schemas/deferredpayInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    deferredpayShippingResponse:
      title: 後払い
      description: 出荷報告(/deferredpay/shipping)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            出荷報告は必ず<span class="mp-oas-code">AWAIT</span>です。
            - <span class="mp-oas-code">AWAIT</span>：着荷待ち
        orderReference:
          $ref: '#/components/schemas/OrderReferenceDeferredpay'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">SHIPPED</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">DEFERRED</span>です。
        deferredpayResult:
          $ref: '#/components/schemas/DeferredpayResult'
    deferredpayShippingCancelRequest:
      description: /deferredpay/shippingCancel request body
      type: object
      required:
        - accessId
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 取引リクエスト時に返る取引ID
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    deferredpayShippingCancelResponse:
      title: 後払い
      description: 出荷取消(/deferredpay/shippingCancel)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            出荷取消は必ず<span class="mp-oas-code">CAPTURE</span>です。  
            - <span class="mp-oas-code">CAPTURE</span>：出荷報告が必要    
        orderReference:
          $ref: '#/components/schemas/OrderReferenceDeferredpay'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">AUTH</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">DEFERRED</span>です。
        deferredpayResult:
          $ref: '#/components/schemas/DeferredpayResult'
    deferredpayShippingUpdateRequest:
      description: /deferredpay/shippingUpdate request body
      type: object
      required:
        - accessId
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 取引リクエスト時に返る取引ID
        deferredpayInformation:
          $ref: '#/components/schemas/deferredpayInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    deferredpayShippingUpdateResponse:
      title: 後払い
      description: 出荷変更(/deferredpay/shippingUpdate)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            出荷変更は必ず<span class="mp-oas-code">AWAIT</span>です。
            - <span class="mp-oas-code">AWAIT</span>：着荷待ち
        orderReference:
          $ref: '#/components/schemas/OrderReferenceDeferredpay'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">SHIPPED</span>です。  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">DEFERRED</span>です。
        deferredpayResult:
          $ref: '#/components/schemas/DeferredpayResult'
    deferredpayOrderUpdateRequest:
      description: /deferredpay/orderUpdate request body
      type: object
      required:
        - accessId
        - order
        - payer
        - deferredpayInformation
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 取引リクエスト時に返る取引ID
        order:
          $ref: '#/components/schemas/Order'
        payer:
          $ref: '#/components/schemas/Payer'
        deferredpayInformation:
          $ref: '#/components/schemas/deferredpayInformation'
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    deferredpayOrderUpdateResponse:
      title: 後払い
      description: 取引変更(/deferredpay/orderUpdate)のレスポンスパラメーター
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            <span class="mp-oas-code">status</span>フィールドが<span class="mp-oas-code">AUTH</span>の時は<span class="mp-oas-code">CAPTURE</span>、<span class="mp-oas-code">SALES</span>と<span class="mp-oas-code">CAPTURE</span>の時は<span class="mp-oas-code">NO_ACTION</span>です。
            - <span class="mp-oas-code">CAPTURE</span>：出荷報告が必要
        orderReference:
          $ref: '#/components/schemas/OrderReferenceDeferredpay'
          description: |
            支払いリクエストの取引情報  
              - <span class="mp-oas-code">chargeType</span>フィールドは必ず<span class="mp-oas-code">DEFERRED</span>です。
        deferredpayResult:
          $ref: '#/components/schemas/DeferredpayResult'
    AtokaraWebhook:
      description: アトカラの審査結果および強制キャンセルの通知リクエストパラメーター
      type: object
      required:
        - orderId
        - event
      properties:
        orderId:
          $ref: '#/components/schemas/OrderId'
          description: |
            オーダーID  
            [アトカラ取引登録](/mulpay/docs/payment-method/deferredpay/atokara/register)リクエスト時に設定した任意のオーダーIDです。
        event:
          type: string
          description: |
            Webhookイベントタイプ  
            - <span class="mp-oas-code">ASSESSMENT_SUCCEEDED</span>：審査結果 OK
            - <span class="mp-oas-code">ASSESSMENT_PENDING</span>：審査結果 審査中
            - <span class="mp-oas-code">ASSESSMENT_FAILED</span>：審査結果 NG
          enum:
            - ASSESSMENT_SUCCEEDED
            - ASSESSMENT_PENDING
            - ASSESSMENT_FAILED
        csrfToken:
          type: string
          description: |
            Webhook任意パラメーター  
            [アトカラ取引登録](/mulpay/docs/payment-method/deferredpay/atokara/register)リクエスト時に加盟店様が設定した任意の値です。  
            CSRF対策のために利用してください。
          example: bdb04c5f-42f0-29e2-0979-edae3e7760bf
    OrderCaptureRequest:
      description: /order/capture request body
      type: object
      required:
        - accessId
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 取引リクエスト時に返る取引ID
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    OrderCaptureResponseCredit:
      title: クレカ払い
      description: /order/capture response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            取引参照情報
        creditResult:
          $ref: '#/components/schemas/CreditResult'
    OrderCaptureResponseWallet:
      title: Pay払い
      description: /order/capture response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceWallet'
          description: |
            取引参照情報
        walletResult:
          $ref: '#/components/schemas/WalletResult'
    OrderUpdateRequest:
      description: /order/update request body
      type: object
      required:
        - accessId
        - amount
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 取引リクエスト時に返る取引ID
        amount:
          type: string
          description: |
            変更後の税送料込の取引金額  
            決済手段により設定可能な値が異なります。
          example: '1000'
        authorizationMode:
          $ref: '#/components/schemas/AuthorizationMode'
          description: |
            支払い要求のタイプ  
            クレカ払いの場合は必ず設定してください。  
            クレカ払い以外は設定しても無視されます。  
            - <span class="mp-oas-code">AUTH</span>：仮売上
            - <span class="mp-oas-code">CAPTURE</span>：即時売上
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    OrderUpdateResponseCredit:
      title: クレカ払い
      description: /order/update response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            取引参照情報
        creditResult:
          $ref: '#/components/schemas/CreditResult'
          description: |
            カード支払い結果情報  
            金額変更時は元の取引が3Dセキュア認証済であっても、3Dセキュア認証の利用有無<span class="mp-oas-code">useTds2</span>は必ず<span class="mp-oas-code">false</span>です。
    OrderUpdateResponseWallet:
      title: Pay払い
      description: /order/update response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceWallet'
          description: |
            取引参照情報
        walletResult:
          $ref: '#/components/schemas/WalletResult'
    OrderUpdateResponseCash:
      title: 現金払い
      description: /order/update response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCash'
          description: |
            取引参照情報
        cashResult:
          $ref: '#/components/schemas/CashResult'
    AuthorizationMode:
      description: |
        支払い要求のタイプ  
        - <span class="mp-oas-code">AUTH</span>：仮売上
        - <span class="mp-oas-code">CAPTURE</span>：即時売上
      type: string
      enum:
        - AUTH
        - CAPTURE
      example: AUTH
    OrderCancelRequest:
      description: /order/cancel request body
      type: object
      required:
        - accessId
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: 取引リクエスト時に返る取引ID
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    OrderCancelResponseCredit:
      title: クレカ払い
      description: /order/cancel response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            取引参照情報
        creditResult:
          $ref: '#/components/schemas/CreditResult'
          description: |
            カード支払い結果情報  
            キャンセル時は元の取引が3Dセキュア認証済であっても、3Dセキュア認証の利用有無<span class="mp-oas-code">useTds2</span>は必ず<span class="mp-oas-code">false</span>です。
    OrderCancelResponseWallet:
      title: Pay払い
      description: /order/cancel response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceWallet'
          description: |
            取引参照情報
        walletResult:
          $ref: '#/components/schemas/WalletResult'
    OrderCancelResponseCash:
      title: 現金払い
      description: /order/cancel response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCash'
          description: |
            取引参照情報
        cashResult:
          $ref: '#/components/schemas/CashResult'
    OrderCancelResponseDeferredpay:
      title: 後払い
      description: /order/cancel response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceDeferredpay'
          description: |
            取引参照情報
        deferredpayResult:
          $ref: '#/components/schemas/DeferredpayResult'
    OrderInquiryRequest:
      description: /order/inquiry request body
      type: object
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: |
            取引リクエスト時に返る取引ID  
            オーダーIDを省略する場合、取引IDは必ず設定してください。  
            取引IDとオーダーIDを設定した場合、組み合わせが一致する取引情報が返ります。
        orderId:
          $ref: '#/components/schemas/OrderId'
          description: |
            取引リクエスト時に設定した任意のオーダーID  
            取引IDを省略する場合、オーダーIDは必ず設定してください。  
            取引IDとオーダーIDを設定した場合、組み合わせが一致する取引情報が返ります。
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    OrderInquiryResponse:
      oneOf:
        - $ref: '#/components/schemas/OrderInquiryResponseCredit'
        - $ref: '#/components/schemas/OrderInquiryResponseWallet'
        - $ref: '#/components/schemas/OrderInquiryResponseCash'
        - $ref: '#/components/schemas/OrderInquiryResponseDeferredpay'
    OrderInquiryResponseCredit:
      title: クレカ払い
      description: /order/inquiry response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCredit'
          description: |
            取引参照情報
        creditResult:
          $ref: '#/components/schemas/CreditResult'
        tds2Result:
          $ref: '#/components/schemas/Tds2Result'
        fraudDetectionResult:
          $ref: '#/components/schemas/FraudDetectionResult'
          description: 不正検知の結果情報
        errorInformation:
          $ref: '#/components/schemas/ErrorInformation'
    OrderInquiryResponseWallet:
      title: Pay払い
      description: /order/inquiry response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceWallet'
          description: |
            取引参照情報
        walletResult:
          $ref: '#/components/schemas/WalletResult'
        errorInformation:
          $ref: '#/components/schemas/ErrorInformation'
    OrderInquiryResponseCash:
      title: 現金払い
      description: /order/inquiry response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceCash'
          description: |
            取引参照情報
        cashResult:
          $ref: '#/components/schemas/CashResult'
        errorInformation:
          $ref: '#/components/schemas/ErrorInformation'
    OrderInquiryResponseDeferredpay:
      title: 後払い
      description: /order/inquiry response body
      type: object
      properties:
        orderReference:
          $ref: '#/components/schemas/OrderReferenceDeferredpay'
          description: |
            取引参照情報
        deferredpayResult:
          $ref: '#/components/schemas/DeferredpayResult'
        errorInformation:
          $ref: '#/components/schemas/ErrorInformation'
    MemberCreateRequest:
      description: /member/create request body
      type: object
      required:
        - memberId
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: 登録する会員のID
        memberName:
          $ref: '#/components/schemas/MemberName'
          description: |
            新規登録する会員の名称
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    MemberCreateResponse:
      description: /member/create response body
      type: object
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
        memberName:
          $ref: '#/components/schemas/MemberName'
    MemberInquiryRequest:
      description: /member/inquiry request body
      type: object
      required:
        - memberId
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: |
            照会したい会員のID
        onfileType:
          $ref: '#/components/schemas/OnfileType'
          description: |
            照会したい登録認証情報のタイプ  
            設定なしの場合は全てのタイプが返ります。
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    MemberInquiryResponse:
      description: /member/inquiry response body
      type: object
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
        memberName:
          $ref: '#/components/schemas/MemberName'
        onfileCards:
          $ref: '#/components/schemas/OnfileCards'
        onfileWallets:
          $ref: '#/components/schemas/OnfileWallets'
    MemberDeleteRequest:
      description: /member/delete request body
      type: object
      required:
        - memberId
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: |
            会員ID  
            削除する会員のIDです。
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    MemberDeleteResponse:
      description: /member/delete response body
      type: object
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
        deletedCards:
          $ref: '#/components/schemas/OnfileCards'
          description: |
            削除されたカードの情報  
            <span class="mp-oas-code">index</span>や<span class="mp-oas-code">isDefault</span>は削除する前の情報です。  
            最新の状態は[取引照会API(/order/inquiry)](/mulpay/apis/openapi-type/order-inquiry)で確認してください。
        deletedWallets:
          $ref: '#/components/schemas/OnfileWallets'
          description: |
            削除されたPay払い利用承諾情報
    MemberDeleteItemRequestCard:
      title: カード
      description: /member/delete request body
      type: object
      required:
        - memberId
        - onfileType
        - onfileCardType
        - cardId
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: |
            会員ID  
            削除するカード情報が登録されている会員のIDです。
        onfileType:
          $ref: '#/components/schemas/OnfileType'
          description: |
            認証情報タイプ  
            削除する認証情報タイプとしてクレジットカード<span class="mp-oas-code">CARD</span>を設定してください。
        onfileCardType:
          $ref: '#/components/schemas/OnfileCardType'
          description: |
            削除するカードのタイプ  
            - <span class="mp-oas-code">CREDIT_CARD</span>：クレジットカード
            - <span class="mp-oas-code">APPLE_PAY</span>：Apple Pay
        cardId:
          $ref: '#/components/schemas/OnfileCardId'
          description: |
            カードのID
            削除するカードのID(物理連番)です。
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    MemberDeleteItemRequestWallet:
      title: Pay払い利用承諾
      description: /member/delete request body
      type: object
      required:
        - onfileType
        - onfileWalletType
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: |
            会員ID  
            削除する利用承諾情報が登録されている会員のIDです。
        onfileType:
          $ref: '#/components/schemas/OnfileType'
          description: |
            認証情報タイプ  
            削除する認証情報タイプとしてPay払い利用承諾<span class="mp-oas-code">WALLET</span>を設定してください。
        onfileWalletType:
          $ref: '#/components/schemas/OnfileWalletType'
          description: |
            利用承諾のタイプ  
            削除する利用承諾のタイプです。
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    MemberDeleteItemResponseCard:
      title: カード
      description: /member/deleteItem response body
      type: object
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
        deletedCard:
          $ref: '#/components/schemas/OnfileCardInformation'
          description: |
            削除されたカードの情報  
            <span class="mp-oas-code">index</span>や<span class="mp-oas-code">isDefault</span>は削除する前の情報です。  
            最新の状態は[取引照会API(/order/inquiry)](/mulpay/apis/openapi-type/order-inquiry)で確認してください。
    MemberDeleteItemResponseWallet:
      title: Pay払い利用承諾
      description: /member/deleteItem response body
      type: object
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
        deletedWallet:
          $ref: '#/components/schemas/OnfileWalletInformation'
          description: |
            削除されたPay払い利用承諾情報
    VerificationStartRequest:
      title: カード
      description: /verification/start request body
      type: object
      required:
        - merchant
        - verificationInformation
      properties:
        merchant:
          $ref: '#/components/schemas/Merchant'
        verificationInformation:
          $ref: '#/components/schemas/VerificationInformation'
          description: |
            本人確認情報
    VerificationStartResponse:
      title: 本人確認
      description: /verification/start response body
      type: object
      properties:
        nextAction:
          $ref: '#/components/schemas/NextAction'
          description: |
            レスポンスを受け取った後の加盟店様側の処理  
            認証開始時は必ず<span class="mp-oas-code">REDIRECT</span>です。
            - <span class="mp-oas-code">REDIRECT</span>：リダイレクトが必要
        verificationReference:
          $ref: '#/components/schemas/VerificationReference'
          description: |
            本人確認リクエストの認証情報 
              - <span class="mp-oas-code">status</span>フィールドは必ず<span class="mp-oas-code">REQSUCCESS</span>です。  
        redirectInformation:
          $ref: '#/components/schemas/RedirectInformation'
          description: |
            リダイレクト情報  
            認証コード入力画面に進むためのリダイレクトの情報です。  
            <span class="mp-oas-code">redirectType</span>フィールドは必ず<span class="mp-oas-code">VERIFY</span>です。  
            <span class="mp-oas-code">httpMethod</span>フィールドは必ず<span class="mp-oas-code">GET</span>です。
            お客様のブラウザを<span class="mp-oas-code">redirectUrl</span>にリダイレクトしてください。
    VerificationInquiryRequest:
      description: /verification/inquiry request body
      type: object
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
          description: |
            認証開始時に返る取引ID  
            認証IDを省略する場合、取引IDは必ず設定してください。  
            取引IDと認証IDを設定した場合、組み合わせが一致する認証情報が返ります。
        verificationId:
          $ref: '#/components/schemas/VerificationId'
          description: |
            認証開始時に設定した任意の認証ID  
            取引IDを省略する場合、認証IDは必ず設定してください。  
            取引IDと認証IDを設定した場合、組み合わせが一致する認証情報が返ります。
        additionalOptions:
          $ref: '#/components/schemas/AdditionalOptions'
    VerificationInquiryResponse:
      title: 本人確認
      description: /verification/inquiry response body
      type: object
      properties:
        verificationReference:
          $ref: '#/components/schemas/VerificationReference'
          description: null
    AccessId:
      type: string
      pattern: ^[a-zA-Z0-9]{32}$
      description: 取引ID
      example: acdc7d53f7a78f488d8d0997eff99c6f
    AccessPass:
      type: string
      pattern: ^[a-zA-Z0-9]{32}$
      description: 取引パスワード<br />OpenAPIタイプでは利用しません。モジュールタイプ・プロトコルタイプで利用します。
      example: 8edc86b5c8b34e92a224f577dec63990
    MemberId:
      type: string
      pattern: ^[a-zA-Z0-9@_.-]{1,60}$
      description: 会員ID
      example: member-001
    MemberName:
      type: string
      maxLength: 255
      description: |
        会員名  
        設定できる最大長はUTF-8で384byteです。
      example: TARO MIHON
    VerificationId:
      type: string
      pattern: ^[0-9a-zA-Z-]+$
      maxLength: 27
      description: 認証ID
      example: verification-001
    OnfileType:
      type: string
      description: |
        登録されている認証情報のタイプ  
        - <span class="mp-oas-code">CARD</span>：クレカ払い
        - <span class="mp-oas-code">WALLET</span>：Pay払い
      enum:
        - CARD
        - WALLET
      example: CARD
    OnfileCardType:
      type: string
      description: |
        登録されているカードのタイプ
        - <span class="mp-oas-code">CREDIT_CARD</span>：クレジットカード
        - <span class="mp-oas-code">APPLE_PAY</span>：Apple Pay
      enum:
        - CREDIT_CARD
        - APPLE_PAY
      example: CREDIT_CARD
    OnfileWalletType:
      type: string
      description: |
        登録済みPay払い利用承諾のタイプ  
        登録済みPay払い利用承諾のタイプによってパラメーターの設定要否が異なります。  
        詳細は[共通パラメーター対応表 - Pay払い](/mulpay/apis/openapi-type/common-parameters#pay払い)を参照ください。

         - <span class="mp-oas-code">PAYPAY</span>：PayPay
         - <span class="mp-oas-code">DOCOMO</span>：d払い
         - <span class="mp-oas-code">RAKUTEN</span>：楽天ペイ(オンライン決済)V2
         - <span class="mp-oas-code">AMAZON</span>：Amazon Pay V2
         - <span class="mp-oas-code">AU_APP</span>：au PAY(ネット支払い)アプリ方式
         - <span class="mp-oas-code">MERPAY</span>：メルペイ
      enum:
        - PAYPAY
        - DOCOMO
        - RAKUTEN
        - AMAZON
        - AU_APP
        - MERPAY
      example: PAYPAY
    OnfileCards:
      type: array
      description: 登録されたカード情報一覧
      items:
        $ref: '#/components/schemas/OnfileCardInformation'
    OnfileCardInformation:
      type: object
      description: 登録されたカード情報
      properties:
        type:
          $ref: '#/components/schemas/OnfileCardType'
        cardId:
          $ref: '#/components/schemas/OnfileCardId'
        index:
          $ref: '#/components/schemas/OnfileCardIndex'
        cardNumber:
          type: string
          description: |
            カード番号  
            下4桁(**********9999)固定でマスクされます。
          example: '**********1111'
        cardholderName:
          type: string
          description: カードの名義人
          example: TARO MIHON
        expiryMonth:
          type: string
          description: カードの有効期限(月)
          example: '06'
        expiryYear:
          type: string
          description: カードの有効期限(年)
          example: '2033'
        issuerCode:
          type: string
          description: カードの発行カード会社コード
          example: 2a99663
        brand:
          type: string
          description: カードのブランド
          enum:
            - VISA
            - MASTERCARD
            - JCB
            - DINERS
            - AMEX
            - UNKNOWN
          example: VISA
        isDefault:
          type: boolean
          description: |
            デフォルトカード判定  
            デフォルトカードの場合<span class="mp-oas-code">true</span>、そうでない場合<span class="mp-oas-code">false</span>です。
          example: true
    OnfileCardId:
      type: string
      pattern: ^[0-9]{1,4}$
      description: |
        カードのID  
        登録されているカードのID(物理連番)です。
      example: '0'
    OnfileCardIndex:
      type: string
      pattern: ^[0-4]$
      description: |
        カードのインデックス  
        登録されているカードの0から4までのインデックス番号(論理連番)です。  
        有効な(削除されていない)カードのIDを昇順に並べた順番です。  
        必ず1枚しか登録しない加盟店様がカードIDを保持することなく利用することを想定しています。
      example: '0'
    OnfileWallets:
      type: array
      description: 登録されたPay払い利用承諾情報一覧
      items:
        $ref: '#/components/schemas/OnfileWalletInformation'
    OnfileWalletInformation:
      type: object
      description: 登録されたPay払い利用承諾情報
      properties:
        onfileWalletType:
          $ref: '#/components/schemas/OnfileWalletType'
        acceptanceCode:
          type: string
          description: 利用承諾番号
          example: '12345'
    Status:
      type: string
      description: 取引のステータス
      oneOf:
        - $ref: '#/components/schemas/StatusCredit'
        - $ref: '#/components/schemas/StatusWallet'
        - $ref: '#/components/schemas/StatusCash'
    StatusCredit:
      title: クレカ払い
      type: string
      description: |
        クレカ払いの取引ステータス
        - <span class="mp-oas-code">UNPROCESSED</span>：未決済
        - <span class="mp-oas-code">AUTHENTICATED</span>：未決済(3DS登録済)
        - <span class="mp-oas-code">AUTH</span>：仮売上
        - <span class="mp-oas-code">CAPTURE</span>：即時売上
        - <span class="mp-oas-code">SALES</span>：実売上
        - <span class="mp-oas-code">CHECK</span>：有効性チェック
        - <span class="mp-oas-code">CANCEL</span>：キャンセル
      enum:
        - UNPROCESSED
        - AUTHENTICATED
        - AUTH
        - CAPTURE
        - SALES
        - CHECK
        - CANCEL
    StatusWallet:
      title: Pay払い
      type: string
      description: |
        Pay払いの取引ステータス  
        - <span class="mp-oas-code">UNPROCESSED</span>：未決済
        - <span class="mp-oas-code">REQSUCCESS</span>：要求成功
        - <span class="mp-oas-code">AUTHPROCESS</span>：認証処理中
        - <span class="mp-oas-code">AUTH</span>：仮売上
        - <span class="mp-oas-code">SALES</span>：実売上
        - <span class="mp-oas-code">CAPTURE</span>：即時売上
        - <span class="mp-oas-code">CANCEL</span>：キャンセル
        - <span class="mp-oas-code">RETURN</span>：返品
        - <span class="mp-oas-code">REQRETURN</span>：返品受付
        - <span class="mp-oas-code">PAYFAIL</span>：決済失敗
        - <span class="mp-oas-code">EXPIRED</span>：期限切れ
        - <span class="mp-oas-code">REGISTER</span>：利用承諾
        - <span class="mp-oas-code">END</span>：利用承諾終了
      enum:
        - UNPROCESSED
        - REQSUCCESS
        - AUTHPROCESS
        - AUTH
        - SALES
        - CAPTURE
        - CANCEL
        - RETURN
        - REQRETURN
        - PAYFAIL
        - EXPIRED
        - REGISTER
        - END
    StatusCash:
      title: 現金払い
      type: string
      description: |
        現金払いの取引ステータス  
        - <span class="mp-oas-code">UNPROCESSED</span>：未決済
        - <span class="mp-oas-code">REQSUCCESS</span>：要求成功
        - <span class="mp-oas-code">TRADING</span>：取引中
        - <span class="mp-oas-code">TRANSFERRED</span>：入金済み
        - <span class="mp-oas-code">PAYSUCCESS</span>：決済完了
        - <span class="mp-oas-code">EXPIRED</span>：期限切れ
        - <span class="mp-oas-code">CANCEL</span>：キャンセル
        - <span class="mp-oas-code">STOP</span>：取引停止
      enum:
        - UNPROCESSED
        - REQSUCCESS
        - TRADING
        - TRANSFERRED
        - PAYSUCCESS
        - EXPIRED
        - CANCEL
        - STOP
    StatusDeferred:
      title: 後払い
      type: string
      description: |
        後払いの取引ステータス  
        - <span class="mp-oas-code">UNPROCESSED</span>：未決済
        - <span class="mp-oas-code">PENDING</span>：保留
        - <span class="mp-oas-code">AUTH</span>：仮売上
        - <span class="mp-oas-code">SHIPPED</span>：出荷済
        - <span class="mp-oas-code">SALES</span>：実売上
        - <span class="mp-oas-code">CAPTURE</span>：即時売上
        - <span class="mp-oas-code">CANCEL</span>：キャンセル
        - <span class="mp-oas-code">RETURN</span>：返品
        - <span class="mp-oas-code">FORCECANCEL</span>：強制キャンセル
        - <span class="mp-oas-code">PAYFAIL</span>：決済失敗
      enum:
        - UNPROCESSED
        - PENDING
        - AUTH
        - SHIPPED
        - SALES
        - CAPTURE
        - CANCEL
        - RETURN
        - FORCECANCEL
        - PAYFAIL
    VerificationType:
      title: 認証方法
      type: string
      description: |
        認証方法
        - <span class="mp-oas-code">sms-pin</span>：SMS認証
      enum:
        - sms-pin
    VerificationStatus:
      title: 本人確認
      type: string
      description: |
        本人確認の認証ステータス  
        - <span class="mp-oas-code">REQSUCCESS</span>：要求成功
        - <span class="mp-oas-code">SUCCESS</span>：認証成功
        - <span class="mp-oas-code">FAILURE</span>：認証失敗
        - <span class="mp-oas-code">CANCEL</span>：キャンセル
      enum:
        - REQSUCCESS
        - SUCCESS
        - FAILURE
        - CANCEL
    Merchant:
      type: object
      description: |
        加盟店(ショップ)情報  
        決済手段ごとの設定要否や各パラメーターの用途は、詳細は[共通パラメーター対応表](/mulpay/apis/openapi-type/common-parameters)を参照ください。
      required:
        - name
        - nameKana
        - nameAlphabet
        - nameShort
        - contactName
        - contactPhone
        - contactOpeningHours
      properties:
        name:
          type: string
          description: |
            表示用の加盟店様名  
            設定できる最大長はUTF-8で45byteです。
          maxLength: 30
          example: サンプルストア
        nameKana:
          type: string
          pattern: ^[ァ-ヶー　]+$
          description: |
            表示用の加盟店様名(全角カナのみ)  
            設定できる最大長はUTF-8で60byteです。
          example: ジーエムオーストア
        nameAlphabet:
          type: string
          description: |
            表示用の加盟店様名(英名)
          maxLength: 25
          pattern: ^[a-zA-Z0-9 \x2c-\x2f]+$
          example: Sample Store
        nameShort:
          type: string
          description: |
            表示用の加盟店様名(略称)  
            設定できる最大長はUTF-8で45byteです。
          maxLength: 30
          example: サンプル
        contactName:
          type: string
          description: |
            加盟店様の問い合わせ先名称  
            設定できる最大長はUTF-8で63byteです。
          maxLength: 42
          example: サポート窓口
        contactEmail:
          type: string
          format: email
          description: |
            加盟店様の問い合わせ先メールアドレス  
            [RFC 5322](https://www.rfc-editor.org/rfc/rfc5322)の仕様に沿った形式のみ許可されます。  
            #### 決済手段ごとの制限事項  
            - d払い: <span class="mp-oas-code">contactEmail</span>,<span class="mp-oas-code">contactUrl</span>,<span class="mp-oas-code">contactPhone</span>の合計が96byte以下  
            ※<span class="mp-oas-code">/</span>(半角スラッシュ)は4byteとしてカウント  
          maxLength: 254
          example: support@example.com
        contactUrl:
          type: string
          format: uri
          description: |
            加盟店様の問い合わせ先ページURL  
            #### 決済手段ごとの制限事項  
            - d払い: <span class="mp-oas-code">contactEmail</span>,<span class="mp-oas-code">contactUrl</span>,<span class="mp-oas-code">contactPhone</span>の合計が96byte以下  
            ※<span class="mp-oas-code">/</span>(半角スラッシュ)は4byteとしてカウント  
          maxLength: 256
          example: https://example.com/contact
        contactPhone:
          type: string
          description: |
            加盟店様の問い合わせ先電話番号  
            #### 決済手段ごとの制限事項  
            - d払い: <span class="mp-oas-code">contactEmail</span>,<span class="mp-oas-code">contactUrl</span>,<span class="mp-oas-code">contactPhone</span>の合計が96byte以下  
            ※<span class="mp-oas-code">/</span>(半角スラッシュ)は4byteとしてカウント  
          maxLength: 13
          pattern: ^[0-9-]+$
          example: 0120-123-456
        contactOpeningHours:
          type: string
          description: |
            加盟店様の問い合わせ窓口の営業時間(HH:MM-HH:MM形式)
          maxLength: 11
          pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]-([0-1]?[0-9]|2[0-3]):[0-5][0-9]$
          example: 10:00-18:00
        stores:
          type: array
          description: 店舗情報の一覧
          items:
            $ref: '#/components/schemas/Store'
        callbackUrl:
          type: string
          format: uri
          description: |
            コールバックURL  
            リダイレクトが発生するリクエスト時は必ず設定してください。  
            リダイレクト後に加盟店様のサーバーに処理の遷移を戻すためのURLです。  
            詳細は[リダイレクトとコールバック](/mulpay/docs/connection-method/openapi-type/callback-webhook)を参照ください。
          maxLength: 256
          example: https://example.com/callback
        webhookUrl:
          type: string
          format: uri
          description: |
            Webhook URL  
            現金払いの支払いなど、処理が非同期で行われた場合に、その結果を通知するための加盟店様側のURLです。  
            httpsから始まるURLを設定してください。  
            ※テスト環境ではhttpの指定が可能です。  
            詳細は[Webhook](/mulpay/apis/openapi-type/events)を参照ください。
          maxLength: 256
          example: https://example.com/webhook
        csrfToken:
          type: string
          description: |
            CSRFトークン  
            コールバックやWebhookの呼び出し時につける任意のパラメーターです。  
            CSRF対策のために利用してください。  
            詳細は[リダイレクトとコールバック](/mulpay/docs/connection-method/openapi-type/callback-webhook)を参照ください。
          maxLength: 36
          pattern: ^[0-9a-zA-Z-]+$
          example: bdb04c5f-42f0-29e2-0979-edae3e7760bf
    Store:
      type: object
      description: |
        店舗情報  
      properties:
        id:
          type: string
          description: |
            店舗のID  
            #### 決済手段ごとの制限事項  
            - メルペイ: <span class="mp-oas-code">name</span>が設定されている場合必須  
          maxLength: 50
          pattern: ^[0-9a-zA-Z-_]+$
          example: '001'
        name:
          type: string
          description: |
            店舗の名称  
            #### 決済手段ごとの制限事項  
            - メルペイ: <span class="mp-oas-code">id</span>が設定されている場合必須  
          maxLength: 50
          example: 渋谷支店
    Order:
      type: object
      description: |
        取引情報  
        決済手段ごとの設定要否や各パラメーターの用途は、詳細は[共通パラメーター対応表](/mulpay/apis/openapi-type/common-parameters)を参照ください。
      required:
        - orderId
        - amount
        - transactionType
      properties:
        orderId:
          $ref: '#/components/schemas/OrderId'
          description: |
            この取引に対する任意のオーダーID  
            加盟店様にてユニークな値を発行してください。
        amount:
          type: string
          description: |
            税送料込の取引金額  
            決済手段により設定可能な値が異なります。
          maxLength: 15
          pattern: ^[0-9]{1,15}$
          example: '1000'
        currency:
          type: string
          description: |
            通貨コード  
            ISO 4217のアルファベット3文字を設定します。  
            例えば日本円の場合<span class="mp-oas-code">JPY</span>です。  
            省略時は<span class="mp-oas-code">JPY</span>です。  
            <span > ※現時点では<span class="mp-oas-code">JPY</span>のみ利用可能です。</span>
          default: JPY
          pattern: ^[A-Z]{3}$
          example: JPY
        clientFields:
          $ref: '#/components/schemas/ClientFields'
        items:
          type: array
          description: 商品情報の一覧
          items:
            $ref: '#/components/schemas/Item'
        transactionType:
          $ref: '#/components/schemas/TransactionType'
        shippingAddress:
          $ref: '#/components/schemas/Address'
          description: 配送先住所情報
        addressMatch:
          type: boolean
          description: |
            配送先住所と請求先住所が同じ場合は<span class="mp-oas-code">true</span>を設定します。  
            住所はいずれかのみ設定してください。
          default: false
        billingAddress:
          $ref: '#/components/schemas/Address'
          description: 請求先住所情報
    OrderWithoutAmount:
      type: object
      description: 取引情報
      required:
        - orderId
        - transactionType
      properties:
        orderId:
          $ref: '#/components/schemas/OrderId'
          description: |
            この取引に対する任意のオーダーID  
            加盟店様にてユニークな値を発行してください。
        clientFields:
          $ref: '#/components/schemas/ClientFields'
        items:
          type: array
          description: |
            商品情報の一覧  
            #### 決済手段ごとの制限事項  
            - 楽天ペイ(オンライン決済)V2 利用承諾: <span >required</span>
            - クレジットカード(Forter利用時)(Enterprise加盟店様のみ): <span >required</span>
          items:
            $ref: '#/components/schemas/Item'
        transactionType:
          $ref: '#/components/schemas/TransactionType'
        shippingAddress:
          $ref: '#/components/schemas/Address'
          description: 配送先住所情報
        addressMatch:
          type: boolean
          description: |
            配送先住所と請求先住所が同じ場合は<span class="mp-oas-code">true</span>を設定します。  
            住所はいずれかのみ設定してください。
          default: false
        billingAddress:
          $ref: '#/components/schemas/Address'
          description: 請求先住所情報
    OrderId:
      type: string
      maxLength: 27
      pattern: ^[0-9a-zA-Z-]+$
      example: order-001
    Item:
      type: object
      description: |
        商品情報  
      required:
        - name
        - quantity
        - type
        - price
      properties:
        name:
          type: string
          description: |
            商品の名称  
            設定できる最大長はUTF-8で192byteです。  
            #### 決済手段ごとの制限事項  
            - マイペイメント : <span >required</span>   
              <span class="mp-oas-code"> ( ) . / - ｢ ｣ : </span>および半角スペース以外の半角記号は使用不可
            - アトカラ: [取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で必須
            - クレジットカード(Forter利用時)(Enterprise加盟店様のみ): <span >required</span>
          maxLength: 128
          example: コーヒー豆
        description:
          type: string
          description: |
            商品の説明  
            設定できる最大長はUTF-8で180byteです。
            #### 決済手段ごとの制限事項  
            - メルペイ（利用承諾のみ）: <span >required</span>
          maxLength: 120
          example: コーヒー豆の説明
        quantity:
          type: integer
          description: |
            商品の購入数  
            #### 決済手段ごとの制限事項  
            - アトカラ: [取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で必須
            - クレジットカード(Forter利用時)(Enterprise加盟店様のみ): <span >required</span>
          maximum: 9999
          example: 3
        type:
          type: string
          description: |
            商品のタイプ
            - <span class="mp-oas-code">DIGITAL</span>：デジコン
            - <span class="mp-oas-code">PHYSICAL</span>：物販
            - <span class="mp-oas-code">SERVICE</span>：役務
            #### 決済手段ごとの制限事項  
            - クレジットカード(Forter利用時)(Enterprise加盟店様のみ): <span >required</span>
          enum:
            - DIGITAL
            - PHYSICAL
            - SERVICE
          example: DIGITAL
        price:
          type: string
          description: |
            商品の単価  
            <span class="mp-oas-code">order.amount</span>以下の値を設定してください。  
            #### 決済手段ごとの制限事項  
            - クレジットカード(ReD Shield利用時): <span class="mp-oas-code"><= 12 characters</span>
            - メルペイ: <span class="mp-oas-code"><= 7 characters</span>
            - アトカラ: [取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で必須　<span class="mp-oas-code"><= 6 characters</span>
            - クレジットカード(Forter利用時)(Enterprise加盟店様のみ): <span >required</span>
          maxLength: 15
          example: '2000'
        category:
          type: string
          pattern: ^[0-9]{4}$
          description: |
            商品の[Merchant category code(MCC)](https://en.wikipedia.org/wiki/Merchant_category_code)  
            MCCは[ISO 18245](https://www.iso.org/standard/33365.html)で定められた加盟店様の業種カテゴリです。  
            一般的には加盟店様の業種カテゴリと商品のカテゴリは同じですが、この商品により適したものがあれば個別に設定できます。  
            #### 決済手段ごとの制限事項  
            - メルペイ: <span >required</span>
          example: '5451'
        productId:
          type: string
          description: |
            商品の識別番号  
            加盟店様が商品ごとに一意に採番した番号です。  
            半角のみ設定可能です。  
            #### 決済手段ごとの制限事項  
            - クレジットカード(ReD Shield利用時): <span class="mp-oas-code"><= 18 characters</span>
          maxLength: 30
          example: '123456789012'
        productCode:
          type: string
          description: |
            商品の識別コード  
            [JANコード](https://www.gs1jp.org/code/jan/about_jan.html)や[UPCコード](https://www.gs1jp.org/code/upc/)を設定します。
            半角のみ設定可能です。
          maxLength: 13
          example: '1234567890123'
    TransactionType:
      type: string
      description: |
        取引タイプ  
        この取引がお客様操作によって開始されたか、自動チャージのように加盟店様操作で行われたかを示します。  
        現時点では設定する値によって当サービス内の処理は変わりません。
        - <span class="mp-oas-code">CIT</span>: Customer Initiated Transaction(お客様操作起点)  
        - <span class="mp-oas-code">MIT</span>: Merchant Initiated Transaction(加盟店様操作起点)  
        - <span class="mp-oas-code">OTHER</span>: 上記以外
      enum:
        - CIT
        - MIT
        - OTHER
      example: CIT
      default: CIT
    Address:
      type: object
      description: 住所情報
      required:
        - name
        - line1
        - city
        - state
        - postCode
      properties:
        name:
          type: string
          description: |
            住所の宛名  
            設定できる最大長はUTF-8で60byteです。
          maxLength: 40
          example: 見本 太郎
        line1:
          type: string
          description: |
            配送先住所1  
            設定できる最大長はUTF-8で75byteです。
          maxLength: 50
          example: 道玄坂1丁目2-3
        line2:
          type: string
          description: |
            配送先住所2  
            設定できる最大長はUTF-8で75byteです。
            #### 決済手段ごとの制限事項  
            - アトカラ: [取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で配送先情報と購入者情報が異なる場合は必須
          maxLength: 50
          example: 渋谷ビル1F
        line3:
          type: string
          description: |
            配送先住所3  
            設定できる最大長はUTF-8で75byteです。
            #### 決済手段ごとの制限事項  
            - アトカラ: [取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で配送先情報と購入者情報が異なる場合は必須
          maxLength: 50
          example: 1号室
        city:
          type: string
          description: |
            住所の市区町村  
            「渋谷区」「横浜市」などの市区町村名です。  
            海外住所の場合は「Los Angeles」などの都市名または、それに相当する自治体名（市・町・村など）を入力してください。  
            設定できる最大長はUTF-8で75byteです。<br />
            #### 決済手段ごとの制限事項
            - アトカラ: [取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で配送先情報と購入者情報が異なる場合は必須
          maxLength: 50
          example: 渋谷区
        state:
          type: string
          maxLength: 3
          pattern: ^[0-9a-zA-Z]+$
          description: |
            住所の地域コード  
            国内の場合は001〜047からなる[都道府県コード](https://nlftp.mlit.go.jp/ksj/gml/codelist/PrefCd.html)を先頭ゼロ埋め3桁の形式で設定します。  
            海外住所の場合は「CA(California)」などの州・省コードを設定します。<br />
            #### 決済手段ごとの制限事項 
            - アトカラ: [取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で配送先情報と購入者情報が異なる場合は必須
          example: '013'
        postCode:
          type: string
          maxLength: 16
          pattern: ^[0-9a-zA-Z-\s]+$
          description: |
            住所の郵便番号<br />ハイフンの有無は問いません。  
            海外住所の場合は「ZIP code」「Postal code」等に該当する番号を入力してください。<br />
            #### 決済手段ごとの制限事項  
            - クレジットカード ReD Shield: <span class="mp-oas-code"><= 9 characters</span>
            - アトカラ: [取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で配送先情報と購入者情報が異なる場合は必須
          example: 150-0043
        country:
          type: string
          pattern: ^[0-9]{3}$
          description: |
            住所の国番号<br />ISO3166-1の数字3桁を設定します。  
            ITU-E.164ではないのでご注意ください。例えば日本の場合「392」です。
            #### 決済手段ごとの制限事項
            クレジットカード（3Dセキュア認証利用時のみ）: <span >required</span>
          example: '392'
    CustomerShippingAddress:
      type: object
      properties:
        name:
          type: string
          description: 氏名
          example: 見本 太郎
        line1:
          type: string
          description: 配送先住所1
          example: 渋谷区道玄坂
        line2:
          type: string
          description: 配送先住所2
          example: 1丁目2-3
        line3:
          type: string
          description: 配送先住所3
          example: 見本マンション101
        state:
          type: string
          description: 住所の都道府県
          example: 東京都
        postCode:
          type: string
          pattern: ^[0-9a-zA-Z-\s]+$
          description: 住所の郵便番号
          example: 150-0043
        country:
          type: string
          description: |
            住所の国コード  
            ISO3166-1の英字2桁
          example: JP
        phone:
          type: string
          description: 電話番号
          example: 090-1234-5678
        city:
          type: string
          description: |
            住所の市区町村<br />
            海外住所の場合のみ設定されます。
    CustomerBillingAddress:
      type: object
      properties:
        name:
          type: string
          description: 氏名
          example: 見本 太郎
        line1:
          type: string
          description: 請求先住所1
          example: 渋谷区道玄坂
        line2:
          type: string
          description: 請求先住所2
          example: 1丁目2-3
        line3:
          type: string
          description: 請求先住所3
          example: 見本マンション101
        state:
          type: string
          description: 住所の都道府県
          example: 東京都
        postCode:
          type: string
          pattern: ^[0-9a-zA-Z-\s]+$
          description: 住所の郵便番号
          example: 150-0043
        country:
          type: string
          description: |
            住所の国コード  
            ISO3166-1の英字2桁
          example: JP
        phone:
          type: string
          description: 電話番号
          example: 090-1234-5678
    Payer:
      type: object
      description: |
        購入者情報  
        決済手段ごとの設定要否や各パラメーターの用途は、詳細は[共通パラメーター対応表](/mulpay/apis/openapi-type/common-parameters)を参照ください。
      required:
        - name
      properties:
        name:
          type: string
          description: |
            購入者の氏名(フルネーム)  
            設定できる最大長はUTF-8で60byteです。
          maxLength: 40
          example: 見本 太郎
        nameKana:
          type: string
          pattern: ^[ァ-ヶー　]+$
          description: |
            購入者の氏名(全角カナのみ)  
            設定できる最大長はUTF-8で60byteです。  
            #### 決済手段ごとの制限事項  
            - コンビニ: <span >required</span>  
            - Pay-easy: <span >required</span>
          example: ミホン　タロウ
        nameAlphabet:
          type: string
          description: |
            購入者の氏名(英名)  
            #### 決済手段ごとの制限事項  
            - クレジットカード(Forter利用時)(Enterprise加盟店様のみ): <span >required</span>
          maxLength: 30
          pattern: ^[a-zA-Z0-9 \x2c-\x2f]+$
          example: Taro Mihon
        gender:
          type: string
          description: |
            購入者の性別
          enum:
            - MALE
            - FEMALE
            - OTHER
          example: MALE
        dateOfBirth:
          type: string
          description: |
            購入者の誕生日  
            YYYYMMDD形式
          example: '19950308'
        email:
          type: string
          format: email
          description: |
            購入者のメールアドレス  
            [RFC 5322](https://www.rfc-editor.org/rfc/rfc5322)の仕様に沿った形式のみ許可されます。
          maxLength: 254
          example: taro.mihon@example.com
        deliveryEmail:
          type: string
          format: email
          description: |
            取引内容がWebチケットなどの電子デリバリーの場合、配信先のメールアドレスを設定します。  
            [RFC 5322](https://www.rfc-editor.org/rfc/rfc5322)の仕様に沿った形式のみ許可されます。
          maxLength: 254
          example: taro.mihon.delivery@example.com
        phones:
          type: array
          description: 購入者の電話情報一覧
          items:
            $ref: '#/components/schemas/Phone'
        accountId:
          type: string
          description: 加盟店様サイト上における購入者のアカウントIDなど、一意に識別するためのID
          maxLength: 60
          pattern: ^[a-zA-Z0-9@_.-]{1,60}$
          example: account_123
        ip:
          type: string
          description: |
            購入者の発信元IPアドレス  
            #### 決済手段ごとの制限事項  
            - クレジットカード(Forter利用時)(Enterprise加盟店様のみ): <span >required</span>
          maxLength: 39
          example: 172.16.0.1
        deviceType:
          type: string
          description: |
            購入者のデバイス情報をWeb、アプリから選択  
            - <span class="mp-oas-code">PC_WEB</span>：PC(Web)
            - <span class="mp-oas-code">PC_APP</span>：PC(アプリ)
            - <span class="mp-oas-code">MOBILE_WEB</span>：モバイル(Web)
            - <span class="mp-oas-code">MOBILE_APP</span>：モバイル(アプリ) 
            #### 決済手段ごとの制限事項  
            - クレジットカード(Forter利用時): <span >required</span>
          enum:
            - PC_WEB
            - PC_APP
            - MOBILE_WEB
            - MOBILE_APP
          example: PC_WEB
        osType:
          type: string
          description: |
            購入者のデバイスのOS  
            - <span class="mp-oas-code">IOS</span>：iOS
            - <span class="mp-oas-code">ANDROID</span>：Android  
            #### 決済手段ごとの制限事項  
            - Alipay: <span class="mp-oas-code">transitionType</span>が<span class="mp-oas-code">APP_LINK</span>の場合は必須          
          enum:
            - IOS
            - ANDROID
          example: IOS
        httpUserAgent:
          type: string
          description: |
            購入者のブラウザのUserAgent  
            半角英数字記号が設定可能です。
          maxLength: 512
          example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.61 Safari/537.36
    CreditInformation:
      oneOf:
        - $ref: '#/components/schemas/CreditTokenInformation'
        - $ref: '#/components/schemas/CreditPanInformation'
    CreditPanInformation:
      title: 直接設定
      type: object
      description: クレカ払い情報(直接)
      required:
        - card
        - creditChargeOptions
      properties:
        card:
          $ref: '#/components/schemas/Card'
        creditChargeOptions:
          $ref: '#/components/schemas/CreditChargeOptions'
    CreditTokenInformation:
      title: トークン化して設定
      type: object
      description: クレカ払い情報(トークン化)
      required:
        - tokenizedCard
        - creditChargeOptions
      properties:
        tokenizedCard:
          $ref: '#/components/schemas/TokenizedCard'
        creditChargeOptions:
          $ref: '#/components/schemas/CreditChargeOptions'
    CreditOnfileInformation:
      type: object
      description: 登録済みクレカ払い情報
      required:
        - onfileCard
        - creditChargeOptions
      properties:
        onfileCard:
          $ref: '#/components/schemas/OnfileCard'
        creditChargeOptions:
          $ref: '#/components/schemas/CreditChargeOptions'
    Tds2Information:
      type: object
      description: 3Dセキュア情報
      properties:
        tds2Options:
          $ref: '#/components/schemas/Tds2Options'
        tds2Data:
          $ref: '#/components/schemas/Tds2Data'
    FraudDetectionInformation:
      type: object
      description: 不正検知情報
      required:
        - fraudDetectionOptions
      properties:
        fraudDetectionOptions:
          $ref: '#/components/schemas/FraudDetectionOptions'
        fraudDetectionData:
          $ref: '#/components/schemas/FraudDetectionData'
        fraudDetectionCustomData:
          $ref: '#/components/schemas/FraudDetectionCustomData'
        fraudDetectionForterData:
          $ref: '#/components/schemas/FraudDetectionForterData'
    FraudDetectionForterData:
      description: |
        #### 決済手段ごとの制限事項  
          - クレジットカード(Forter利用時): <span >required</span>
      oneOf:
        - $ref: '#/components/schemas/BasicInformation'
        - $ref: '#/components/schemas/EnterpriseInformation'
    EnterpriseInformation:
      title: Enterprise加盟店
      type: object
      description: |
        Enterprise加盟店  
        業種ごとに不正検知に必要な追加情報を設定してください。
      required:
        - connectionInformation
        - cartItems
      properties:
        followForter:
          $ref: '#/components/schemas/followForter'
        connectionInformation:
          $ref: '#/components/schemas/connectionInformation'
        totalDiscount:
          $ref: '#/components/schemas/totalDiscount'
        accountOwner:
          $ref: '#/components/schemas/accountOwner'
        cartItems:
          $ref: '#/components/schemas/cartItems'
        customerAccountData:
          $ref: '#/components/schemas/customerAccountData'
        primaryDeliveryDetails:
          $ref: '#/components/schemas/primaryDeliveryDetails'
        primaryRecipient:
          $ref: '#/components/schemas/primaryRecipient'
        additionalIdentifiers:
          $ref: '#/components/schemas/additionalIdentifiers'
        additionalInformation:
          $ref: '#/components/schemas/additionalInformation'
    BasicInformation:
      title: Basic加盟店
      type: object
      description: Basic加盟店
      required:
        - connectionInformation
      properties:
        followForter:
          $ref: '#/components/schemas/followForter'
        connectionInformation:
          $ref: '#/components/schemas/connectionInformation'
        additionalInformation:
          $ref: '#/components/schemas/additionalInformation'
    Phone:
      type: object
      description: 電話情報
      properties:
        type:
          type: string
          description: |
            電話のタイプ  
            携帯、家、職場、その他から選択します。  
            - <span class="mp-oas-code">MOBILE</span>：携帯電話
            - <span class="mp-oas-code">HOME</span>：固定電話
            - <span class="mp-oas-code">WORK</span>：勤務先
            - <span class="mp-oas-code">OTHER</span>：その他

            #### 決済手段ごとの制限事項  
            - クレジットカード（3Dセキュア認証利用時のみ）: <span >required</span>、<span class="mp-oas-code">OTHER</span>以外 
          enum:
            - MOBILE
            - HOME
            - WORK
            - OTHER
          example: MOBILE
        countryCode:
          type: string
          pattern: ^[0-9]{1,3}$
          description: |
            電話の国コード  
            ITU-E.164の1～3桁の数字を設定します。  
            ISO3166-1ではないのでご注意ください。  
            プラス記号(+)はつけないでください。  
            例として日本の場合は「81」です。  
            #### 決済手段ごとの制限事項  
            - クレジットカード（3Dセキュア認証利用時のみ）: <span >required</span>  
          example: '81'
        number:
          type: string
          pattern: ^[0-9-]+$
          maxLength: 13
          description: |
            電話番号  
            ハイフンの有無は問いません。  
            #### 決済手段ごとの制限事項  
            - クレジットカード（3Dセキュア認証利用時のみ）: <span >required</span>  
            - コンビニ: <span >required</span>  
            - Pay-easy: <span >required</span>  
          example: 090-1234-5678
    ClientFields:
      type: object
      description: 加盟店自由項目
      properties:
        clientField1:
          type: string
          description: |
            加盟店自由項目1  
            この取引に関する任意情報を紐づけます。  
            決済の情報としては利用されません。  
            またお客様には表示されません。  
            [取引照会API(/order/inquiry)](/mulpay/apis/openapi-type/order-inquiry)、管理画面、取引配信ファイルで値を確認できます。  
            設定できる最大長はEUC-JPで100byteです。  
            半角英数字、半角記号(除く<span class="mp-oas-code"> ^ ` { | } ~ & <> " ' </span> ) 、全角文字が設定可能です。
          maxLength: 100
          example: 加盟店自由項目1
        clientField2:
          type: string
          description: |
            加盟店自由項目2  
            「加盟店自由項目1」の説明を参照ください。  
          maxLength: 100
          example: 加盟店自由項目2
        clientField3:
          type: string
          description: |
            加盟店自由項目3  
            「加盟店自由項目1」の説明を参照ください。  
          maxLength: 100
          example: 加盟店自由項目3
    Card:
      type: object
      description: カード情報
      required:
        - cardNumber
        - expiryMonth
        - expiryYear
      properties:
        cardNumber:
          type: string
          pattern: ^[0-9]{12,16}$
          description: カード番号<br />ハイフンは含めないでください。
          example: '4111111111111111'
        cardholderName:
          type: string
          pattern: ^[a-zA-Z0-9- ]{1,50}$
          description: カード名義人
          example: TARO MIHON
        expiryMonth:
          type: string
          pattern: ^[0-9]{2}$
          description: カード有効期限(月)
          example: '01'
        expiryYear:
          type: string
          pattern: ^[0-9]{4}$
          description: カード有効期限(年)
          example: '2033'
        securityCode:
          type: string
          pattern: ^[0-9]{3,4}$
          description: セキュリティコード<br />CVCやCVVとも呼ばれます。
          example: '000'
    TokenizedCard:
      type: object
      description: トークン化されたカード情報
      required:
        - type
        - token
      properties:
        type:
          type: string
          description: |
            カード情報トークンのタイプ  
            カード情報トークン<span class="mp-oas-code">token</span>と合わせて設定してください。  
            - <span class="mp-oas-code">MP_TOKEN</span>: MPクレカトークン  
            - <span class="mp-oas-code">APPLE_PAY_TOKEN</span>: Apple Payトークン  
            - <span class="mp-oas-code">GOOGLE_PAY_TOKEN</span>: Google Payトークン
          enum:
            - MP_TOKEN
            - APPLE_PAY_TOKEN
            - GOOGLE_PAY_TOKEN
          example: MP_TOKEN
        token:
          type: string
          description: |
            カード情報トークン  
            カード情報トークンのタイプ<span class="mp-oas-code">type</span>と合わせて設定してください。  
            - MPクレカトークン  
              カード情報をトークン化した値です。  

            - Apple Payトークン  
              Apple Payに対応した端末で取得したApple PayのPayment tokenをbase64エンコードした値です。  

            - Google Payトークン  
              Google Pay APIで取得したPayment tokenをbase64エンコードした値です。  

            ***
            カード情報トークンとカード情報を両方設定した場合は以下の通りです。
            - PCI DSSの認定を得ている加盟店様  
            カード情報トークンが優先的に利用されます。  
            - PCI DSSの認定を得ていない加盟店様  
            契約不備のエラーになります。
          example: Lg9sRgo5nx6yfefJ51z8bj/1VdNFAaCZYWZ+qLKJyqWwBS7yYvxSiC0zeMVH+O4F
        cardholderName:
          type: string
          pattern: ^[a-zA-Z0-9- ]+$
          description: |
            カード名義人  
            <span class="mp-oas-code">type</span>が<span class="mp-oas-code">GOOGLE_PAY_TOKEN</span>の場合はカード名義人の指定が可能です。  
            <span class="mp-oas-code">GOOGLE_PAY_TOKEN</span>以外の場合は設定しても無視されます。
          example: TARO MIHON
    Referrer:
      type: object
      description: |
        参照元取引情報
      required:
        - accessId
      properties:
        accessId:
          type: string
          description: 取引ID
          example: acdc7d53f7a78f488d8d0997eff99c6f
    OnfileCard:
      type: object
      description: 登録されているカード情報
      required:
        - memberId
        - type
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: |
            会員のID
        type:
          $ref: '#/components/schemas/OnfileCardType'
        cardId:
          $ref: '#/components/schemas/OnfileCardId'
          description: |
            登録されているカードのうち、今回利用するカードのID(物理連番)  
            <span class="mp-oas-code">cardId</span>と<span class="mp-oas-code">index</span>の両方を省略した場合はデフォルトカードが使われます。
        index:
          $ref: '#/components/schemas/OnfileCardIndex'
          description: |
            登録されているカードのうち、今回利用するカードのインデックス(論理連番)  
            <span class="mp-oas-code">cardId</span>が設定されている場合は<span class="mp-oas-code">cardId</span>が優先されます。  
            <span class="mp-oas-code">cardId</span>と<span class="mp-oas-code">index</span>の両方を省略した場合はデフォルトカードが使われます。
        cardholderName:
          type: string
          pattern: ^[a-zA-Z0-9- ]+$
          description: |
            カード名義人  
            <span class="mp-oas-code">type</span>が<span class="mp-oas-code">APPLE_PAY</span>の場合は設定しても無視されます。  
            - 省略した場合：登録済みのカード情報に保存されているカード名義人を使用します。  
            - 指定した場合：設定したカード名義人を、既存のカード情報に保存されているカード名義人よりも優先して使用します。随時支払いまたは有効性確認が完了後、既存のカード情報のカード名義人も、この新しく設定したカード名義人で更新します。
          example: TARO MIHON
    OnfileCardWithoutCardholderName:
      type: object
      description: 登録されているカード情報
      required:
        - memberId
        - type
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: |
            会員のID
        type:
          $ref: '#/components/schemas/OnfileCardType'
          description: |
            登録されているカードのタイプ  
            - <span class="mp-oas-code">CREDIT_CARD</span>：クレジットカード
            - <span class="mp-oas-code">APPLE_PAY</span>：Apple Pay
        cardId:
          $ref: '#/components/schemas/OnfileCardId'
          description: |
            登録されているカードのうち、今回利用するカードのID(物理連番)  
            <span class="mp-oas-code">cardId</span>と<span class="mp-oas-code">index</span>の両方を省略した場合はデフォルトカードが使われます。
        index:
          $ref: '#/components/schemas/OnfileCardIndex'
          description: |
            登録されているカードのうち、今回利用するカードのインデックス(論理連番)  
            <span class="mp-oas-code">cardId</span>が設定されている場合は<span class="mp-oas-code">cardId</span>が優先されます。  
            <span class="mp-oas-code">cardId</span>と<span class="mp-oas-code">index</span>の両方を省略した場合はデフォルトカードが使われます。
    CreditChargeOptions:
      type: object
      required:
        - authorizationMode
      description: クレカ払いオプション情報
      properties:
        authorizationMode:
          type: string
          description: |
            支払い要求のタイプ  
            - <span class="mp-oas-code">AUTH</span>：仮売上
            - <span class="mp-oas-code">CAPTURE</span>：即時売上
          enum:
            - AUTH
            - CAPTURE
          example: AUTH
          default: AUTH
        useTds2:
          type: boolean
          description: |
            3Dセキュア認証の利用有無  
            - <span class="mp-oas-code">true</span>: 3Dセキュア認証を利用します。  
            - <span class="mp-oas-code">false</span>: 3Dセキュア認証を利用しません。この取引が不正利用によりチャージバックとなった場合、加盟店様が支払いの責任を負う可能性があります。
            Apple Payは利用できません。
          default: true
          example: true
        useFraudDetection:
          type: boolean
          description: |
            不正検知の利用有無  
            Apple Payは利用できません。
          default: false
          example: true
        itemCode:
          $ref: '#/components/schemas/ItemCode'
        paymentMethod:
          type: string
          description: |
            支払方法  
            Apple Payは一括払い固定になります。  
            - <span class="mp-oas-code">ONE_TIME</span>：一括
            - <span class="mp-oas-code">INSTALLMENT</span>：分割
            - <span class="mp-oas-code">BONUS_ONE_TIME</span>：ボーナス一括
            - <span class="mp-oas-code">REVOLVING</span>：リボ
          enum:
            - ONE_TIME
            - INSTALLMENT
            - BONUS_ONE_TIME
            - REVOLVING
          example: ONE_TIME
          default: ONE_TIME
        installments:
          type: string
          pattern: ^[0-9]{1,2}$
          description: |
            分割回数  
            支払方法が分割の場合に設定します。  
            設定可能な分割回数は契約により異なります。
          example: '5'
    CreditVerificationOptions:
      type: object
      description: カード有効性確認オプション情報
      properties:
        useTds2:
          type: boolean
          description: |
            3Dセキュア認証の利用有無  
            <span class="mp-oas-code">true</span>、または設定なしの場合は、3Dセキュア認証が行われます。  
          default: true
          example: true
        itemCode:
          $ref: '#/components/schemas/ItemCode'
    ItemCode:
      type: string
      pattern: ^0000[0-9]{3}$
      description: |
        商品番号  
        加盟店様とカード会社との契約で定められた場合のみ設定します。  
        省略時はデフォルトで「0000990」が設定されます。
      example: '0000990'
      default: '0000990'
    OnfileCardOptions:
      type: object
      required:
        - memberId
      description: |
        カード登録オプション情報  
        カード情報を会員に紐づけて登録する必要がない場合は、このパラメーターを設定しないでください。
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: |
            カード情報を登録する対象の会員ID  
            該当する会員IDが存在しない場合は登録できませんが、<span class="mp-oas-code">createNewMember</span>パラメーターを<span class="mp-oas-code">true</span>にすることで会員IDを新規登録します。
        memberName:
          $ref: '#/components/schemas/MemberName'
          description: |
            新規登録する会員の名称  
            会員を新規登録する場合にのみ設定できます。  
            カードの追加・更新時に設定してもエラーにはなりませんが、会員の名称は更新されません。
        cardId:
          $ref: '#/components/schemas/OnfileCardId'
          description: |
            更新するカードのID(物理連番)  
            登録済みのカード情報を上書きして保存する場合に該当のカードIDを設定します。  
            新規で追加保存する場合は設定不要です。  
            最大で5枚のカードを登録できます。
        createNewMember:
          type: boolean
          description: |
            会員ID未登録時の新規作成  
            <span class="mp-oas-code">true</span>にすると、指定した会員IDが存在しない場合に新規登録します。
          default: false
        setDefault:
          type: boolean
          description: |
            デフォルト設定  
            <span class="mp-oas-code">true</span>にすると、このカードがデフォルトカードとして登録されます。  
            デフォルトカードにした場合、随時支払い時にカードのID(物理連番)<span class="mp-oas-code">cardId</span>、またインデックス(論理連番)<span class="mp-oas-code">index</span>の設定が不要です。  
            また、洗替や一括決済サービス時に「カード登録連番」を設定することなく利用できます。
          default: false
        duplicationCheckOptions:
          $ref: '#/components/schemas/DuplicationCheckOptions'
    DuplicationCheckOptions:
      type: object
      description: |
        重複チェック情報  
        **成功取引、直接、トークン化の場合に指定が可能です。**  
        **トークン化の場合、MPクレカトークンのみ利用可能です。**
      properties:
        enableDuplicationCheck:
          type: boolean
          description: |
            カード番号重複チェック  
            他会員IDで既に登録されているカード番号の登録を許可しない場合は<span class="mp-oas-code">true</span>にします。  
            チェックの結果、既に同じカード番号が他会員IDに登録されている場合は<span class="mp-oas-code">invalid_request</span>エラーが返ります。  
            有効期限および同一会員IDの登録状況はチェックしません。
          default: false
        includeDeletedCards:
          type: boolean
          description: |
            重複チェックに削除カードを含めるか  
            カード番号重複チェック時の対象に削除済みカードを含める場合は<span class="mp-oas-code">true</span>にします。
          default: false
        excludedMemberIds:
          type: array
          items:
            type: string
          description: |
            重複チェック除外会員ID  
            設定した会員IDの一覧は、カード番号重複チェックの対象外にします。  
            最大20個まで設定可能です。
          example:
            - member1
            - member2
            - member3
    AdditionalOptions:
      type: object
      description: |
        追加情報  
        予備項目であり、通常は使用しないでください。  
        任意のMap(Key:Value)形式で、KeyとValueはともにString型のみ設定可能です。  
        20個までの要素を設定可能です。
      additionalProperties: true
    AcceptAdditionalOptions:
      type: object
      description: |
        追加情報  
        予備項目です。    
        任意のMap(Key:Value)形式で、KeyとValueはともにString型のみ設定可能です。  
        20個までの要素を設定可能です。

        特定のケースで必要な場合は設定してください。
      properties:
        acceptType:
          type: string
          default: null
          description: |
            利用承諾タイプ    
            PayPayの場合、PayPayとの契約形態を選択します。  
            省略時は登録型都度決済です。   
              - <span class="mp-oas-code">0</span>：随時決済
              - <span class="mp-oas-code">0</span>以外：登録型都度決済
      additionalProperties: true
    PaymentAdditionalOptions:
      type: object
      description: |
        追加情報  
        予備項目です。   
        任意のMap(Key:Value)形式で、KeyとValueはともにString型のみ設定可能です。  
        20個までの要素を設定可能です。

        特定のケースで必要な場合は設定してください。
      properties:
        paymentType:
          type: string
          default: null
          description: |
            決済タイプ  
            PayPayの場合、PayPayとの契約形態を選択します。  
            省略時は登録型都度決済です。   
              - <span class="mp-oas-code">1</span>：随時決済
              - <span class="mp-oas-code">1</span>以外：登録型都度決済
      additionalProperties: true
    Tds2Options:
      type: object
      description: 3Dセキュアオプション情報
      properties:
        skipNotEnrolledCard:
          type: boolean
          description: |
            未対応時の認証スキップ  
            仕向先カード会社が3Dセキュア認証に未対応の場合、エラーにするか、認証をスキップしてオーソリ(信用照会)するかを選択します。  
            - <span class="mp-oas-code">false</span>: リクエストはエラーになります。  
            - <span class="mp-oas-code">true</span>: 3Dセキュア認証をスキップしてオーソリ(信用照会)します。この取引が不正利用によりチャージバックとなった場合、加盟店様が支払いの責任を負う可能性があります。
          default: false
        allowAttempt:
          type: string
          description: |
            認証結果Attempt時の挙動  
            3Dセキュア認証の結果、カード会社からECI 06(Mastercard以外)または01(Mastercard)が返る場合の処理を選択します。  
            ECI06/01は、カード発行会社が3Dセキュアに対応していない場合やサーバー障害などの場合に、認証プロセス自体はできていませんが認証成功と扱うことを意味します。  
            通常、この取引が不正利用によりチャージバックとなった場合、支払いの責任はカード発行会社となり加盟店様には請求されません。  
            それでもECI06/01の支払いを受け付けたくない場合は、<span class="mp-oas-code">NOT_ALLOW</span>を設定してください。  
            <span class="mp-oas-code">FOLLOW</span>を設定した場合、3Dセキュア必須化の契約に従います。  
            <span class="mp-oas-code">NOT_ALLOW</span>を設定すると3Dセキュア認証を利用しない取引はエラーになるため、<span class="mp-oas-code">useTds2</span>を<span class="mp-oas-code">false</span>にする場合、<span class="mp-oas-code">NOT_ALLOW</span>を設定しないでください。  
            ショップ契約の「3Dセキュア必須化」の詳細については、[クレジットカード決済 概要（マルペイDocs）](https://docs.mul-pay.jp/payment/credit/overview)<sup>※</sup>の注意事項を参照ください。  
            - <span class="mp-oas-code">FOLLOW</span>：ショップ契約の「3Dセキュア必須化」の内容に従う
            - <span class="mp-oas-code">ALLOW</span>：認証成功と扱う
            - <span class="mp-oas-code">NOT_ALLOW</span>：認証失敗と扱う
          enum:
            - FOLLOW
            - ALLOW
            - NOT_ALLOW
          example: FOLLOW
          default: FOLLOW
        requiresChallenge:
          type: boolean
          description: |
            認証チャレンジ必須  
            リスク判定の結果によらず3Dセキュア認証チャレンジを要求する場合に<span class="mp-oas-code">true</span>を設定します。  
            ただし、カード発行会社が対応していない場合があります。
          default: false
        autoAuthorization:
          type: boolean
          description: |
            自動オーソリ有無  
            3Dセキュア認証後に自動でオーソリ(信用照会)をせずに、加盟店様から明示的に3Dセキュア後APIを呼び出してオーソリを実施したい場合には<span class="mp-oas-code">false</span>を設定します。  
            「自動オーソリあり」の場合、オーソリが実行されてもお客様がブラウザを閉じる、通信エラーが発生するなどして処理が中断し、貴社にコールバックがされず状態不整合になる可能性があります。  
            「自動オーソリなし」は、オーソリのリクエストを加盟店様にて制御できるため上記のリスクを低減できます。
          default: true
    Tds2Data:
      type: object
      description: 3Dセキュアデータ情報
      properties:
        chAccChange:
          type: string
          description: |
            カード会員情報の最終更新日  
            YYYYMMDD形式
          example: '20230101'
        chAccDate:
          type: string
          description: |
            カード会員の作成日  
            YYYYMMDD形式
          example: '20230101'
        chAccPwChange:
          type: string
          description: |
            カード会員のパスワード変更日  
            YYYYMMDD形式
          example: '20230101'
        nbPurchaseAccount:
          type: number
          maximum: 9999
          description: |
            過去6ヶ月間にこのカード会員が購入した回数
          example: '6'
        paymentAccAge:
          type: string
          description: |
            カード登録日  
            カード会員にカード情報が登録された日付を設定します。  
            YYYYMMDD形式
          example: '20230101'
        provisionAttemptsDay:
          type: number
          maximum: 999
          description: |
            過去24時間に行われたカード情報追加の試行回数
          example: '5'
        shipAddressUsage:
          type: string
          description: |
            配送先住所の初回使用日  
            取引で使用される配送先住所が加盟店様で最初に使用された日付を設定します。  
            YYYYMMDD形式
          example: '20230101'
        shipNameInd:
          type: string
          pattern: ^(01|02)$
          description: |
            カード会員名と配送先名の一致/不一致  
            カード会員の会員名と取引に使用される配送先名の一致/不一致を設定します。  
            - <span class="mp-oas-code">01</span>: カード会員名と配送先名が一致  
            - <span class="mp-oas-code">02</span>: カード会員名と配送先名が不一致
          example: '01'
        suspiciousAccActivity:
          type: string
          pattern: ^(01|02)$
          description: |
            カード会員の不審行為情報  
            カード会員で、不審な行動(過去の不正行為を含む)を加盟店様が発見したかどうかを設定します。  
            - <span class="mp-oas-code">01</span>: 不審な行動は見られなかった  
            - <span class="mp-oas-code">02</span>: 不審な行動が見られた
          example: '01'
        txnActivityDay:
          type: number
          maximum: 999
          description: |
            過去24時間の取引回数  
            過去24時間に行われた、カード会員と加盟店様との取引の回数を設定します。
          example: '1'
        txnActivityYear:
          type: number
          maximum: 999
          description: |
            前年の取引回数  
            前年に行われた、カード会員と加盟店様との取引の回数を設定します。
          example: '12'
        threeDSReqAuthData:
          type: string
          maxLength: 2048
          description: |
            ログイン証跡  
            カード会員が特定の方法でログインしたことを裏付けるデータを設定します。  
            設定できる最大長はUTF-8で2048byteです。
          example: null
        threeDSReqAuthMethod:
          type: string
          pattern: ^(01|02|03|04|05|06)$
          description: |
            ログイン方法  
            カード会員の加盟店様システムへのログイン方法を設定します。  
            - <span class="mp-oas-code">01</span>: 認証なし(ゲストとしてログイン)  
            - <span class="mp-oas-code">02</span>: 加盟店様自身の認証情報  
            - <span class="mp-oas-code">03</span>: SSO(シングルサインオン)  
            - <span class="mp-oas-code">04</span>: イシュアーの認証情報  
            - <span class="mp-oas-code">05</span>: サードパーティ認証  
            - <span class="mp-oas-code">06</span>: FIDO認証
          example: null
        threeDSReqAuthTimestamp:
          type: string
          description: |
            ログイン日時  
            カード会員のログイン日時を設定します。  
            YYYYMMDDHHMM形式
          example: null
        deliveryTimeframe:
          type: string
          pattern: ^(01|02|03|04)$
          description: |
            商品納品時間枠  
            - <span class="mp-oas-code">01</span>: 電子デリバリー  
            - <span class="mp-oas-code">02</span>: 当日出荷  
            - <span class="mp-oas-code">03</span>: 翌日出荷  
            - <span class="mp-oas-code">04</span>: 2日目以降の出荷
          example: '01'
        giftCardAmount:
          type: number
          maximum: 999999999999999
          description: |
            プリペイドカードまたはギフトカードを購入の場合、総購入金額の値を設定します。
        giftCardCount:
          type: number
          maximum: 99
          description: |
            プリペイドカードまたはギフトカードを購入の場合、購入された総数を設定します。
        giftCardCurr:
          type: string
          pattern: ^[0-9]{3}$
          description: |
            購入されたプリペイドカードまたはギフトカードの通貨コード  
            プリペイドカードまたはギフトカードを購入の場合、カードの通貨を表す、ISO 4217で定義されている通貨コードを設定します。  
            ※以下のコードは対象外です。  
            955, 956, 957, 958, 959, 960, 961, 962, 963, 964, 999
          example: '392'
        preOrderDate:
          type: string
          description: |
            商品の発売予定日  
            先行予約購入の場合は、商品の発売予定日を設定します。  
            YYYYMMDD形式
          example: '20230101'
        preOrderPurchaseInd:
          type: string
          pattern: ^(01|02)$
          description: |
            商品の販売時期情報  
            先行予約購入か、発売済み商品の購入かを設定します。  
            - <span class="mp-oas-code">01</span>: 発売済み商品  
            - <span class="mp-oas-code">02</span>: 先行予約商品
          example: '01'
        reorderItemsInd:
          type: string
          pattern: ^(01|02)$
          description: |
            商品の注文情報  
            カード会員が以前購入した商品を再び注文しているかどうかを設定します。  
            - <span class="mp-oas-code">01</span>: 初回注文  
            - <span class="mp-oas-code">02</span>: 再注文
          example: '01'
        shipInd:
          type: string
          pattern: ^(01|02|03|04|05|06|07)$
          description: |
            取引の配送方法  
            - <span class="mp-oas-code">01</span>: カード会員の請求先住所に配送する  
            - <span class="mp-oas-code">02</span>: 加盟店様が保持している別の、確認済み住所に配送する  
            - <span class="mp-oas-code">03</span>: カード会員の請求先住所と異なる住所に配送する  
            - <span class="mp-oas-code">04</span>: 店舗へ配送 / 近所の店舗での受け取り(店舗の住所は配送先住所で設定する)  
            - <span class="mp-oas-code">05</span>: デジタル商品(オンラインサービス、電子ギフトカードおよび償還コードを含む)  
            - <span class="mp-oas-code">06</span>: 配送なし(旅行およびイベントのチケット)  
            - <span class="mp-oas-code">07</span>: その他(ゲーム、配送されないデジタルサービス、電子メディアの購読料など)
            #### 決済手段ごとの制限事項  
            - クレジットカード(Forter利用時)(Enterprise加盟店様のみ): <span >required</span>
          example: '01'
    FraudDetectionOptions:
      type: object
      description: 不正検知オプション情報
      required:
        - screeningType
      properties:
        screeningType:
          type: string
          description: 審査タイプ
          enum:
            - RED_SHIELD
            - FORTER
        stopAuthorizationThreshold:
          type: string
          pattern: ^DENY|CHALLENGE$
          description: |
            オーソリ中断閾値  
            当パラメーターを設定した場合はオーソリ(信用照会)前に不正審査を実施し、審査結果が設定した閾値以上である場合はオーソリ(信用照会)を中断します。  
            例) <span class="mp-oas-code">CHALLENGE</span>を設定した場合、審査結果が<span class="mp-oas-code">CHALLENGE</span>または<span class="mp-oas-code">DENY</span>の際はオーソリを中断します。
          example: null
        asyncMode:
          type: boolean
          description: |
            非同期モード  
            <span class="mp-oas-code">true</span>を設定した場合は不正審査を非同期で実行します。
            この際レスポンスに審査結果は含まれませんので、任意のタイミングで[取引照会API(/order/inquiry)](/mulpay/apis/openapi-type/order-inquiry)を実行し取得してください。
            #### 決済手段ごとの制限事項  
              - クレジットカード(ReD Shield利用時): 利用可能です。
          example: false
          default: false
    FraudDetectionData:
      type: object
      description: |
        不正検知データ情報  
        #### 決済手段ごとの制限事項  
          - クレジットカード(ReD Shield利用時): <span >required</span>
      required:
        - userId
      properties:
        userId:
          type: string
          maxLength: 60
          pattern: ^[a-zA-Z0-9@_.-]+$
          description: ユーザーID
          example: userId-01
        identityDocType:
          type: string
          description: |
            本人確認書類タイプ  
            本人確認書類IDに設定する書類タイプを設定します。  
            本人確認書類IDを設定する場合は省略できません。
            - <span class="mp-oas-code">PASSPORT</span>：パスポート
            - <span class="mp-oas-code">TAXSTATEMENT</span>：納税証明書
          enum:
            - PASSPORT
            - TAXSTATEMENT
          example: PASSPORT
        identityDocId:
          type: string
          maxLength: 20
          pattern: ^[0-9a-zA-Z-]+$
          description: |
            本人確認書類ID  
            設定する場合は本人確認書類タイプも設定する必要があります。
          example: TA0000001
        shippingCorporationName:
          type: string
          maxLength: 60
          description: 配送先会社名
          example: 見本配送会社
        shippingPhone:
          type: string
          maxLength: 13
          pattern: ^[0-9-]+$
          description: 配送先電話番号
          example: 000-0000-0000
        shippingEmail:
          type: string
          maxLength: 254
          format: email
          description: 配送先メールアドレス
        shippingMethod:
          type: string
          description: |
            配送方法
            - <span class="mp-oas-code">NEXT_DAY_OVERNIGHT</span>: 翌日発送
            - <span class="mp-oas-code">TWO_DAY_SERVICE</span>: 2日以内発送
            - <span class="mp-oas-code">THREE_DAY_SERVICE</span>: 3日以内発送
            - <span class="mp-oas-code">LOWEST_COST</span>: 最安値の配送方法
            - <span class="mp-oas-code">CARRIER_DESIGNATED_BY_CUSTOMER</span>:  お客様指定の運送会社
            - <span class="mp-oas-code">ELECTRONIC_DELIVERY</span>: 電子郵便
            - <span class="mp-oas-code">GROUND</span>: 陸上輸送
            - <span class="mp-oas-code">INTERNATIONAL</span>: 国際郵便
            - <span class="mp-oas-code">MILITARY</span>: 軍事郵便
            - <span class="mp-oas-code">STORE_PICKUP</span>: 店舗受け取り
            - <span class="mp-oas-code">SAME_DAY_SERVICE</span>: 即日配送
            - <span class="mp-oas-code">OTHER</span>: その他
            - <span class="mp-oas-code">PUDO</span>: PUDOステーション
            - <span class="mp-oas-code">EXPEDITED</span>: 速達郵便
          enum:
            - NEXT_DAY_OVERNIGHT
            - TWO_DAY_SERVICE
            - THREE_DAY_SERVICE
            - LOWEST_COST
            - CARRIER_DESIGNATED_BY_CUSTOMER
            - ELECTRONIC_DELIVERY
            - GROUND
            - INTERNATIONAL
            - MILITARY
            - STORE_PICKUP
            - SAME_DAY_SERVICE
            - OTHER
            - PUDO
            - EXPEDITED
          example: NEXT_DAY_OVERNIGHT
        shippingAmount:
          type: string
          maxLength: 15
          pattern: ^[0-9]+$
          description: |
            送料  
            審査タイプ(screeningType)が<span class="mp-oas-code">RED_SHIELD</span>の場合、12桁以下で設定してください。
          example: '200'
        shippingTrackingNumber:
          type: string
          maxLength: 19
          pattern: ^[0-9a-zA-Z-]+$
          description: トラッキング番号
          example: '12345678901'
        shippingComment:
          type: string
          maxLength: 160
          description: 発送時コメント
          example: Don't turn over.
        shippingSalutation:
          type: string
          maxLength: 5
          pattern: ^[ -~｡-ﾟ]+$
          description: 配送先敬称
          example: Hi
        deviceInformation:
          type: string
          maxLength: 65535
          pattern: ^[ -~]+$
          description: デバイス情報
          example: null
        repeater:
          type: boolean
          description: リピータフラグ
          default: false
          example: false
        userRegistrationElapsedDays:
          type: string
          maxLength: 7
          pattern: ^[0-9]+$
          description: ユーザーID登録後経過日数
          example: '180'
        promotionCode:
          type: string
          maxLength: 36
          pattern: ^[0-9a-zA-Z-]+$
          description: プロモーションコード
          example: INITIAL-BENEFITS-001
        giftCardMessage:
          type: string
          maxLength: 160
          description: ギフトカードメッセージ
          example: Here's to another year of being great together.
        giftCardType:
          type: string
          description: |
            ギフトカードタイプ  
            - <span class="mp-oas-code">ANNIVERSARY</span>: 記念日
            - <span class="mp-oas-code">APRIL_FOOLS_DAY</span>: エイプリルフール
            - <span class="mp-oas-code">BABY_SHOWER</span>: ベビーシャワー
            - <span class="mp-oas-code">BIRTHDAY</span>: 誕生日
            - <span class="mp-oas-code">BOSSES_DAY</span>: ボスの日
            - <span class="mp-oas-code">CELEBRATE_FALL</span>: セレブレイト・フォール
            - <span class="mp-oas-code">CHINESE_NEW_YEAR</span>: 春節
            - <span class="mp-oas-code">CHRISTMAS</span>: クリスマス
            - <span class="mp-oas-code">CONGRATULATIONS</span>: お祝い
            - <span class="mp-oas-code">EASTER</span>: イースター
            - <span class="mp-oas-code">FATHERS_DAY</span>: 父の日
            - <span class="mp-oas-code">GRADUATION</span>: 卒業
            - <span class="mp-oas-code">GRANDPARENTS_DAY</span>: 祖父母の日
            - <span class="mp-oas-code">HALLOWEEN</span>: ハロウィン
            - <span class="mp-oas-code">HANUKKAH</span>: ハヌカー
            - <span class="mp-oas-code">HOLIDAY</span>: 祝日
            - <span class="mp-oas-code">INDEPENDENCE_DAY</span>: 独立記念日
            - <span class="mp-oas-code">KWANZAA</span>: クワンザ
            - <span class="mp-oas-code">MOTHERS_DAY</span>: 母の日
            - <span class="mp-oas-code">NEW_YEARS_DAY</span>: 元日
            - <span class="mp-oas-code">OTHER</span>: その他
            - <span class="mp-oas-code">PASSOVER</span>: 過越
            - <span class="mp-oas-code">SEASONS_GREETINGS</span>: 季節の挨拶
            - <span class="mp-oas-code">SECRETARYS_DAY</span>: 秘書の日
            - <span class="mp-oas-code">ST_PATRICKS_DAY</span>: 聖パトリックの祝日
            - <span class="mp-oas-code">SWEETEST_DAY</span>: スウィーテスト・デー
            - <span class="mp-oas-code">THANKSGIVING</span>: 感謝祭
            - <span class="mp-oas-code">VALENTINES_DAY</span>:バレンタインデー 
            - <span class="mp-oas-code">WEDDING</span>: 結婚式
          enum:
            - ANNIVERSARY
            - APRIL_FOOLS_DAY
            - BABY_SHOWER
            - BIRTHDAY
            - BOSSES_DAY
            - CELEBRATE_FALL
            - CHINESE_NEW_YEAR
            - CHRISTMAS
            - CONGRATULATIONS
            - EASTER
            - FATHERS_DAY
            - GRADUATION
            - GRANDPARENTS_DAY
            - HALLOWEEN
            - HANUKKAH
            - HOLIDAY
            - INDEPENDENCE_DAY
            - KWANZAA
            - MOTHERS_DAY
            - NEW_YEARS_DAY
            - OTHER
            - PASSOVER
            - SEASONS_GREETINGS
            - SECRETARYS_DAY
            - ST_PATRICKS_DAY
            - SWEETEST_DAY
            - THANKSGIVING
            - VALENTINES_DAY
            - WEDDING
          example: ANNIVERSARY
    FraudDetectionCustomData:
      type: object
      description: |
        不正検知カスタム情報  
        #### 決済手段ごとの制限事項  
          - クレジットカード(ReD Shield利用時): 利用可能です。
      properties:
        customData1:
          type: string
          maxLength: 255
          description: |
            カスタム項目1  
            <span >現在未使用</span>
          example: null
        customData2:
          type: string
          maxLength: 255
          description: |
            カスタム項目2  
            <span >現在未使用</span>
          example: null
        customData3:
          type: string
          maxLength: 255
          description: |
            カスタム項目3  
            <span >現在未使用</span>
          example: null
        customData4:
          type: string
          maxLength: 255
          description: |
            カスタム項目4  
            <span >現在未使用</span>
          example: null
        customData5:
          type: string
          maxLength: 255
          description: |
            カスタム項目5  
            <span >現在未使用</span>
          example: null
        customData6:
          type: string
          maxLength: 255
          description: |
            カスタム項目6  
            <span >現在未使用</span>
          example: null
        customData7:
          type: string
          maxLength: 255
          description: |
            カスタム項目7  
            <span >現在未使用</span>
          example: null
        customData8:
          type: string
          maxLength: 256
          description: |
            カスタム項目8  
            設定できる最大長はUTF-8で256byteです。
          example: null
        customData9:
          type: string
          maxLength: 256
          description: |
            カスタム項目9  
            設定できる最大長はUTF-8で256byteです。
          example: null
        customData10:
          type: string
          maxLength: 255
          description: |
            カスタム項目10  
            <span >現在未使用</span>
          example: null
        customData11:
          type: string
          maxLength: 9
          pattern: ^[0-9]+$
          description: カスタム項目11
          example: 0
        customData12:
          type: string
          maxLength: 9
          pattern: ^[0-9]+$
          description: カスタム項目12
          example: 0
        customData13:
          type: string
          maxLength: 255
          description: |
            カスタム項目13  
            <span >現在未使用</span>
          example: null
        customData14:
          type: string
          maxLength: 255
          description: |
            カスタム項目14  
            <span >現在未使用</span>
          example: null
        customData15:
          type: boolean
          description: カスタム項目15
        customData16:
          type: string
          maxLength: 30
          description: |
            カスタム項目16  
            設定できる最大長はUTF-8で30byteです。
          example: null
        customData17:
          type: string
          maxLength: 9
          pattern: ^[0-9]+$
          description: カスタム項目17
          example: 0
        customData18:
          type: string
          maxLength: 9
          pattern: ^[0-9]+$
          description: カスタム項目18
          example: 0
        customData19:
          type: string
          maxLength: 30
          description: |
            カスタム項目19  
            設定できる最大長はUTF-8で30byteです。
          example: null
        customData20:
          type: string
          maxLength: 9
          pattern: ^[0-9]+$
          description: カスタム項目20
          example: 0
        customData21:
          type: string
          maxLength: 30
          description: |
            カスタム項目21  
            設定できる最大長はUTF-8で30byteです。
          example: null
        customData22:
          type: string
          maxLength: 30
          description: |
            カスタム項目22  
            設定できる最大長はUTF-8で30byteです。
          example: null
        customData23:
          type: string
          maxLength: 30
          description: |
            カスタム項目23  
            設定できる最大長はUTF-8で30byteです。
          example: null
        customData24:
          type: string
          maxLength: 30
          description: |
            カスタム項目24  
            設定できる最大長はUTF-8で30byteです。
          example: null
        customData25:
          type: string
          maxLength: 30
          description: |
            カスタム項目25  
            設定できる最大長はUTF-8で30byteです。
          example: null
        customData26:
          type: string
          maxLength: 255
          description: |
            カスタム項目26  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData27:
          type: string
          maxLength: 255
          description: |
            カスタム項目27  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData28:
          type: string
          maxLength: 255
          description: |
            カスタム項目28  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData29:
          type: string
          maxLength: 255
          description: |
            カスタム項目29  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData30:
          type: string
          maxLength: 255
          description: |
            カスタム項目30  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData31:
          type: string
          maxLength: 255
          description: |
            カスタム項目31  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData32:
          type: string
          maxLength: 255
          description: |
            カスタム項目32  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData33:
          type: string
          maxLength: 255
          description: |
            カスタム項目33  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData34:
          type: string
          maxLength: 255
          description: |
            カスタム項目34  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData35:
          type: string
          maxLength: 255
          description: |
            カスタム項目35  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData36:
          type: string
          maxLength: 255
          description: |
            カスタム項目36  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData37:
          type: string
          maxLength: 255
          description: |
            カスタム項目37  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData38:
          type: string
          maxLength: 255
          description: |
            カスタム項目38  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData39:
          type: string
          maxLength: 255
          description: |
            カスタム項目39  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData40:
          type: string
          maxLength: 255
          description: |
            カスタム項目40  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData41:
          type: string
          maxLength: 255
          description: |
            カスタム項目41  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData42:
          type: string
          maxLength: 255
          description: |
            カスタム項目42  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData43:
          type: string
          maxLength: 255
          description: |
            カスタム項目43  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData44:
          type: string
          maxLength: 255
          description: |
            カスタム項目44  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData45:
          type: string
          maxLength: 255
          description: |
            カスタム項目45  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData46:
          type: string
          maxLength: 255
          description: |
            カスタム項目46  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData47:
          type: string
          maxLength: 255
          description: |
            カスタム項目47  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData48:
          type: string
          maxLength: 255
          description: |
            カスタム項目48  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData49:
          type: string
          maxLength: 255
          description: |
            カスタム項目49  
            設定できる最大長はUTF-8で255byteです。
          example: null
        customData50:
          type: string
          maxLength: 255
          description: |
            カスタム項目50  
            設定できる最大長はUTF-8で255byteです。
          example: null
    followForter:
      type: boolean
      description: |
        Forter判定に従って3DS認証を自動実施  
        Forterの審査結果に応じて、「通常オーソリ」または「3Dセキュア認証」を自動で実施します。  
        Forterの判定に従わず3Dセキュア認証の実施有無を加盟店様にて制御したい場合には<span class="mp-oas-code">false</span>を設定します。  
        省略時はショップ契約の「Forter判定に従って3DS認証を自動実施」の内容に従います。
      example: true
      default: true
    connectionInformation:
      type: object
      description: 顧客接続情報
      properties:
        forterTokenCookie:
          type: string
          maxLength: 128
          description: |
            Forterトークン  
            Forter JavaScriptスニペットから取得するトークン「forterToken」を設定してください。  
            WEB注文の場合は必須です。  
            本トークンはForterによりページ閲覧時に都度発行される識別トークンであり、サイト全ページにスニペットを実装する必要があります。  
            詳細は[Forter JavaScriptの実装](/mulpay/docs/security-solution/forter/javascript)を参照ください。  
          example: 249453te8tbf9355186fet0ken547b95_2786972955236__UDE52-n5_8dg
        forterMobileUID:
          type: string
          maxLength: 128
          description: |
            モバイルUID  
            Forter SDKでお使いのモバイルUIDを設定してください。  
            SDKが実装されている場合は必須です。
          example: 6429751237891
    totalDiscount:
      type: object
      description: |
        クーポン割引情報  
        クーポン割引が存在する場合は必須です。
      properties:
        couponCodeUsed:
          type: string
          maxLength: 150
          description: クーポンコード
          example: FATHERSDAY2015
        couponDiscountAmount:
          type: object
          description: 割引額詳細
          properties:
            amountLocalCurrency:
              type: string
              maxLength: 20
              description: |
                割引額  
                <span >※現時点では日本円のみ利用可能です。</span>
              example: 100
    accountOwner:
      type: object
      description: 顧客アカウント情報
      properties:
        created:
          type: number
          description: |
            顧客アカウント作成日時    
            UNIXエポック秒形式
          example: 1415273168
    cartItems:
      type: array
      description: 商品情報
      items:
        type: object
        properties:
          itemSpecificData:
            $ref: '#/components/schemas/itemSpecificData'
          seller:
            $ref: '#/components/schemas/seller'
    itemSpecificData:
      oneOf:
        - $ref: '#/components/schemas/TicketsAndEvents'
        - $ref: '#/components/schemas/Accommodation'
        - $ref: '#/components/schemas/Transport'
        - $ref: '#/components/schemas/CryptoCurrency'
        - $ref: '#/components/schemas/Food'
    TicketsAndEvents:
      title: チケット・イベント業
      type: object
      properties:
        ticketsAndEvents:
          type: object
          description: |
            チケット・イベント詳細  
            #### 業種ごとの制限事項  
            - チケット・イベント業の場合は必須
          properties:
            eventName:
              type: string
              maxLength: 255
              description: イベント名
            eventLocation:
              type: object
              description: イベント会場住所
              properties:
                address1:
                  type: string
                  maxLength: 255
                  description: イベント会場住所1
                  example: 渋谷2-24-12
                address2:
                  type: string
                  maxLength: 255
                  description: イベント会場住所2
                  example: Shibuya Scramble Square 41F
                zip:
                  type: string
                  maxLength: 20
                  description: イベント会場郵便番号
                  example: 1500002
                city:
                  type: string
                  maxLength: 200
                  description: イベント会場市区町村
                  example: 渋谷区
                region:
                  type: string
                  maxLength: 200
                  description: イベント会場都道府県
                  example: 東京都
                country:
                  type: string
                  maxLength: 2
                  description: |
                    イベント会場国名コード  
                    2文字の国名コード - ISO 3166-1
                  example: JP
            eventTime:
              type: number
              description: |
                イベント開催時刻  
                UNIXエポックミリ秒形式
            eventType:
              type: string
              maxLength: 100
              description: イベント種類
              example: Sports
            eventVenueName:
              type: string
              maxLength: 255
              description: イベント会場名
            ticketCategory:
              type: string
              description: |
                チケットカテゴリ  
                - <span class="mp-oas-code">ADULT</span>：大人・一般
                - <span class="mp-oas-code">CHILD</span>：子供
                - <span class="mp-oas-code">ENFANT</span>：幼児
                - <span class="mp-oas-code">SENIOR</span>：シニア
                - <span class="mp-oas-code">STUDENT</span>：学生
                - <span class="mp-oas-code">VETERAN</span>：ベテラン
                - <span class="mp-oas-code">OTHER</span>：その他
              enum:
                - ADULT
                - CHILD
                - ENFANT
                - SENIOR
                - STUDENT
                - VETERAN
                - OTHER
              example: ADULT
            ticketClass:
              type: string
              maxLength: 25
              description: チケット座席種別
    Accommodation:
      title: 宿泊業
      type: object
      properties:
        accommodation:
          type: object
          description: |
            宿泊詳細  
            #### 業種ごとの制限事項  
            - 宿泊業の場合は必須
          properties:
            duration:
              type: object
              description: 宿泊期間
              properties:
                startDate:
                  type: string
                  description: |
                    チェックイン日  
                    YYYY-MM-DD形式
                  example: '2025-09-30'
                endDate:
                  type: string
                  description: |
                    チェックアウト日  
                    YYYY-MM-DD形式
                  example: '2025-10-01'
            numberOfGuests:
              type: number
              description: 宿泊人数
              example: 2
            type:
              type: string
              description: |
                宿泊施設種類  
                - <span class="mp-oas-code">HOTEL</span>：ホテル
                - <span class="mp-oas-code">APARTMENT</span>：アパート
                - <span class="mp-oas-code">CRUISE</span>：クルーズ客船
              enum:
                - HOTEL
                - APARTMENT
                - CRUISE
              example: HOTEL
            accommodationName:
              type: string
              maxLength: 100
              description: 宿宿泊施設名
              example: ホテルGMO
            accommodationAddress:
              type: object
              description: 宿泊施設住所
              properties:
                address1:
                  type: string
                  maxLength: 255
                  description: 宿泊施設住所1
                  example: 渋谷2-24-12
                address2:
                  type: string
                  maxLength: 255
                  description: 宿泊施設住所2
                  example: Shibuya Scramble Square 41F
                zip:
                  type: string
                  maxLength: 20
                  description: 宿泊施設郵便番号
                  example: 1500002
                city:
                  type: string
                  maxLength: 200
                  description: 宿泊施設市区町村
                  example: 渋谷区
                region:
                  type: string
                  maxLength: 200
                  description: 宿泊施設都道府県
                  example: 東京都
                country:
                  type: string
                  maxLength: 2
                  description: |
                    宿泊施設国名コード  
                    2文字の国名コード - ISO 3166-1
                  example: JP
    Transport:
      title: 交通業
      type: object
      properties:
        transport:
          type: array
          description: |
            交通系詳細  
            複数の行程が存在する場合、各行程につき、transportオブジェクトを一つ設定してください。  
            例えば、往復のフライトの場合  
            - 行きのフライトは transport[0]
            - 帰りのフライトは transport[1]
            #### 業種ごとの制限事項  
            - 交通業の場合は必須
          items:
            type: object
            properties:
              type:
                type: string
                description: |
                  交通機関種類  
                  - <span class="mp-oas-code">PRIVATE_TAXI</span>：タクシー
                  - <span class="mp-oas-code">PRIVATE_VIP_TAXI</span>：タクシー（プレミアム車両）
                  - <span class="mp-oas-code">PRIVATE_LARGE_TAXI</span>：タクシー（ワゴン車）
                  - <span class="mp-oas-code">AIR_TRAVEL</span>：航空
                  - <span class="mp-oas-code">RAIL</span>：列車
                  - <span class="mp-oas-code">FERRY</span>：客船
                  - <span class="mp-oas-code">BUS</span>：バス
                  - <span class="mp-oas-code">CAR_RENTAL</span>：レンタカー                      
                enum:
                  - PRIVATE_TAXI
                  - PRIVATE_VIP_TAXI
                  - PRIVATE_LARGE_TAXI
                  - AIR_TRAVEL
                  - RAIL
                  - FERRY
                  - BUS
                  - CAR_RENTAL
                example: PRIVATE_TAXI
              bookingSource:
                type: string
                description: 予約手段
                example: Website
              carrier:
                type: string
                description: 交通機関会社名
              leg:
                type: integer
                description: |
                  行程順  
                  例えば、往復のフライトの場合  
                  - 行きのフライトは「0」
                  - 帰りのフライトは「1」
              duration:
                type: object
                description: 行程期間
                properties:
                  startTime:
                    type: integer
                    description: |
                      出発日時  
                      UNIXエポック秒形式
                  endTime:
                    type: integer
                    description: |
                      到着日時  
                      UNIXエポック秒形式
              startPoint:
                type: object
                description: 出発地点詳細
                properties:
                  address:
                    type: object
                    description: 出発地点住所
                    properties:
                      address1:
                        type: string
                        maxLength: 255
                        description: 出発地点住所1
                        example: 渋谷2-24-12
                      address2:
                        type: string
                        maxLength: 255
                        description: 出発地点住所2
                        example: Shibuya Scramble Square 41F
                      zip:
                        type: string
                        maxLength: 20
                        description: 出発地点郵便番号
                        example: 1500002
                      city:
                        type: string
                        maxLength: 200
                        description: 出発地点市区町村
                        example: 渋谷区
                      region:
                        type: string
                        maxLength: 200
                        description: 出発地点都道府県
                        example: 東京都
                      country:
                        type: string
                        maxLength: 2
                        description: |
                          出発地点国名コード  
                          2文字の国名コード - ISO 3166-1
                        example: JP
                  exactLocation:
                    type: object
                    description: 出発地点緯度経度
                    properties:
                      latitude:
                        type: number
                        description: 出発地点緯度
                      longitude:
                        type: number
                        description: 出発地点経度
                      source:
                        type: string
                        description: 出発地点緯度経度取得元
                  roughLocation:
                    type: object
                    description: 出発地点住所
                    properties:
                      city:
                        type: string
                        maxLength: 200
                        description: 出発地点市区町村
                        example: 渋谷区
                      region:
                        type: string
                        maxLength: 200
                        description: 出発地点都道府県
                        example: 東京都
                      country:
                        type: string
                        maxLength: 2
                        description: |
                          出発地点国名コード  
                          2文字の国名コード - ISO 3166-1
                        example: JP
                      airportCode:
                        type: string
                        pattern: ^[A-Z]{3}$
                        description: 出発地点空港コード
                      seaportCode:
                        type: string
                        pattern: ^[A-Z]{5}$
                        description: 出発地点港コード
              endPoint:
                type: object
                description: 到着地点詳細
                properties:
                  address:
                    type: object
                    description: 到着地点住所
                    properties:
                      address1:
                        type: string
                        maxLength: 255
                        description: 到着地点住所1
                        example: 渋谷2-24-12
                      address2:
                        type: string
                        maxLength: 255
                        description: 到着地点住所2
                        example: Shibuya Scramble Square 41F
                      zip:
                        type: string
                        maxLength: 20
                        description: 到着地点郵便番号
                        example: 1500002
                      city:
                        type: string
                        maxLength: 200
                        description: 到着地点市区町村
                        example: 渋谷区
                      region:
                        type: string
                        maxLength: 200
                        description: 到着地点都道府県
                        example: 東京都
                      country:
                        type: string
                        maxLength: 2
                        description: |
                          到着地点国名コード  
                          2文字の国名コード - ISO 3166-1
                        example: JP
                  exactLocation:
                    type: object
                    description: 到着地点緯度経度
                    properties:
                      latitude:
                        type: number
                        description: 到着地点緯度
                      longitude:
                        type: number
                        description: 到着地点経度
                      source:
                        type: string
                        description: 到着地点緯度経度取得元
                  roughLocation:
                    type: object
                    description: 到着地点住所
                    properties:
                      city:
                        type: string
                        maxLength: 200
                        description: 到着地点市区町村
                        example: 渋谷区
                      region:
                        type: string
                        maxLength: 200
                        description: 到着地点都道府県
                        example: 東京都
                      country:
                        type: string
                        maxLength: 2
                        description: |
                          到着地点国名コード  
                          2文字の国名コード - ISO 3166-1
                        example: JP
                      airportCode:
                        type: string
                        pattern: ^[A-Z]{3}$
                        description: 到着地点空港コード
                      seaportCode:
                        type: string
                        pattern: ^[A-Z]{5}$
                        description: 到着地点港コード
              passengers:
                type: number
                description: 乗客数
    CryptoCurrency:
      title: 暗号資産交換業
      type: object
      properties:
        cryptoCurrency:
          type: object
          description: |
            暗号資産詳細  
            #### 業種ごとの制限事項  
              - 暗号資産交換業の場合は必須
          properties:
            destinationWallet:
              type: string
              description: 仮想通貨ウォレットアドレス
    Food:
      title: 飲食店業
      type: object
      properties:
        food:
          type: object
          description: |
            飲食店詳細  
            #### 業種ごとの制限事項  
            - 飲食店業(フードデリバリー・出前)の場合は必須
          properties:
            restaurantAddress:
              type: object
              description: 飲食店住所
              properties:
                address1:
                  type: string
                  maxLength: 255
                  description: 飲食店住所1
                  example: 渋谷2-24-12
                address2:
                  type: string
                  maxLength: 255
                  description: 飲食店住所2
                  example: Shibuya Scramble Square 41F
                zip:
                  type: string
                  maxLength: 20
                  description: 飲食店郵便番号
                  example: 1500002
                city:
                  type: string
                  maxLength: 200
                  description: 飲食店市区町村
                  example: 渋谷区
                region:
                  type: string
                  maxLength: 200
                  description: 飲食店都道府県
                  example: 東京都
                country:
                  type: string
                  maxLength: 2
                  description: |
                    飲食店国名コード  
                    2文字の国名コード - ISO 3166-1
                  example: JP
            restaurantId:
              type: string
              description: 飲食店UID
            restaurantName:
              type: string
              description: 飲食店名
            tipAmount:
              type: object
              description: チップ額詳細
              properties:
                ammountLocalCurrency:
                  type: string
                  description: チップ額
    seller:
      type: object
      description: |
        出品者  
        #### 業種ごとの制限事項  
        - マーケットプレイスの場合は必須
      properties:
        sellerDetails:
          type: object
          description: 出品者詳細
          properties:
            sellerPersonalDetails:
              type: object
              description: 出品者個人情報
              properties:
                email:
                  type: string
                  maxLength: 256
                  description: 出品者メールアドレス
                firstName:
                  type: string
                  maxLength: 75
                  description: 出品者氏名（名）
                lastName:
                  type: string
                  maxLength: 75
                  description: 出品者氏名（性）
            dateOfFirstSale:
              type: number
              description: 初回販売日
            sellerAccountCreationDate:
              type: number
              description: 出品者のアカウント作成日
            sellerPastSalesCount:
              type: integer
              description: 販売総数
        sellerBusinessWebsite:
          type: string
          description: |
            出品者ビジネスウェブサイト  
            httpsから始まるURLを設定してください。
          example: https://example.com/sellerbusiness
        sellerCategory:
          type: string
          description: 出品者カテゴリ・業種
        sellerVendorName:
          type: string
          description: 出品者名
    customerAccountData:
      type: object
      description: その他お客様アカウントにまつわる情報
      properties:
        type:
          type: string
          description: |
            顧客アカウント種別  
            - <span class="mp-oas-code">PRIVATE</span>：通常ユーザーアカウント
            - <span class="mp-oas-code">GUEST</span>：ゲストチェックアウト
            - <span class="mp-oas-code">VIP</span>：プレミアムユーザー／その他特別な一般ユーザー
            - <span class="mp-oas-code">MERCHANT_OPERATED</span>：サイト運用に使われるアドミンアカウント
            - <span class="mp-oas-code">MERCHANT_EMPLOYEE</span>：加盟店従業員のアカウント
            - <span class="mp-oas-code">AGENT</span>：第三者のエージェント                   
          enum:
            - PRIVATE
            - GUEST
            - VIP
            - MERCHANT_OPERATED
            - MERCHANT_EMPLOYEE
            - AGENT
        registrationIP:
          type: string
          description: 顧客アカウント作成時IPアドレス
        additionalVerificationDocuments:
          type: object
          description: 顧客アカウントKYCデータ
        addressesInAccount:
          type: array
          description: アカウントに保存されているすべての住所情報
          items:
            type: object
            properties:
              address1:
                type: string
                maxLength: 255
                description: 顧客住所1
                example: 渋谷2-24-12
              address2:
                type: string
                maxLength: 255
                description: 顧客住所2
                example: Shibuya Scramble Square 41F
              zip:
                type: string
                maxLength: 20
                description: 顧客郵便番号
                example: 1500002
              city:
                type: string
                maxLength: 200
                description: 顧客市区町村
                example: 渋谷区
              region:
                type: string
                maxLength: 200
                description: 顧客都道府県
                example: 東京都
              country:
                type: string
                maxLength: 2
                description: |
                  顧客国名コード  
                  2文字の国名コード - ISO 3166-1
                example: JP
    primaryDeliveryDetails:
      type: object
      description: 主要配送詳細
      properties:
        deliveryMethod:
          type: string
          maxLength: 50
          description: 主要配送方法
          example: Standard Delivery
        carrier:
          type: string
          maxLength: 50
          description: |
            主要配送サービス名  
            <span >現在未使用</span>
        deliveryPrice:
          type: object
          description: 配送料詳細
          properties:
            amountLocalCurrency:
              type: string
              maxLength: 20
              description: 主要配送料
    primaryRecipient:
      type: object
      description: 商品の配送先詳細
      properties:
        personalDetails:
          type: object
          description: 配送先情報
          properties:
            email:
              type: string
              maxLength: 256
              description: |
                主要配送先メールアドレス  
                ギフト券を利用する場合のみ必須です。
        phone:
          type: array
          description: 主要配送先電話番号
          items:
            type: object
            properties:
              phone:
                type: string
                maxLength: 25
                description: 主要配送先電話番号
    additionalIdentifiers:
      type: object
      description: |
        追加情報  
        予備項目に追加する情報の内、該当する項目がある場合はこちらに設定してください。
      properties:
        orderSegment:
          type: string
          maxLength: 50
          description: |
            オーダーセグメント  
            加盟店様の注文に関して、区分を追加したい場合はこちらに設定してください。
          example: Regular Checkout
        merchant:
          type: object
          description: |
            加盟店セグメント情報  
            加盟店様が複数のサイトを運営していて、追加が必要な場合はこちらに設定してください。
          properties:
            merchantDomain:
              type: string
              maxLength: 2048
              description: 加盟店様ドメイン
              example: example.com
            merchantName:
              type: string
              maxLength: 50
              description: 加盟店様名
              example: サンプルストア
    additionalInformation:
      type: object
      description: |
        追加情報  
        予備項目であり、追加の情報がある場合に設定してください。  
        全体の文字数は最大2000文字までです。
    NextAction:
      type: string
      description: |
        レスポンスを受け取った後の加盟店様側の処理  
        - <span class="mp-oas-code">CAPTURE</span>：確定処理が必要
        - <span class="mp-oas-code">NO_ACTION</span>：後続処理なし
        - <span class="mp-oas-code">REDIRECT</span>：リダイレクトが必要
        - <span class="mp-oas-code">AWAIT</span>：入金結果待ち
      enum:
        - CAPTURE
        - NO_ACTION
        - REDIRECT
        - AWAIT
    OrderReference:
      type: object
      description: 取引参照情報
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
        accessPass:
          $ref: '#/components/schemas/AccessPass'
        orderId:
          type: string
          description: リクエスト時に設定したオーダーID
          example: order-001
        created:
          type: string
          format: date-time
          description: |
            開始日時<br /> [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記  
            例) 2023-05-30T12:34:56+09:00
          example: '2023-05-30T12:34:56+09:00'
        updated:
          type: string
          format: date-time
          description: |
            最終更新日時  
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記  
            例) 2023-05-30T12:34:56+09:00
          example: '2023-05-30T12:34:56+09:00'
        amount:
          type: string
          maxLength: 15
          pattern: ^[0-9]{1,15}$
          description: |
            リクエスト時に設定した税送料込の取引金額
          example: '1000'
        clientFields:
          $ref: '#/components/schemas/ClientFields'
          description: |
            リクエスト時に設定した加盟店自由項目
    VerificationReference:
      description: 認証情報
      type: object
      properties:
        accessId:
          $ref: '#/components/schemas/AccessId'
        verificationId:
          $ref: '#/components/schemas/VerificationId'
        status:
          $ref: '#/components/schemas/VerificationStatus'
        created:
          type: string
          format: date-time
          description: |
            最終更新日時  
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記  
            例) 2023-05-30T12:34:56+09:00
          example: '2023-05-30T12:34:56+09:00'
        updated:
          type: string
          format: date-time
          description: |
            最終更新日時  
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記  
            例) 2023-05-30T12:34:56+09:00
          example: '2023-05-30T12:34:56+09:00'
        type:
          $ref: '#/components/schemas/VerificationType'
    ChargeType:
      type: string
      description: |
        支払いタイプ  
        - <span class="mp-oas-code">CREDIT</span>: クレカ払い
        - <span class="mp-oas-code">WALLET</span>: Pay払い
        - <span class="mp-oas-code">CASH</span>: 現金払い
      enum:
        - CREDIT
        - WALLET
        - CASH
    OrderReferenceCredit:
      allOf:
        - $ref: '#/components/schemas/OrderReference'
        - type: object
          properties:
            status:
              $ref: '#/components/schemas/StatusCredit'
            chargeType:
              type: string
              description: |
                支払いタイプ  
                - <span class="mp-oas-code">CREDIT</span>: クレカ払い
              enum:
                - CREDIT
    OrderReferenceWallet:
      allOf:
        - $ref: '#/components/schemas/OrderReference'
        - properties:
            status:
              $ref: '#/components/schemas/StatusWallet'
            chargeType:
              type: string
              description: |
                支払いタイプ  
                - <span class="mp-oas-code">WALLET</span>: Pay払い
              enum:
                - WALLET
    OrderReferenceCash:
      type: object
      allOf:
        - $ref: '#/components/schemas/OrderReference'
        - properties:
            status:
              $ref: '#/components/schemas/StatusCash'
            chargeType:
              type: string
              description: |
                支払いタイプ  
                - <span class="mp-oas-code">CASH</span>: 現金払い
              enum:
                - CASH
    OrderReferenceDeferredpay:
      allOf:
        - $ref: '#/components/schemas/OrderReference'
        - properties:
            status:
              $ref: '#/components/schemas/StatusDeferred'
            chargeType:
              type: string
              description: |
                支払いタイプ  
                - <span class="mp-oas-code">DEFERRED</span>: 後払い
              enum:
                - DEFERRED
    RedirectInformation:
      type: object
      description: リダイレクト情報
      properties:
        redirectUrl:
          type: string
          description: リダイレクト先のURL
          maxLength: 512
        httpMethod:
          type: string
          description: |
            リダイレクト時のHTTPメソッド  
            原則 <span class="mp-oas-code">GET</span> です。詳細は[リダイレクトとコールバック](/mulpay/docs/connection-method/openapi-type/callback-webhook)を参照ください。
          enum:
            - GET
            - POST
          example: GET
        redirectType:
          type: string
          description: |
            リダイレクト処理のタイプ  
            - <span class="mp-oas-code">TDS2</span>：3Dセキュア
            - <span class="mp-oas-code">WALLET_CHARGE</span>：Pay払い 都度支払い
            - <span class="mp-oas-code">WALLET_AUTHORIZE</span>：Pay払い 利用承諾
            - <span class="mp-oas-code">VERIFY</span>：本人確認
          enum:
            - TDS2
            - WALLET_CHARGE
            - WALLET_AUTHORIZE
            - VERIFY
        redirectParameters:
          type: object
          description: |
            リダイレクト時のパラメーター  
            リダイレクト時のHTTPメソッドが <span class="mp-oas-code">POST</span> の場合に、リクエストボディに設定するパラメーター(Map形式)です。  
            <span class="mp-oas-code">GET</span> の場合は、クエリパラメーターとしてリダイレクト先URLに含まれるため、この項目は返りません。
          additionalProperties: true
          example: null
    CreditResult:
      type: object
      description: カード支払い結果情報
      properties:
        cardType:
          type: string
          description: |
            カードのタイプ  
            - <span class="mp-oas-code">CREDIT_CARD</span>：クレジットカード
            - <span class="mp-oas-code">APPLE_PAY</span>：Apple Pay
            - <span class="mp-oas-code">GOOGLE_PAY</span>：Google Pay
          enum:
            - CREDIT_CARD
            - APPLE_PAY
            - GOOGLE_PAY
          example: CREDIT
        cardResult:
          $ref: '#/components/schemas/CardResult'
        forwardedAcquirerCode:
          type: string
          description: |
            仕向先カード会社コード  
            プロトコルタイプ/モジュールタイプにおける<span class="mp-oas-code">Forward</span>パラメーターと同じです。  
            最大7桁の半角英数字・半角スペースで構成されます。
          example: 2a99663
        approvalCode:
          type: string
          description: |
            カード会社が発行した承認番号  
            プロトコルタイプ/モジュールタイプにおける<span class="mp-oas-code">Approve</span>パラメーターと同じです。  
            最大7桁の半角英数字・半角スペースで構成されます。  
            有効性確認やキャンセルの場合には、全て半角スペース、または空になる可能性があります。
          example: '1234567'
        nwTransactionId:
          type: string
          description: |
            クレジットカードネットワーク事業者が取引を特定するためのID  
            プロトコルタイプ/モジュールタイプにおける<span class="mp-oas-code">TranID</span>パラメーターと同じです。  
            最大28桁の半角数字で構成されます。
          example: '2305301234602212345678912345'
        transactionDateTime:
          type: string
          format: date-time
          description: |
            処理日時  
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記  
            例) 2023-05-30T12:34:56+09:00
          example: '2023-05-30T12:34:56+09:00'
        captureExpiryDateTime:
          type: string
          format: date-time
          description: |
            仮売上有効日時  
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記  
            例) 2023-06-30T12:34:56+09:00
          example: '2023-06-30T12:34:56+09:00'
        useTds2:
          type: boolean
          description: |
            3Dセキュア認証の利用有無  
            当該取引が3Dセキュア認証済である場合は<span class="mp-oas-code">true</span>です。
          example: false
        useFraudDetection:
          type: boolean
          description: 不正検知の利用有無
          example: true
    CardResult:
      type: object
      description: 支払いで利用したカードの情報
      properties:
        cardNumber:
          type: string
          description: |
            利用されたカード番号  
            下4桁(**********9999)固定でマスクされます。
          example: '**********1111'
        cardholderName:
          type: string
          description: 利用されたカードの名義人
          example: TARO MIHON
        expiryMonth:
          type: string
          description: 利用されたカードの有効期限(月)
          example: '06'
        expiryYear:
          type: string
          description: 利用されたカードの有効期限(年)
          example: '2033'
        issuerCode:
          type: string
          description: |
            利用されたカードの発行カード会社コード  
            最大7桁の半角英数字・半角スペースで構成されます。
          example: 2a99663
        brand:
          type: string
          description: 利用されたカードのブランド
          enum:
            - VISA
            - MASTERCARD
            - JCB
            - DINERS
            - AMEX
            - UNKNOWN
          example: VISA
    Tds2Result:
      type: object
      description: 3Dセキュア結果情報
      properties:
        eci:
          type: string
          description: |
            ECI値
          maxLength: 2
          example: '05'
        requiresChallenge:
          type: boolean
          description: |
            認証チャレンジ必須
            3Dセキュア認証をチャレンジ必須化で処理をしたかを表します。
        tds2TransResult:
          type: string
          description: |
            認証結果  
            - <span class="mp-oas-code">Y</span>：認証／口座確認に成功
            - <span class="mp-oas-code">A</span>：処理の試行が実施された
            - <span class="mp-oas-code">C</span>：認証チャレンジが必要
            - <span class="mp-oas-code">N</span>：未認証／口座未確認 取引拒否
            - <span class="mp-oas-code">U</span>：認証／口座確認を実行できなかった
            - <span class="mp-oas-code">R</span>：認証／口座確認が拒否された
          enum:
            - 'Y'
            - A
            - C
            - 'N'
            - U
            - R
          example: 'Y'
        tds2TransResultReason:
          type: string
          pattern: ^[0-2][0-9]$
          description: 認証結果理由<br />01:カード認証に失敗した<br />02:不明なデバイス<br />03:サポートされていないデバイス<br />04:認証頻度の上限を超えた<br />05:有効期限切れのカード<br />06:無効なカード番号<br />07:無効な取引<br />08:カードのレコードが存在しない<br />09:セキュリティ障害<br />10:盗難カード<br />11:不正の疑い<br />12:カード会員に取引が許可されていない<br />13:カード会員がサービスに登録されていない<br />14:取引がACSでタイムアウトした<br />15:信頼度が低い<br />16:信頼度が中程度<br />17:信頼度が高い<br />18:信頼度が非常に高い<br />19:ACSの最大チャレンジを超える<br />20:非決済取引はサポートされていません<br />21:3RIトランザクションはサポートされていません
          example: '18'
    FraudDetectionResult:
      type: object
      description: 不正検知の結果情報
      properties:
        screeningType:
          type: string
          description: 審査タイプ
          enum:
            - RED_SHIELD
            - FORTER
        screeningTransactionId:
          type: string
          description: 審査トランザクションID
        screeningResultCode:
          type: string
          description: 審査結果コード
        screeningResultRawData:
          type: string
          description: 審査結果(未加工)
    CardDetailResult:
      type: object
      description: カード詳細情報
      properties:
        cardNumber:
          type: string
          description: |
            カード番号  
            下4桁(**********9999)固定でマスクされます。
          example: '**********1111'
        cardholderName:
          type: string
          description: 利用されたカードの名義人
          example: TARO MIHON
        expiryMonth:
          type: string
          description: カードの有効期限(月)
          example: '06'
        expiryYear:
          type: string
          description: カードの有効期限(年)
          example: '2033'
        brand:
          type: string
          description: カードのブランド
          enum:
            - VISA
            - MASTERCARD
            - JCB
            - DINERS
            - AMEX
            - UNKNOWN
          example: VISA
        issuerLocation:
          type: string
          description: |
            カードの発行会社所在地
            - <span class="mp-oas-code">JP</span>：日本国内
            - <span class="mp-oas-code">INTERNATIONAL</span>：海外
            - <span class="mp-oas-code">UNKNOWN</span>：不明
          enum:
            - JP
            - INTERNATIONAL
            - UNKNOWN
          example: JP
        issuerCode:
          type: string
          description: カードの発行カード会社コード
          example: 2a99663
        debitInformation:
          $ref: '#/components/schemas/DebitInformation'
        clientCardBinData:
          $ref: '#/components/schemas/ClientCardBinData'
    DebitInformation:
      type: object
      description: デビットカード情報
      properties:
        type:
          type: string
          description: |
            カードの種類
            - <span class="mp-oas-code">DEBIT</span>：デビットカード
            - <span class="mp-oas-code">PREPAID</span>：プリペイドカード
            - <span class="mp-oas-code">OTHER</span>：その他
          enum:
            - DEBIT
            - PREPAID
            - OTHER
          example: DEBIT
        issuerName:
          type: string
          description: |
            カードの発行会社名  
            <span class="mp-oas-code">cardType</span>が <span class="mp-oas-code">DEBIT</span>、<span class="mp-oas-code">PREPAID</span>の場合のみパラメーターが返ります。
          example: VISAデビット-海外
    ClientCardBinData:
      type: object
      description: 独自BIN判定結果
      properties:
        info1:
          type: array
          items:
            type: string
          description: |
            加盟店設定情報1  
            ショップ管理画面で登録した独自BIN情報の「Info1」の値が返ります。  
            登録方法はこちらの[FAQページ](https://mp-faq.gmo-pg.com/s/article/D00042)を参照ください。  
            複数の登録済みBIN情報に該当する場合は全ての値が返ります。
          example: Info1
        info2:
          type: array
          items:
            type: string
          description: |
            加盟店設定情報2  
            ショップ管理画面で登録した独自BIN情報の「Info2」の値が返ります。  
            登録方法はこちらの[FAQページ](https://mp-faq.gmo-pg.com/s/article/D00042)を参照ください。  
            複数の登録済みBIN情報に該当する場合は全ての値が返ります。
          example:
            - Info2-1
            - Info2-2
        info3:
          type: array
          items:
            type: string
          description: |
            加盟店設定情報3  
            ショップ管理画面で登録した独自BIN情報の「Info3」の値が返ります。  
            登録方法はこちらの[FAQページ](https://mp-faq.gmo-pg.com/s/article/D00042)を参照ください。  
            複数の登録済みBIN情報に該当する場合は全ての値が返ります。
          example:
            - Info3-1
            - Info3-2
        info4:
          type: array
          items:
            type: string
          description: |
            加盟店設定情報4  
            ショップ管理画面で登録した独自BIN情報の「Info4」の値が返ります。  
            登録方法はこちらの[FAQページ](https://mp-faq.gmo-pg.com/s/article/D00042)を参照ください。  
            複数の登録済みBIN情報に該当する場合は全ての値が返ります。
          example:
            - Info4-1
            - Info4-2
        info5:
          type: array
          items:
            type: string
          description: |
            加盟店設定情報5  
            ショップ管理画面で登録した独自BIN情報の「Info5」の値が返ります。  
            登録方法はこちらの[FAQページ](https://mp-faq.gmo-pg.com/s/article/D00042)を参照ください。  
            複数の登録済みBIN情報に該当する場合は全ての値が返ります。
          example:
            - Info5-1
            - Info5-2
    ErrorInformation:
      type: object
      description: エラー情報<br />最後に行った操作においてエラーが発生している場合のみ設定されます。<br />詳細は[エラーの情報](/mulpay/docs/connection-method/openapi-type/error-spec)を参照ください。
      properties:
        title:
          type: string
          description: エラー内容のサマリー
          example: payment_failure
        detail:
          type: string
          description: エラーの詳細説明
          example: Payment processing failed.
    WalletInformation:
      type: object
      description: Pay払い(都度)情報
      required:
        - walletChargeOptions
        - walletType
      properties:
        walletChargeOptions:
          $ref: '#/components/schemas/WalletChargeOptions'
        walletType:
          $ref: '#/components/schemas/WalletType'
        amazonPay:
          $ref: '#/components/schemas/AmazonPay'
    WalletFrontendInformation:
      type: object
      description: Pay払い(都度フロントエンド方式）情報
      required:
        - WalletFrontendChargeOptions
        - walletType
      properties:
        walletFrontendChargeOptions:
          $ref: '#/components/schemas/WalletFrontendChargeOptions'
        walletType:
          $ref: '#/components/schemas/WalletFrontendType'
    WalletChargeOptions:
      type: object
      required:
        - authorizationMode
      description: Pay払いの支払いオプション
      properties:
        authorizationMode:
          type: string
          description: |
            支払い要求のタイプ  
            - <span class="mp-oas-code">AUTH</span>：仮売上
            - <span class="mp-oas-code">CAPTURE</span>：即時売上
          enum:
            - AUTH
            - CAPTURE
          example: AUTH
        transitionType:
          type: string
          description: |
            Pay払いの決済事業者へのリダイレクト方式  
            Pay払いの決済事業者画面へ遷移する方法を指定します。  
            au PAY(ネット支払い)アプリ方式、メルペイ、Alipayで利用可能です。   
            詳細は各決済手段ページを参照ください。  
            au PAY(ネット支払い)アプリ方式、メルペイ、Alipay以外の決済手段では指定しないでください。  
            省略時はデフォルトで<span class="mp-oas-code">WEB_LINK</span>が設定されます。 
            - <span class="mp-oas-code">APP_LINK</span>：Pay払いの決済事業者のモバイルアプリリンク
            - <span class="mp-oas-code">WEB_LINK</span>：Pay払いの決済事業者にリダイレクトする外部ブラウザのリンク  
          enum:
            - APP_LINK
            - WEB_LINK
          example: WEB_LINK
    WalletFrontendChargeOptions:
      type: object
      required:
        - authorizationMode
      description: Pay払いの支払いオプション
      properties:
        authorizationMode:
          type: string
          description: |
            支払い要求のタイプ  
            - <span class="mp-oas-code">AUTH</span>：仮売上
            - <span class="mp-oas-code">CAPTURE</span>：即時売上
          enum:
            - AUTH
            - CAPTURE
          example: AUTH
    WalletFrontendType:
      type: string
      description: |
        Pay払いタイプ  
        - <span class="mp-oas-code">PAYPAY</span>：PayPay
      enum:
        - PAYPAY
      example: PAYPAY
    OnfileWallet:
      type: object
      description: 登録されているPay払い情報
      required:
        - type
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: |
            会員ID
        type:
          $ref: '#/components/schemas/OnfileWalletType'
          description: |
            登録されているPay払いのタイプ  
            登録されているPay払いのタイプによってパラメーターの設定要否が異なります。  
            詳細は[共通パラメーター対応表 - Pay払い](/mulpay/apis/openapi-type/common-parameters#pay払い)を参照ください。
            - <span class="mp-oas-code">PAYPAY</span>：PayPay
            - <span class="mp-oas-code">DOCOMO</span>：d払い
            - <span class="mp-oas-code">RAKUTEN</span>：楽天ペイ(オンライン決済)V2
            - <span class="mp-oas-code">AMAZON</span>：Amazon Pay V2
            - <span class="mp-oas-code">AU_APP</span>：au PAY(ネット支払い)アプリ方式
            - <span class="mp-oas-code">MERPAY</span>：メルペイ
    WalletType:
      type: string
      description: |
        Pay払いタイプ  
        Pay払いタイプによってパラメーターの設定要否が異なります。  
        詳細は[共通パラメーター対応表 - Pay払い](/mulpay/apis/openapi-type/common-parameters#pay払い)を参照ください。
        - <span class="mp-oas-code">PAYPAY</span>：PayPay
        - <span class="mp-oas-code">DOCOMO</span>：d払い
        - <span class="mp-oas-code">RAKUTEN</span>：楽天ペイ(オンライン決済)V2
        - <span class="mp-oas-code">AMAZON</span>：Amazon Pay V2
        - <span class="mp-oas-code">AU_APP</span>：au PAY(ネット支払い)アプリ方式
        - <span class="mp-oas-code">MERPAY</span>：メルペイ
        - <span class="mp-oas-code">ALIPAY</span>：Alipay  **<span >※本番環境でのAlipayの利用開始時期は調整中です。</span>**  
        - <span class="mp-oas-code">AEON</span>：AEON Pay
      enum:
        - PAYPAY
        - DOCOMO
        - RAKUTEN
        - AU_APP
        - MERPAY
        - AMAZON
        - ALIPAY
        - AEON
      example: PAYPAY
    WalletOnfileInformation:
      type: object
      description: Pay払い(随時)情報
      required:
        - walletChargeOptions
        - onfileWallet
      properties:
        walletChargeOptions:
          $ref: '#/components/schemas/WalletChargeOptions'
        onfileWallet:
          $ref: '#/components/schemas/OnfileWallet'
        amazonPay:
          $ref: '#/components/schemas/OnfileAmazonPay'
    WalletAuthorizationInformation:
      type: object
      description: Pay払い利用承諾情報
      required:
        - walletType
        - walletAuthorizationOptions
      properties:
        walletType:
          $ref: '#/components/schemas/OnfileWalletType'
          description: |
            登録するPay払い利用承諾のタイプ  
            登録するPay払い利用承諾のタイプによってパラメーターの設定要否が異なります。  
            詳細は[共通パラメーター対応表 - Pay払い](/mulpay/apis/openapi-type/common-parameters#pay払い)を参照ください。
            - <span class="mp-oas-code">PAYPAY</span>：PayPay
            - <span class="mp-oas-code">DOCOMO</span>：d払い
            - <span class="mp-oas-code">RAKUTEN</span>：楽天ペイ(オンライン決済)V2
            - <span class="mp-oas-code">AMAZON</span>：Amazon Pay V2
            - <span class="mp-oas-code">AU_APP</span>：au PAY(ネット支払い)アプリ方式
            - <span class="mp-oas-code">MERPAY</span>：メルペイ
        walletAuthorizationOptions:
          $ref: '#/components/schemas/WalletAuthorizationOptions'
        amazonPay:
          $ref: '#/components/schemas/AmazonPay'
    WalletAuthorizationOptions:
      type: object
      required:
        - memberId
      description: |
        Pay払い利用承諾オプション情報
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
          description: |
            利用承諾を登録する対象の会員ID  
            該当する会員IDが存在しない場合は登録できませんが、<span class="mp-oas-code">createNewMember</span>パラメーターを<span class="mp-oas-code">true</span>にすることで会員IDを新規登録します。
        memberName:
          $ref: '#/components/schemas/MemberName'
          description: |
            新規登録する会員の名称  
            会員を新規登録する場合にのみ設定できます。  
            すでに会員が存在する場合、会員の名称は更新されません。
        createNewMember:
          type: boolean
          description: |
            会員ID未登録時の新規作成  
            <span class="mp-oas-code">true</span>にすると、指定した会員IDが存在しない場合に新規登録します。
          default: false
        transitionType:
          type: string
          description: |
            Pay払いの決済事業者へのリダイレクト方式  
            Pay払いの決済事業者画面へ遷移する方法を指定します。  
            メルペイで利用可能です。   
            メルペイ以外の決済手段では指定しないでください。  
            省略時はデフォルトで<span class="mp-oas-code">WEB_LINK</span>が設定されます。 
            - <span class="mp-oas-code">APP_LINK</span>：Pay払いの決済事業者のモバイルアプリリンク
            - <span class="mp-oas-code">WEB_LINK</span>：Pay払いの決済事業者にリダイレクトする外部ブラウザのリンク  
          enum:
            - APP_LINK
            - WEB_LINK
          example: WEB_LINK
    WalletResult:
      type: object
      description: Pay払い結果情報
      properties:
        walletType:
          $ref: '#/components/schemas/WalletType'
        settlementCode:
          type: string
          description: 決済番号
          example: '1234567890'
        acceptanceCode:
          type: string
          description: 利用承諾番号
          example: '1234567890'
        captureExpiryDateTime:
          type: string
          format: date-time
          description: |
            仮売上有効日時  
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記です。  
            例) 2023-06-30T12:34:56+09:00
          example: '2023-06-30T12:34:56+09:00'
    WalletFrontendResult:
      type: object
      description: Pay払い 都度支払い（フロントエンド方式）結果情報
      properties:
        walletType:
          $ref: '#/components/schemas/WalletFrontendType'
        settlementCode:
          type: string
          description: |
            決済番号 <br/>
            [/wallet/front-end/charge](/mulpay/apis/openapi-type/wallet-frontend-charge)では返りません。<br/>
          example: '1234567890'
        captureExpiryDateTime:
          type: string
          format: date-time
          description: |
            仮売上有効日時  
            [/wallet/front-end/charge](/mulpay/apis/openapi-type/wallet-frontend-charge)では返りません。<br/>
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記です。  
            例) 2023-06-30T12:34:56+09:00
          example: '2023-06-30T12:34:56+09:00'
        frontendPaymentId:
          type: string
          description: |
            決済番号（フロントエンド利用）<br/>
            [/wallet/front-end/verifyCharge](/mulpay/apis/openapi-type/wallet-frontend-verify-charge)では返りません。
          example: '1234567890'
    AmazonPay:
      type: object
      description: Amazon Pay V2専用パラメーター
      properties:
        checkoutSessionId:
          type: string
          description: |
            チェックアウトセッションID  
            APBタイプ<span class="mp-oas-code">apbType</span>を設定しない場合は必須です。
          maxLength: 256
          example: 931782ff-12db-46d0-ba57-f7cc7ee10560
        noteToBuyer:
          type: string
          description: |
            注文の説明  
            注文の説明です。  
            Amazonからお客様へのメールに表示されます。
          maxLength: 255
          example: 渋谷店
        apbType:
          type: string
          pattern: ^(PayOnly|PayAndShip)$
          description: |
            APBタイプ  
            [APB(AdditionalPaymentButton)機能](https://www.amazonpay-faq.jp/faq/QA-66)を利用する場合のみ設定してください。   
            - <span class="mp-oas-code">PayOnly</span>: デジタル商品など住所情報を使用しない場合  
            - <span class="mp-oas-code">PayAndShip</span>: 物販など住所情報を使用する場合  
            <span class="mp-oas-code">PayAndShip</span>の場合、以下パラメーターは必須です。  
            住所の宛名<span class="mp-oas-code">order.shippingAddress.name</span>  
            住所の町域・丁目番地<span class="mp-oas-code">order.shippingAddress.line1</span>  
            住所の市区町村<span class="mp-oas-code">order.shippingAddress.city</span>  
            住所の都道府県番号<span class="mp-oas-code">order.shippingAddress.state</span>  
            住所の郵便番号<span class="mp-oas-code">order.shippingAddress.postCode</span>  
            住所の国番号<span class="mp-oas-code">order.shippingAddress.country</span>  
            電話番号<span class="mp-oas-code">payer.phones.number</span>(1件目が使用されます)
          example: PayOnly
    OnfileAmazonPay:
      type: object
      description: Amazon Pay V2専用パラメーター
      properties:
        noteToBuyer:
          type: string
          description: |
            注文の説明  
            注文の説明です。  
            Amazonからお客様へのメールに表示されます。
          maxLength: 255
          example: 渋谷店
    CustomerDataAmazonPay:
      type: object
      description: Amazon Pay V2専用パラメーター
      properties:
        checkoutSessionId:
          type: string
          description: |
            チェックアウトセッションID
          maxLength: 256
          example: 931782ff-12db-46d0-ba57-f7cc7ee10560
    PayPay:
      type: object
      description: PayPay専用パラメーター
      properties:
        jws:
          type: string
          pattern: ^[0-9a-zA-Z*_@\s.-]{1,4000}$
          description: |
            お客様が加盟店様画面にて支払いをした場合に返るjws
          maxLength: 4000
          example: dGVzdGp3cy50ZXN0andzLnRlc3Rqd3M
    BuyerId:
      type: string
      description: 購入者のID
      example: amzn1.account.XXXXXXXXXXXXXXXXXXXXXXXXXXXX
    Remarks:
      type: string
      description: |
        備考  
        Amazon Pay V2ではお支払い情報が設定されます。
      example: JCB ****1111 (Amazon Pay)
    CashInformation:
      type: object
      description: 現金払い情報
      required:
        - cashType
      properties:
        cashType:
          $ref: '#/components/schemas/mulpay'
        cashOptions:
          $ref: '#/components/schemas/CashOptions'
        displayInformation:
          $ref: '#/components/schemas/DisplayInformation'
    CashOptions:
      type: object
      description: 現金払いオプション情報
      properties:
        konbiniCode:
          $ref: '#/components/schemas/mulpay-2'
        paymentPeriod:
          type: string
          pattern: ^[0-9]{1,3}$
          description: |
            支払い期間(日)  
            お客様がお支払いできる期間を日数で設定します。  
            プロトコルタイプ/モジュールタイプにおける<span class="mp-oas-code">PaymentTermDay</span>(支払期限日数)や<span class="mp-oas-code">TradeDays</span>(取引有効日数)パラメーターと同じであり、設定値は変更せずに移行できます。  
            期間最終日の23時59分59秒までお支払いが可能です。  
            例) 2024年1月1日12時に支払い期限日<span class="mp-oas-code">10</span>の場合、支払い期限は2024年1月11日23時59分59秒です。  
            日時形式で設定する場合は、支払い期限日時<span class="mp-oas-code">paymentExpiryDateTime</span>パラメーターをご利用ください。  
            支払い期間(日)<span class="mp-oas-code">paymentPeriod</span>と支払い期限日時<span class="mp-oas-code">paymentExpiryDateTime</span>の両方を設定すると、支払い期限日時<span class="mp-oas-code">paymentExpiryDateTime</span>が優先されます。  
            <br />
            現金払いタイプ <span class="mp-oas-code">cashType</span>、支払先コンビニコード <span class="mp-oas-code">konbiniCode</span>により設定可能な値が異なります。  

            <table>
              <thead>
                <tr>
                  <th>現金払いタイプ<br /><span class="mp-oas-code">cashType</span></th>
                  <th>支払先<br />コンビニコード<br /><span class="mp-oas-code">konbiniCode</span></th>
                  <th >最小</th>
                  <th >最大</th>
                  <th ><span class="mp-oas-code">999</span>設定時</th>
                  <th>省略時</th>
                </tr>
              </thead>
              <tbody>
                <tr>
                  <td rowspan="5">コンビニ<br /><span class="mp-oas-code">KONBINI</span></td>
                  <td>セブン-イレブン<br /><span class="mp-oas-code">SEVEN_ELEVEN</span></td>
                  <td >0<br />(当日)</td>
                  <td >150</td>
                  <td >150</td>
                  <td><small>デフォルト値<sup>*1</sup></small></td>
                </tr>
                <tr>
                  <td>ローソン<br /><span class="mp-oas-code">LAWSON</span></td>
                  <td >0<br />(当日)</td>
                  <td >180</td>
                  <td >180</td>
                  <td><small>デフォルト値<sup>*1</sup></small></td>
                </tr>
                <tr>
                  <td>ファミリーマート<br /><span class="mp-oas-code">FAMILYMART</span></td>
                  <td >0<br />(当日)</td>
                  <td >60</td>
                  <td >60</td>
                  <td><small>デフォルト値<sup>*1</sup></small></td>
                </tr>
                <tr>
                  <td>ミニストップ<br /><span class="mp-oas-code">MINISTOP</span></td>
                  <td >0<br />(当日)</td>
                  <td >180</td>
                  <td >180</td>
                  <td><small>デフォルト値<sup>*1</sup></small></td>
                </tr>
                <tr>
                  <td>セイコーマート<br /><span class="mp-oas-code">SEICOMART</span></td>
                  <td >0<br />(当日)</td>
                  <td >180</td>
                  <td >180</td>
                  <td><small>デフォルト値<sup>*1</sup></small></td>
                </tr>
                <tr>
                  <td colspan="2">Pay-easy<br /><span class="mp-oas-code">PAYEASY</span></td>
                  <td >0<br />(当日)</td>
                  <td >60</td>
                  <td >エラー</td>
                  <td><small>デフォルト値<sup>*1</sup></small><br />60日以降は59日に変換</td>
                </tr>
                <tr>
                  <td colspan="2">銀行振込(バーチャル口座)<br /><span class="mp-oas-code">BANK_TRANSFER_SMBC</span></td>
                  <td >0<br />(当日)</td>
                  <td >99</td>
                  <td >エラー</td>
                  <td>省略不可</td>
                </tr>
                <tr>
                  <td colspan="2">銀行振込(バーチャル口座あおぞら)<br /><span class="mp-oas-code">BANK_TRANSFER_GMO_AOZORA</span></td>
                  <td >0<br />(当日)</td>
                  <td >999</td>
                  <td >999</td>
                  <td>支払い期限なし</td>
                </tr>
                <tr>
                  <td colspan="2">マイペイメント<br /><span class="mp-oas-code">MYPAYMENT</span></td>
                  <td >0<br />(当日)</td>
                  <td >59</td>
                  <td >エラー</td>
                  <td>59</td>
                </tr>
              </tbody>
            </table>

            *1：デフォルト値は管理画面から設定します。変更の方法はこちらの[FAQページ](https://mp-faq.gmo-pg.com/s/article/D00103)を参照ください。  
          example: '7'
        paymentExpiryDateTime:
          type: string
          description: |-
            支払い期限日時  
            お客様が支払いできる期限を日時(YYYYMMDDHHMM)形式で設定します。  
            <br />
            現金払いタイプ <span class="mp-oas-code">cashType</span>、支払先コンビニコード <span class="mp-oas-code">konbiniCode</span>により設定可能な値が異なります。  

            <table>
                <thead>
                    <tr>
                        <th>現金払いタイプ<br /> <span class="mp-oas-code">cashType</span> </th>
                        <th>支払先<br />コンビニコード<br /><span class="mp-oas-code">konbiniCode</span></th>
                        <th >利用</th>
                        <th>最大</th>
                        <th>注意事項</th>
                    </tr>
                </thead>
                <tbody>
                    <tr>
                        <td rowspan="5">コンビニ<br /><span class="mp-oas-code">KONBINI</span></td>
                        <td>セブン-イレブン<br /><span class="mp-oas-code">SEVEN_ELEVEN</span></td>
                        <td >×</td>
                        <td >-</td>
                        <td>設定するとエラー</td>
                    </tr>
                    <tr>
                        <td>ローソン<br /><span class="mp-oas-code">LAWSON</span></td>
                        <td >〇</td>
                        <td>181日後の0時0分</td>
                        <td></td>
                    </tr>
                    <tr>
                        <td>ファミリーマート<br /><span class="mp-oas-code">FAMILYMART</span></td>
                        <td >〇</td>
                        <td>61日後の0時0分</td>
                        <td></td>
                    </tr>
                    <tr>
                        <td>ミニストップ<br /><span class="mp-oas-code">MINISTOP</span></td>
                        <td >〇</td>
                        <td>181日後の0時0分</td>
                        <td></td>
                    </tr>
                    <tr>
                        <td>セイコーマート<br /><span class="mp-oas-code">SEICOMART</span></td>
                        <td >〇</td>
                        <td>181日後の0時0分</td>
                        <td>時分に<span class="mp-oas-code">0001</span>は<br />設定不可</td>
                    </tr>
                    <tr>
                        <td colspan="2">Pay-easy<br /><span class="mp-oas-code">PAYEASY</span></td>
                        <td >〇</td>
                        <td>61日後の0時0分</td>
                        <td>時分指定を無視し、23時59分59秒で設定<br />60日以降は59日に変換</td>
                    </tr>
                    <tr>
                        <td colspan="2">銀行振込(バーチャル口座)<br /><span class="mp-oas-code">BANK_TRANSFER_SMBC</span></td>
                        <td >×</td>
                        <td >-</td>
                        <td>設定するとエラー</td>
                    </tr>
                    <tr>
                        <td colspan="2">銀行振込(バーチャル口座あおぞら)<br /><span class="mp-oas-code">BANK_TRANSFER_GMO_AOZORA</span></td>
                        <td >×</td>
                        <td >-</td>
                        <td>設定するとエラー</td>
                    </tr>
                    <tr>
                        <td colspan="2">マイペイメント<br /><span class="mp-oas-code">MYPAYMENT</span></td>
                        <td >〇</td>
                        <td >59日後</td>
                        <td>時分指定を無視し、23時59分59秒で設定</td>
                    </tr>
                </tbody>
            </table>
          example: 202401231800
        useRecurringAccount:
          type: boolean
          description: |-
            継続口座利用フラグ  
            銀行振込(バーチャル口座あおぞら)で継続口座を利用する場合は<span class="mp-oas-code">true</span>を設定します。
          default: false
          example: false
    DisplayInformation:
      type: object
      description: 画面・明細表示情報
      properties:
        registerDisplay1:
          type: string
          description: |
            POSレジ表示欄1  
            設定できる最大長はUTF-8で48byteです。  
            全角のみ設定可能です。
          maxLength: 32
          example: ＰＯＳレジ表示欄１
        registerDisplay2:
          type: string
          description: |
            POSレジ表示欄2  
            設定できる最大長はUTF-8で48byteです。  
            全角のみ設定可能です。
          maxLength: 32
          example: ＰＯＳレジ表示欄２
        registerDisplay3:
          type: string
          description: |
            POSレジ表示欄3  
            設定できる最大長はUTF-8で48byteです。  
            全角のみ設定可能です。
          maxLength: 32
          example: ＰＯＳレジ表示欄３
        registerDisplay4:
          type: string
          description: |
            POSレジ表示欄4  
            設定できる最大長はUTF-8で48byteです。  
            全角のみ設定可能です。
          maxLength: 32
          example: ＰＯＳレジ表示欄４
        registerDisplay5:
          type: string
          description: |
            POSレジ表示欄5  
            設定できる最大長はUTF-8で48byteです。  
            全角のみ設定可能です。
          maxLength: 32
          example: ＰＯＳレジ表示欄５
        registerDisplay6:
          type: string
          description: |
            POSレジ表示欄6  
            設定できる最大長はUTF-8で48byteです。  
            全角のみ設定可能です。
          maxLength: 32
          example: ＰＯＳレジ表示欄６
        registerDisplay7:
          type: string
          description: |
            POSレジ表示欄7  
            設定できる最大長はUTF-8で48byteです。  
            全角のみ設定可能です。
          maxLength: 32
          example: ＰＯＳレジ表示欄７
        registerDisplay8:
          type: string
          description: |
            POSレジ表示欄8  
            設定できる最大長はUTF-8で48byteです。  
            全角のみ設定可能です。
          maxLength: 32
          example: ＰＯＳレジ表示欄８
        receiptDisplay1:
          type: string
          description: |
            明細表示欄1  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄１
        receiptDisplay2:
          type: string
          description: |
            明細表示欄2  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄２
        receiptDisplay3:
          type: string
          description: |
            明細表示欄3  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄３
        receiptDisplay4:
          type: string
          description: |
            明細表示欄4  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄４
        receiptDisplay5:
          type: string
          description: |
            明細表示欄5  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄５
        receiptDisplay6:
          type: string
          description: |
            明細表示欄6  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄６
        receiptDisplay7:
          type: string
          description: |
            明細表示欄7  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄７
        receiptDisplay8:
          type: string
          description: |
            明細表示欄8  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄８
        receiptDisplay9:
          type: string
          description: |
            明細表示欄9  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄９
        receiptDisplay10:
          type: string
          description: |
            明細表示欄10  
            設定できる最大長はUTF-8で90byteです。  
            全角のみ設定可能です。
          maxLength: 60
          example: 明細表示欄１０
    CashType:
      type: string
      description: |
        現金払いタイプ  
        現金払いタイプによってパラメーターの設定要否が異なります。  
        詳細は[共通パラメーター対応表 - 現金払い](/mulpay/apis/openapi-type/common-parameters#現金払い)を参照ください。
        - <span class="mp-oas-code">KONBINI</span>：コンビニ
        - <span class="mp-oas-code">PAYEASY</span>：Pay-easy
        - <span class="mp-oas-code">BANK_TRANSFER_SMBC</span>：銀行振込(バーチャル口座)
        - <span class="mp-oas-code">BANK_TRANSFER_GMO_AOZORA</span>：銀行振込(バーチャル口座 あおぞら)
        - <span class="mp-oas-code">MYPAYMENT</span>：マイペイメント
      enum:
        - KONBINI
        - PAYEASY
        - BANK_TRANSFER_SMBC
        - BANK_TRANSFER_GMO_AOZORA
        - MYPAYMENT
    CashResult:
      type: object
      description: 現金払い結果情報
      properties:
        cashType:
          $ref: '#/components/schemas/mulpay'
        paymentExpiryDateTime:
          type: string
          format: date-time
          description: |
            支払い期限日時  
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記です。  
            例) 2023-05-30T12:34:56+09:00
          example: '2023-05-30T12:34:56+09:00'
        konbiniPaymentInformation:
          type: object
          description: コンビニ支払い情報
          properties:
            konbiniCode:
              $ref: '#/components/schemas/mulpay-2'
            confirmationNumber:
              type: string
              description: 確認番号
              example: '1234567890'
            receiptNumber:
              type: string
              description: 受付番号
              example: '1234567890'
            voucherUrl:
              type: string
              format: uri
              description: 払込票URL(一部のコンビニのみ)
            storeCode:
              type: string
              description: |
                店舗コード  
                コンビニ店舗を識別するための番号です。  
                セブン-イレブンを除き、お客様による入金が完了している場合に返ります。
              example: '0000000'
        pay-easyPaymentInformation:
          type: object
          description: Pay-easy支払い情報
          properties:
            customerNumber:
              type: string
              description: お客様番号
              example: WNT12345678
            institutionCode:
              type: string
              description: 収納機関番号
              example: '58021'
            confirmationNumber:
              type: string
              description: 確認番号
              example: '1234567890'
            bankUrl:
              type: string
              format: uri
              description: 銀行サイトURL
              example: https://example.com/bank
        bankTransferPaymentInformation:
          type: object
          description: バーチャル口座振込支払い情報
          properties:
            bankCode:
              type: string
              description: 銀行コード
              example: '0310'
            bankName:
              type: string
              description: 銀行名
              example: ｼﾞ-ｴﾑｵ-ｱｵｿﾞﾗﾈﾂﾄ
            branchCode:
              type: string
              description: 支店コード
              example: '503'
            branchName:
              type: string
              description: 支店名
              example: ｶｿｳｼﾃﾝ
            accountType:
              type: string
              description: 口座種目
              example: '1'
            accountNumber:
              type: string
              description: 口座番号
              example: '1234567'
            accountHolderName:
              type: string
              description: 口座名義人名
              example: ﾃｽﾄｺｳｻﾞ
            depositAmount:
              type: string
              description: 合計入金金額
              example: '1000'
            bankTransferCode:
              type: string
              description: 振込コード
              example: '1010101'
        mypaymentInformation:
          type: object
          description: マイペイメント支払い情報
          properties:
            barcodeUrl:
              type: string
              format: uri
              description: バーコード表示URL
              example: https://example.com/usr/paymng?A11BC1234F78F4A1CFCDF49FC00B3D6A
            inquiryNo:
              type: string
              description: お問合せ番号
              example: '88041623856'
            konbiniCode:
              type: string
              description: |
                支払先コンビニコード    
                お客様による入金が完了している場合に返ります。
                - <span class="mp-oas-code">SEVEN_ELEVEN</span>：セブン-イレブン
                - <span class="mp-oas-code">LAWSON</span>：ローソン
                - <span class="mp-oas-code">FAMILYMART</span>：ファミリーマート
                - <span class="mp-oas-code">MINISTOP</span>：ミニストップ
                - <span class="mp-oas-code">SEICOMART</span>：セイコーマート
                - <span class="mp-oas-code">SHINKIN</span>：しんきん情報
              enum:
                - SEVEN_ELEVEN
                - LAWSON
                - FAMILYMART
                - MINISTOP
                - SEICOMART
                - SHINKIN
              example: LAWSON
            konbiniName:
              type: string
              description: |
                コンビニ名  
                お客様による入金が完了している場合に返ります。
              example: ローソン
            storeCode:
              type: string
              description: |
                店舗コード  
                お客様による入金が完了している場合に返ります。
              example: '00000000'
            mypaymentReceiptDate:
              type: string
              format: date-time
              description: |
                取扱店収納日時  
                コンビニエンスストア等でお客様が入金した日時です。  
                お客様による入金が完了している場合に返ります。
              example: '2023-05-30T23:59:59+09:00'
            mypaymentReturnDate:
              type: string
              format: date-time
              description: |
                取消受付日時  
                入金取消を受け付けした日時です。二重入金などが発生した場合に取消が通知されます。  
                入金取消が行われた場合に返ります。
              example: '2023-05-30T23:59:59+09:00'
    OnfileCardResult:
      type: object
      description: カードの登録結果
      properties:
        memberId:
          $ref: '#/components/schemas/MemberId'
        memberName:
          $ref: '#/components/schemas/MemberName'
        type:
          $ref: '#/components/schemas/OnfileCardType'
        cardId:
          $ref: '#/components/schemas/OnfileCardId'
        isDefault:
          description: |
            デフォルトカード判定  
            デフォルトカードの場合<span class="mp-oas-code">true</span>、そうでない場合<span class="mp-oas-code">false</span>です。
          type: boolean
          example: true
    deferredpayInformation:
      type: object
      description: 後払い情報
      required:
        - deferredpayType
      properties:
        deferredpayType:
          $ref: '#/components/schemas/DeferredpayType'
        atokaraInformation:
          $ref: '#/components/schemas/AtokaraInformation'
    DeferredpayType:
      type: string
      description: |
        後払いタイプ  
        - <span class="mp-oas-code">ATOKARA</span>：アトカラ
      enum:
        - ATOKARA
      example: ATOKARA
    AtokaraInformation:
      type: object
      description: アトカラ専用パラメーター
      properties:
        pdCompanyCode:
          type: string
          pattern: ^[0-9a-zA-Z]{2}$
          enum:
            - '00'
            - '11'
            - '12'
            - '14'
            - '15'
            - '16'
            - '18'
            - '27'
            - '28'
          description: |
            運送会社コード<br />[出荷報告](/mulpay/apis/openapi-type/deferredpay-shipping)、[出荷変更](/mulpay/apis/openapi-type/deferredpay-shipping-update)で利用可能です。<br />指定可能な値は以下の通りです。  
            - <span class="mp-oas-code">00</span>: 自動着荷  
            - <span class="mp-oas-code">11</span>: 佐川急便  
            - <span class="mp-oas-code">12</span>: ヤマト運輸  
            - <span class="mp-oas-code">14</span>: 西濃運輸  
            - <span class="mp-oas-code">15</span>: 郵便書留・特定記録郵便  
            - <span class="mp-oas-code">16</span>: ゆうパック  
            - <span class="mp-oas-code">18</span>: 福山通運  
            - <span class="mp-oas-code">27</span>: エコ配  
            - <span class="mp-oas-code">28</span>: レターパック    
          maxLength: 2
          example: '00'
        slipNo:
          type: string
          pattern: ^[0-9a-zA-Z]{5,20}$
          description: 発送伝票番号<br />[出荷報告](/mulpay/apis/openapi-type/deferredpay-shipping)、[出荷変更](/mulpay/apis/openapi-type/deferredpay-shipping-update)で利用可能です。<br />指定しない場合は<span class="mp-oas-code">settlementCode</span>が適用されます。
          maxLength: 20
          example: '123456789'
        shippingNameKana:
          type: string
          description: 配送先住所の宛名（カナ）<br />[取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で利用可能です。<br />設定できる最大長はUTF-8で75byteです。
          maxLength: 25
          example: ミホン　タロウ
        shippingDepartmentName:
          type: string
          description: 配送先部署名<br />[取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で利用可能です。<br />設定できる最大長はUTF-8で90byteです。
          maxLength: 30
          example: 営業部
        shippingPhone:
          type: string
          pattern: ^[0-9-]+$
          description: 配送先電話番号<br />[取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で配送先情報と購入者情報が異なる場合は必須です。
          maxLength: 13
          example: 000-0000-0000
        payerDepartmentName:
          type: string
          description: 購入者部署名<br />[取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で利用可能です。<br />設定できる最大長はUTF-8で90byteです。
          maxLength: 30
          example: 営業部
        payerSecondaryEmail:
          type: string
          description: |
            購入者のメールアドレス2  
            <br />[取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で利用可能です。<br />[RFC 5322](https://www.rfc-editor.org/rfc/rfc5322)の仕様に沿った形式のみ許可されます。
          maxLength: 254
          example: taro.mihon@example.com
        brands:
          type: array
          items:
            $ref: '#/components/schemas/Brand'
          maxItems: 15
          description: 明細情報のブランド一覧
    Brand:
      type: object
      properties:
        name:
          type: string
          maxLength: 300
          description: |
            ブランド名  
            <br />[取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で利用可能です。[取引変更](/mulpay/apis/openapi-type/deferredpay-order-update)で指定したorder.itemsの要素と対応するように設定してください。<br />設定できる最大長はUTF-8で900byteです。
          example: テストブランド1
    DeferredpayResult:
      type: object
      description: 後払い結果情報
      properties:
        deferredpayType:
          $ref: '#/components/schemas/DeferredpayType'
        settlementCode:
          type: string
          description: 決済番号
          example: 12345abcde
        captureExpiryDateTime:
          type: string
          format: date-time
          description: |
            仮売上有効日時  
            <span class="mp-oas-code">status</span>フィールドが<span class="mp-oas-code">AUTH</span>の時のみ返されます。<br/>
            [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6)で定義された表記です。  
            例) 2023-06-30T12:34:56+09:00
          example: '2023-06-30T12:34:56+09:00'
    VerificationInformation:
      type: object
      description: Verify情報
      required:
        - type
        - verificationId
      properties:
        type:
          $ref: '#/components/schemas/VerificationType'
        verificationId:
          $ref: '#/components/schemas/VerificationId'
          description: |
            認証ID  
            加盟店様にてユニークな値を発行してください。
        verificationOptions:
          $ref: '#/components/schemas/VerificationOptions'
        smsPinData:
          $ref: '#/components/schemas/SmsPinData'
    VerificationOptions:
      type: object
      description: 認証のオプション
      properties:
        sessionDurationSeconds:
          type: string
          maxLength: 4
          description: |
            セッション有効期間（秒）  
            ユーザーが認証操作を行える期間を60~1800秒の間で設定できます。  
            未指定の場合は600秒(10分)です。
          default: '600'
          example: '600'
        userMaxRetry:
          type: string
          maxLength: 1
          description: |
            認証リトライ最大回数  
            ユーザーの認証リトライ最大回数を0~5回の間で設定できます。  
            SMS認証の場合、認証コード入力をリトライできる最大回数を指します。  
            未指定の場合は3回です。
          default: '3'
          example: '3'
    SmsPinData:
      type: object
      description: 認証コード情報
      properties:
        smsPhoneNumber:
          type: string
          maxLength: 13
          description: |
            携帯電話番号  
            <span class="mp-oas-code">verificationInformation.type</span>が<span class="mp-oas-code">sms-pin</span>の場合は必須です。  
            090、080、070から始まる日本の携帯電話番号を指定してください。  
            海外電話番号へのSMS配信は行えません。
          example: '09012345678'
        pinType:
          type: string
          description: |
            認証コード桁数
            未指定の場合は6桁です。
            - <span class="mp-oas-code">digits-4</span>：4桁
            - <span class="mp-oas-code">digits-6</span>：6桁
          enum:
            - digits-4
            - digits-6
          default: digits-6
          example: digits-6
    Problem:
      type: object
      properties:
        type:
          description: |
            エラーの説明ページURL  
            対応するページがある場合のみ返ります。
          type: string
          maxLength: 256
          example: https://example.com/errors
        title:
          description: |
            エラーの内容サマリー  
            エラーコードとして取り扱えます。
          type: string
          maxLength: 32
        detail:
          description: |
            エラーの詳細説明  
            エラーメッセージとして取り扱えます。
          type: string
          maxLength: 256
        instance:
          description: |
            エラーが発生したエンドポイント  
            ホスト名は含まれません。
          type: string
          maxLength: 40
    mulpay:
      type: string
      description: |
        現金払いタイプ  
        現金払いタイプによってパラメーターの指定要否が異なります。  
        詳細は[共通パラメーター対応表 - 現金払い](#tag/common-parameters/現金払い)を参照ください。  
        - <span class="mp-oas-code">KONBINI</span>：コンビニ
        - <span class="mp-oas-code">PAYEASY</span>：Pay-easy
        - <span class="mp-oas-code">BANK_TRANSFER_SMBC</span>：銀行振込(バーチャル口座)
        - <span class="mp-oas-code">BANK_TRANSFER_GMO_AOZORA</span>：銀行振込(バーチャル口座 あおぞら)
        - <span class="mp-oas-code">MYPAYMENT</span>：マイペイメント
      enum:
        - KONBINI
        - PAYEASY
        - BANK_TRANSFER_SMBC
        - BANK_TRANSFER_GMO_AOZORA
        - MYPAYMENT
    mulpay-2:
      type: string
      description: |
        支払先コンビニコード  
        コンビニ決済では必須です。  
        - <span class="mp-oas-code">SEVEN_ELEVEN</span>：セブン-イレブン
        - <span class="mp-oas-code">LAWSON</span>：ローソン
        - <span class="mp-oas-code">FAMILYMART</span>：ファミリーマート
        - <span class="mp-oas-code">MINISTOP</span>：ミニストップ
        - <span class="mp-oas-code">SEICOMART</span>：セイコーマート
      enum:
        - SEVEN_ELEVEN
        - LAWSON
        - FAMILYMART
        - MINISTOP
        - SEICOMART
      example: LAWSON
  responses:
    409Response:
      x-summary: 二重リクエスト
      description: |
        二重リクエストによるエラーが発生した場合のレスポンス
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            title: conflict
            detail: Duplicate request.
            instance: /xxx/xxx
    500Response:
      x-summary: 当サービス内部のシステムエラー
      description: |
        当サービスのシステムで予期せぬエラーが発生した場合のレスポンス
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            title: internal_server_error
            detail: An unexpected error has occurred.
            instance: /xxx/xxx
    502Response:
      x-summary: 外部事業者のシステムエラー
      description: |
        カード会社等の外部事業者からシステムエラーが返る場合のレスポンス
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            title: bad_gateway
            detail: Payment Processing failed at the external payment center. Please try again later.
            instance: /xxx/xxx
  callbacks:
    callbackTds2Charge:
      REQUEST BODYのmerchant.callbackUrlに設定した加盟店様のコールバックURL:
        get:
          operationId: callbackTds2Charge
          summary: 3Dセキュアリダイレクト後のコールバック
          description: |
            3Dセキュア、およびオーソリ(信用照会)の処理が終わると、クレカ支払いリクエストパラメーターの<span class="mp-oas-code">merchant.callbackUrl</span>にコールバックします。  
            加盟店様にて元の取引を特定し、[取引照会API(/order/inquiry)](/mulpay/apis/openapi-type/order-inquiry)を呼び出して結果を確認してください。  
            自動オーソリなし(<span class="mp-oas-code">tds2Information.tds2Options.autoAuthorization</span>が<span class="mp-oas-code">false</span>)の場合は、[3Dセキュア後の支払いAPI(finalizeCharge)](/mulpay/apis/openapi-type/tds-2-finalize-charge)を呼び出します。
          parameters:
            - name: p
              in: query
              description: |
                パラメーター<span class="mp-oas-code">p</span>は当サービスにて付与するもので、以下のJSONパラメーターをBase64URLエンコードした文字列です。  
                詳細は[リダイレクトとコールバック](/mulpay/docs/connection-method/openapi-type/callback-webhook)を参照ください。

                自動オーソリありの場合
                ```json
                {
                  "accessId":"<orderReference.accessId>",
                  "event":"TDS_CHARGE_FINISHED",
                  "csrfToken":"<merchant.csrfToken>"
                }
                ```

                自動オーソリなしの場合
                ```json
                {
                  "accessId":"<orderReference.accessId>",
                  "event":"TDS_FINISHED",
                  "csrfToken":"<merchant.csrfToken>"
                }
                ```
              schema:
                type: string
                example: eyJhY2Nlc3NJZCI6ImFjZGM3ZDUzZjdhNzhmNDg4ZDhkMDk5N2VmZjk5YzZmIiwiZXZlbnQiOiJURFNfQ0hBUkdFX0ZJTklTSEVEIiwiY3NyZlRva2VuIjoiYmRiMDRjNWYtNDJmMC0yOWUyLTA5NzktZWRhZTNlNzc2MGJmIn0=
          responses:
            2xx:
              x-summary: 成功
              description: 加盟店様にて処理結果をお客様のブラウザに表示します。
            4xx:
              x-summary: エラー
              description: 加盟店様にてエラー結果をお客様のブラウザに表示します。
    callbackTds2Verification:
      REQUEST BODYのmerchant.callbackUrlに設定した加盟店様のコールバックURL:
        get:
          operationId: callbackTds2Verification
          summary: 3Dセキュアリダイレクト後のコールバック
          description: |
            3Dセキュア、および有効性確認の処理が終わると、有効性確認リクエストパラメーターのmerchant.callbackUrlにコールバックします。  
            加盟店様にて元の取引を特定し、[取引照会API(/order/inquiry)](/mulpay/apis/openapi-type/order-inquiry)を呼び出して結果を確認してください。  
            自動オーソリなし(<span class="mp-oas-code">tds2Information.tds2Options.autoAuthorization</span>が<span class="mp-oas-code">false</span>)の場合は、[3Dセキュア後の有効性確認API(finalizeVerification)](/mulpay/apis/openapi-type/tds-2-finalize-verification)を呼び出します。
          parameters:
            - name: p
              in: query
              description: |
                パラメーター<span class="mp-oas-code">p</span>は当サービスにて付与するもので、以下のJSONパラメーターをBase64URLエンコードした文字列です。  
                詳細は[リダイレクトとコールバック](/mulpay/docs/connection-method/openapi-type/callback-webhook)を参照ください。

                自動オーソリありの場合
                ```json
                {
                  "accessId":"<orderReference.accessId>",
                  "event":"TDS_VERIFICATION_FINISHED",
                  "csrfToken":"bdb04c5f-42f0-29e2-0979-edae3e7760bf"
                }
                ```

                自動オーソリなしの場合
                ```json
                {
                  "accessId":"<orderReference.accessId>",
                  "event":"TDS_FINISHED",
                  "csrfToken":"<merchant.csrfToken>"
                }
                ```
              schema:
                type: string
                example: eyJhY2Nlc3NJZCI6ImFjZGM3ZDUzZjdhNzhmNDg4ZDhkMDk5N2VmZjk5YzZmIiwiZXZlbnQiOiJURFNfQ0hBUkdFX0ZJTklTSEVEIiwiY3NyZlRva2VuIjoiYmRiMDRjNWYtNDJmMC0yOWUyLTA5NzktZWRhZTNlNzc2MGJmIn0=
          responses:
            2xx:
              x-summary: 成功
              description: 加盟店様にて処理をした結果をお客様のブラウザに表示します。
            4xx:
              x-summary: エラー
              description: 加盟店様にてエラー結果をお客様のブラウザに表示します。
    callbackWalletCharge:
      REQUEST BODYのmerchant.callbackUrlに設定した加盟店様のコールバックURL:
        get:
          operationId: callbackWalletCharge
          summary: Pay払い都度支払いリダイレクト後のコールバック
          description: |
            Pay払いの決済事業者のサイトにリダイレクトし、支払い手続きが終わると、支払いリクエストパラメーターのmerchant.callbackUrlにコールバックします。  
            加盟店様にて元の取引を特定し、[取引照会API(/order/inquiry)](/mulpay/apis/openapi-type/order-inquiry)を呼び出して結果を確認してください。
          parameters:
            - name: p
              in: query
              description: |
                パラメーター<span class="mp-oas-code">p</span>は当サービスにて付与するもので、以下のJSONパラメーターをBase64URLエンコードした文字列です。  
                詳細は[リダイレクトとコールバック](/mulpay/docs/connection-method/openapi-type/callback-webhook)を参照ください。

                ```json
                {
                  "accessId":"<orderReference.accessId>",
                  "event":"WALLET_CHARGE_FINISHED",
                  "csrfToken":"<merchant.csrfToken>"
                }
                ```
              schema:
                type: string
                example: eyJhY2Nlc3NJZCI6ImFjZGM3ZDUzZjdhNzhmNDg4ZDhkMDk5N2VmZjk5YzZmIiwiZXZlbnQiOiJURFNfQ0hBUkdFX0ZJTklTSEVEIiwiY3NyZlRva2VuIjoiYmRiMDRjNWYtNDJmMC0yOWUyLTA5NzktZWRhZTNlNzc2MGJmIn0=
          responses:
            2xx:
              x-summary: 成功
              description: 加盟店様にて処理をした結果をお客様のブラウザに表示します。
            4xx:
              x-summary: エラー
              description: 加盟店様にてエラー結果をお客様のブラウザに表示します。
    callbackWalletApproval:
      REQUEST BODYのmerchant.callbackUrlに設定した加盟店様のコールバックURL:
        get:
          operationId: callbackWalletApproval
          summary: Pay払い利用承諾リダイレクト後のコールバック
          description: |
            Pay払いの決済事業者のサイトにリダイレクトし、手続きが終わると、利用承諾リクエストパラメーターのmerchant.callbackUrlにコールバックします。  
            加盟店様にて元の取引を特定し、[取引照会API(/order/inquiry)](/mulpay/apis/openapi-type/order-inquiry)を呼び出して結果を確認してください。
          parameters:
            - name: p
              in: query
              description: |
                パラメーター<span class="mp-oas-code">p</span>は当サービスにて付与するもので、以下のJSONパラメーターをBase64URLエンコードした文字列です。  
                詳細は[リダイレクトとコールバック](/mulpay/docs/connection-method/openapi-type/callback-webhook)を参照ください。

                ```json
                {
                  "accessId":"<orderReference.accessId>",
                  "event":"WALLET_APPROVAL_FINISHED",
                  "csrfToken":"<merchant.csrfToken>"
                }
                ```
              schema:
                type: string
                example: eyJhY2Nlc3NJZCI6ImFjZGM3ZDUzZjdhNzhmNDg4ZDhkMDk5N2VmZjk5YzZmIiwiZXZlbnQiOiJURFNfQ0hBUkdFX0ZJTklTSEVEIiwiY3NyZlRva2VuIjoiYmRiMDRjNWYtNDJmMC0yOWUyLTA5NzktZWRhZTNlNzc2MGJmIn0=
          responses:
            2xx:
              x-summary: 成功
              description: 加盟店様にて処理をした結果をお客様のブラウザに表示します。
            4xx:
              x-summary: エラー
              description: 加盟店様にてエラー結果をお客様のブラウザに表示します。
    callbackVerificationStart:
      REQUEST BODYのmerchant.callbackUrlに設定した加盟店様のコールバックURL:
        get:
          operationId: callbackVerificationStart
          summary: 認証コード入力画面リダイレクト後のコールバック
          description: |
            当サービスから返る画面にリダイレクトし、ユーザーの認証完了後に認証開始リクエストパラメーターのmerchant.callbackUrlにコールバックします。  
            加盟店様にて元の取引を特定し、[取引照会API(/verification/inquiry)](/mulpay/apis/openapi-type/verification-inquiry)を呼び出して結果を確認してください。
          parameters:
            - name: p
              in: query
              description: |
                パラメーター<span class="mp-oas-code">p</span>は当サービスにて付与するもので、以下のJSONパラメーターをBase64URLエンコードした文字列です。  
                詳細は[リダイレクトとコールバック](/mulpay/docs/connection-method/openapi-type/callback-webhook)を参照ください。

                ```json
                {
                  "accessId":"<verificationReference.accessId}>",
                  "event":"VERIFICATION_FINISHED",
                  "csrfToken":"<merchant.csrfToken>"
                }
                ```
              schema:
                type: string
                example: eyJhY2Nlc3NJZCI6ImFjZGM3ZDUzZjdhNzhmNDg4ZDhkMDk5N2VmZjk5YzZmIiwiZXZlbnQiOiJWRVJJQ0FUSU9OX0ZJTklTSEVEIiwiY3NyZlRva2VuIjoiYmRiMDRjNWYtNDJmMC0yOWUyLTA5NzktZWRhZTNlNzc2MGJmIn0=
          responses:
            2xx:
              x-summary: 成功
              description: 加盟店様にて処理をした結果をお客様のブラウザに表示します。
            4xx:
              x-summary: エラー
              description: 加盟店様にてエラー結果をお客様のブラウザに表示します。
  examples:
    tokenRequestExample:
      value:
        grant_type: client_credentials
        scope: openapi
    tokenResponseExample:
      value:
        access_token: M2NlNjE1ZjYtMzc1Yy00ZGQ5LTg0OTAtOGEwNzliMzYyMjUzOjAwMDAwMDAwMDAwMDA=
        expires_in: '3600'
        scope: openapi
        token_type: bearer
    creditChargeResponseExample1:
      value:
        nextAction: CAPTURE
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTH
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          captureExpiryDateTime: '2023-06-30T12:34:56+09:00'
          useTds2: false
          useFraudDetection: true
        fraudDetectionResult:
          screeningType: RED_SHIELD
          screeningTransactionId: A0B26524E32C053A034F70B608054F6A
          screeningResultCode: ACCEPT
          screeningResultRawData: 000.300.100
    creditChargeResponseExample2:
      value:
        nextAction: NO_ACTION
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CAPTURE
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          useTds2: false
          useFraudDetection: true
        fraudDetectionResult:
          screeningType: RED_SHIELD
          screeningTransactionId: A0B26524E32C053A034F70B608054F6A
          screeningResultCode: ACCEPT
          screeningResultRawData: 000.300.100
    creditChargeTds2ResponseExample1:
      value:
        nextAction: REDIRECT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTHENTICATED
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: CREDIT
        redirectInformation:
          redirectUrl: https://example.com/redirect/3dsecure2?p1=abc&p2=123
          httpMethod: GET
          redirectType: TDS2
    creditTds2FinalizeChargeResponseExample1:
      value:
        nextAction: CAPTURE
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTH
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          captureExpiryDateTime: '2023-06-30T12:34:56+09:00'
          useTds2: true
          useFraudDetection: true
        tds2Result:
          eci: '05'
          requiresChallenge: false
          tds2TransResult: 'Y'
          tds2TransResultReason: '18'
        fraudDetectionResult:
          screeningType: RED_SHIELD
          screeningTransactionId: A0B26524E32C053A034F70B608054F6A
          screeningResultCode: ACCEPT
          screeningResultRawData: 000.300.100
    creditTds2FinalizeChargeResponseExample2:
      value:
        nextAction: NO_ACTION
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CAPTURE
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          captureExpiryDateTime: '2023-06-30T12:34:56+09:00'
          useTds2: true
          useFraudDetection: true
        tds2Result:
          eci: '05'
          requiresChallenge: false
          tds2TransResult: 'Y'
          tds2TransResultReason: '18'
        fraudDetectionResult:
          screeningType: RED_SHIELD
          screeningTransactionId: A0B26524E32C053A034F70B608054F6A
          screeningResultCode: ACCEPT
          screeningResultRawData: 000.300.100
    creditVerifyCardResponseExample1:
      value:
        nextAction: NO_ACTION
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CHECK
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          useTds2: false
          useFraudDetection: false
        onfileCardResult:
          memberId: member-001
          type: CREDIT_CARD
          cardId: '55'
          isDefault: true
    creditVerifyCardResponseExample2:
      value:
        nextAction: NO_ACTION
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CHECK
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          useTds2: false
          useFraudDetection: false
    creditVerifyCardTds2ResponseExample1:
      value:
        nextAction: REDIRECT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTHENTICATED
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          chargeType: CREDIT
        redirectInformation:
          redirectUrl: https://example.com/redirect/3dsecure2?p1=abc&p2=123
          httpMethod: GET
          redirectType: TDS2
    creditTds2FinalizeVerificationResponseExample1:
      value:
        nextAction: NO_ACTION
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CHECK
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          useTds2: true
          useFraudDetection: false
        onfileCardResult:
          memberId: member-001
          type: CREDIT_CARD
          cardId: '55'
          isDefault: true
        tds2Result:
          eci: '05'
          requiresChallenge: false
          tds2TransResult: 'Y'
          tds2TransResultReason: '18'
    creditTds2FinalizeVerificationResponseExample2:
      value:
        nextAction: NO_ACTION
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CHECK
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          useTds2: true
          useFraudDetection: false
        tds2Result:
          eci: '05'
          requiresChallenge: false
          tds2TransResult: 'Y'
          tds2TransResultReason: '18'
    creditcreditStoreCardResponseExample1:
      value:
        nextAction: NO_ACTION
        onfileCardResult:
          memberId: member-001
          type: CREDIT_CARD
          cardId: '55'
          isDefault: true
        cardResult:
          cardNumber: '************1111'
          cardholderName: TARO MIHON
          expiryMonth: '06'
          expiryYear: '2033'
          issuerCode: 2a99663
    creditGetCardDetailsResponseExample1:
      value:
        cardDetailResult:
          cardNumber: '**********9999'
          cardholderName: TARO MIHON
          expiryMonth: '06'
          expiryYear: '2033'
          brand: VISA
          issuerLocation: JP
          issuerCode: 2a99663
          debitInformation:
            type: DEBIT
            issuerName: VISAデビット-海外
          clientCardBinData:
            info1:
              - Info1
            info2:
              - Info2-1
              - Info2-2
            info3:
              - Info3-1
              - Info3-2
            info4:
              - Info4-1
              - Info4-2
            info5:
              - Info5-1
              - Info5-2
    walletChargeResponseExample1:
      value:
        nextAction: REDIRECT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: REQSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: WALLET
        redirectInformation:
          redirectUrl: https://example.com/redirect/wallet/charge?p1=abc&p2=123
          httpMethod: GET
          redirectType: WALLET_CHARGE
    walletFrontendChargeResponseExample1:
      value:
        nextAction: AWAIT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: REQSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: WALLET
        walletFrontendResult:
          walletType: PAYPAY
          frontendPaymentId: '1234567890'
    walletFrontendVerifyChargeResponseExample1:
      value:
        nextAction: CAPTURE
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTH
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: WALLET
        walletFrontendResult:
          walletType: PAYPAY
          settlementCode: '1234567890'
          captureExpiryDateTime: '2023-06-30T12:34:56+09:00'
    walletFrontendVerifyChargeResponseExample2:
      value:
        nextAction: NO_ACTION
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CAPTURE
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: WALLET
        walletFrontendResult:
          walletType: PAYPAY
          settlementCode: '1234567890'
    walletOnfileChargeResponseExample1:
      value:
        nextAction: CAPTURE
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTH
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: WALLET
        walletResult:
          walletType: PAYPAY
          settlementCode: '1234567890'
          acceptanceCode: '1234567890'
          captureExpiryDateTime: '2023-06-30T12:34:56+09:00'
    walletOnfileChargeResponseExample2:
      value:
        nextAction: NO_ACTION
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CAPTURE
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: WALLET
        walletResult:
          walletType: PAYPAY
          settlementCode: '1234567890'
          acceptanceCode: '1234567890'
    walletAuthorizeAccountResponseExample1:
      value:
        nextAction: REDIRECT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: REQSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          chargeType: WALLET
        redirectInformation:
          redirectUrl: https://example.com/redirect/wallet/authrization?p1=abc&p2=123
          httpMethod: GET
          redirectType: WALLET_AUTHORIZE
    cashChargeResponseExample1:
      value:
        nextAction: AWAIT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: REQSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: CASH
        cashResult:
          cashType: KONBINI
          paymentExpiryDateTime: '2023-05-30T12:34:56+09:00'
          konbiniPaymentInformation:
            konbiniCode: LAWSON
            confirmationNumber: '1234567890'
            receiptNumber: '1234567890'
    cashChargeResponseExample2:
      value:
        nextAction: AWAIT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: REQSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: CASH
        cashResult:
          cashType: PAYEASY
          paymentExpiryDateTime: '2023-05-30T12:34:56+09:00'
          pay-easyPaymentInformation:
            customerNumber: WNT12345678
            institutionCode: '58021'
            confirmationNumber: '1234567890'
            bankUrl: https://example.com/bank
    cashChargeResponseExample3:
      value:
        nextAction: AWAIT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: TRADING
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: CASH
        cashResult:
          cashType: BANK_TRANSFER_SMBC
          paymentExpiryDateTime: '2023-05-30T23:59:59+09:00'
          pay-easyPaymentInformation:
            bankCode: '0009'
            bankName: 三井住友銀行
            branchCode: '931'
            branchName: 東京第一支店
            accountType: '1'
            accountNumber: '1234567'
            bankTransferCode: '1234567'
    cashChargeResponseExample4:
      value:
        nextAction: AWAIT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: TRADING
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: CASH
        cashResult:
          cashType: BANK_TRANSFER_GMO_AOZORA
          paymentExpiryDateTime: '2023-05-30T23:59:59+09:00'
          bankTransferPaymentInformation:
            bankCode: '0310'
            bankName: ｼﾞ-ｴﾑｵ-ｱｵｿﾞﾗﾈﾂﾄ
            branchCode: '503'
            branchName: ｶｿｳｼﾃﾝ
            accountType: '1'
            accountNumber: '1234567'
            accountHolderName: ﾃｽﾄｼｮｯﾌﾟ
            depositAmount: '0'
    cashChargeResponseExample5:
      value:
        nextAction: AWAIT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: REQSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          chargeType: CASH
        cashResult:
          cashType: MYPAYMENT
          paymentExpiryDateTime: '2023-05-30T23:59:59+09:00'
          mypaymentInformation:
            barcodeUrl: https://example.com/usr/paymng?A11BC1234F78F4A1CFCDF49FC00B3D6A
            inquiryNo: '88041623856'
            konbiniCode: MINISTOP
            konbiniName: ミニストップ
            storeCode: '00000000'
            mypaymentReceiptDate: '2023-05-30T23:59:59+09:00'
            mypaymentReturnDate: '2023-05-30T23:59:59+09:00'
    deferredpayShippingResponseExample1:
      value:
        nextAction: AWAIT
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: SHIPPED
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: DEFERRED
        deferredpayResult:
          deferredpayType: ATOKARA
          settlementCode: 12345abcde
    deferredpayShippingCancelResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTH
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: DEFERRED
        deferredpayResult:
          deferredpayType: ATOKARA
          settlementCode: 12345abcde
          captureExpiryDateTime: '2023-06-30T12:34:56+09:00'
    deferredpayShippingUpdateResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: SHIPPED
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: DEFERRED
        deferredpayResult:
          deferredpayType: ATOKARA
          settlementCode: 12345abcde
    deferredpayOrderUpdateResponseExample1:
      value:
        nextAction: CAPTURE
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTH
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: DEFERRED
        deferredpayResult:
          deferredpayType: ATOKARA
          settlementCode: 12345abcde
          captureExpiryDateTime: '2023-06-30T12:34:56+09:00'
    orderCaptureCreditResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: SALES
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          useTds2: true
          useFraudDetection: false
        tds2Result:
          eci: '05'
          requiresChallenge: false
          tds2TransResult: 'Y'
          tds2TransResultReason: '18'
    orderCaptureWalletResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: SALES
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: WALLET
        walletResult:
          walletType: PAYPAY
          settlementCode: '1234567890'
          acceptanceCode: '1234567890'
    orderUpdateCreditResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CAPTURE
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          captureExpiryDateTime: '2023-06-30T12:34:56+09:00'
          useTds2: false
          useFraudDetection: false
    orderUpdateCreditResponseExample2:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTH
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          useTds2: false
          useFraudDetection: false
    oderUpdateWalletResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CAPTURE
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: WALLET
        walletResult:
          walletType: PAYPAY
          settlementCode: '1234567890'
          acceptanceCode: '1234567890'
          captureExpiryDateTime: '2023-05-30T12:40:01+09:00'
    oderUpdateCashResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: REQSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: CASH
        cashResult:
          cashType: MYPAYMENT
          paymentExpiryDateTime: '2023-05-30T23:59:59+09:00'
          mypaymentInformation:
            barcodeUrl: https://example.com/usr/paymng?A11BC1234F78F4A1CFCDF49FC00B3D6A
            inquiryNo: '88041623856'
            konbiniCode: MINISTOP
            konbiniName: ミニストップ
            storeCode: '00000000'
            mypaymentReceiptDate: '2023-05-30T23:59:59+09:00'
            mypaymentReturnDate: '2023-05-30T23:59:59+09:00'
    orderCancelCreditResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CANCEL
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '0'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          useTds2: false
          useFraudDetection: false
    orderCancelWalletResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CANCEL
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '0'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: WALLET
        walletResult:
          walletType: PAYPAY
          settlementCode: '1234567890'
          acceptanceCode: '1234567890'
          captureExpiryDateTime: '2023-05-30T12:40:01+09:00'
    orderCancelCashResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CANCEL
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '0'
          chargeType: CASH
        cashResult:
          cashType: PAYEASY
          paymentExpiryDateTime: '2023-05-30T12:34:56+09:00'
          pay-easyPaymentInformation:
            customerNumber: WNT12345678
            institutionCode: '58021'
            confirmationNumber: '1234567890'
            bankUrl: https://example.com/bank
    orderInquiryCreditResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: AUTHENTICATED
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '0'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: CREDIT
        creditResult:
          cardType: CREDIT_CARD
          cardResult:
            cardNumber: '************1111'
            cardholderName: TARO MIHON
            expiryMonth: '06'
            expiryYear: '2033'
            issuerCode: 2a99663
          forwardedAcquirerCode: 2a99663
          approvalCode: '1234567'
          nwTransactionId: '2305301234602212345678912345'
          transactionDateTime: '2023-05-30T12:34:56+09:00'
          captureExpiryDateTime: '2023-06-30T12:34:56+09:00'
          useTds2: true
          useFraudDetection: true
        tds2Result:
          eci: '05'
          requiresChallenge: false
          tds2TransResult: 'Y'
          tds2TransResultReason: '18'
        fraudDetectionResult:
          screeningType: RED_SHIELD
          screeningTransactionId: A0B26524E32C053A034F70B608054F6A
          screeningResultCode: ACCEPT
          screeningResultRawData: 000.300.100
    orderInquiryWalletResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: CAPTURE
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:35:01+09:00'
          amount: '1000'
          clientFields:
            clientField1: 加盟店自由項目1
            clientField2: 加盟店自由項目2
            clientField3: 加盟店自由項目3
          chargeType: WALLET
        walletResult:
          walletType: PAYPAY
          settlementCode: '1234567890'
    orderInquiryCashResponseExample1:
      value:
        orderReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          accessPass: 8edc86b5c8b34e92a224f577dec63990
          orderId: order-001
          status: PAYSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-06-01T12:34:56+09:00'
          amount: '1000'
          chargeType: CASH
        cashResult:
          cashType: PAYEASY
          paymentExpiryDateTime: '2023-05-30T12:34:56+09:00'
          pay-easyPaymentInformation:
            customerNumber: WNT12345678
            institutionCode: '58021'
            confirmationNumber: '1234567890'
            bankUrl: https://example.com/bank
    walletGetCustomerDataResponseExample1:
      value:
        buyerId: amzn1.account.XXXX
        name: 見本 太郎
        email: taro.mihon@example.com
        remarks: JCB ****1111 (Amazon Pay)
        shippingInformation:
          name: 見本 太郎
          line1: 渋谷区道玄坂
          line2: 1丁目2-3
          line3: 見本マンション101
          state: 東京都
          country: JP
          postCode: 150-0043
          phone: 090-1234-5678
        billingInformation:
          name: 見本 太郎
          line1: 渋谷区道玄坂
          line2: 1丁目2-3
          line3: 見本マンション101
          state: 東京都
          country: JP
          postCode: 150-0043
          phone: 090-1234-5678
    verificationStartResponseExample1:
      value:
        nextAction: REDIRECT
        verificationReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          verificationId: verification-001
          status: REQSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          type: sms-pin
        redirectInformation:
          redirectUrl: https://example.com/verification/d6b3ff5huf9f6270fghn673ca15944ff257041c473013ety7d9f435c5n9h754/phone-number
          httpMethod: GET
          redirectType: VERIFY
    verificationInquiryResponseExample1:
      value:
        verificationReference:
          accessId: acdc7d53f7a78f488d8d0997eff99c6f
          verificationId: verification-001
          status: REQSUCCESS
          created: '2023-05-30T12:34:56+09:00'
          updated: '2023-05-30T12:34:56+09:00'
          type: sms-pin
x-tagGroups:
  - name: はじめに(OpenAPIタイプ)
    tags:
      - intro
  - name: 認証API
    tags:
      - access-token
  - name: 支払いAPI
    tags:
      - creditcard
      - wallet
      - cash
      - deferredpay
      - order
      - member
      - events
  - name: 本人確認API
    tags:
      - verify
  - name: トークン決済v2
    tags:
      - card-token-v2
      - encrypteddata
      - token-api-errors
  - name: APPENDIX
    tags:
      - common-parameters
      - correspondence
      - changelog
