---
title: Checkout Session
url: ja/amazon-pay-paymentmethodonfile/ja-checkout-session.html
---

Checkout Sessionは、Webサイトの購入者に対する単一のアクティブなセッション（またはエンゲージメント）を表します。Checkout Sessionは、一つの請求、複数の請求、またはオーソリ失敗からのリカバリーを容易にするために使用できます。

Checkout Sessionは、Open状態で開始されます。Open状態ではCheckout Sessionを使用して、配送先住所などの決済の詳細を取得し、注文金額などの関連する支払いの詳細を設定できます。Checkout Sessionを使用して、購入者にすぐに請求するか、後で購入者に請求できるCharge Permissionを生成することができます。

トランザクション処理が成功して、<a href="../amazon-pay-api-v2/checkout-session.md#complete-checkout-session" target="_blank" rel="noopener noreferrer">Complete Checkout Session</a> を実行した後、 Checkout SessionはCompleted状態に移行します。Completed状態でAuthorizationが要求された場合は、Checkout SessionをCharge PermissionとChargeを参照するための情報を取得するために使用できます。

Checkout Sessionが24時間Open状態になった後、またはトランザクション処理が失敗した場合、Checkout SessionはCanceled状態に移行します。Canceled状態では、Checkout Sessionを使用して、チェック決済が失敗した理由を取得できます。

Amazon Payは、30日後にCheckout Sessionオブジェクトと関連情報を削除することに注意してください。

<!-- <div style="display:none" class="environmentSpecificKeys">
  <div markdown="span" class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> publicKeyIdの先頭に環境名が<b>付与されていない</b>場合 (SANDBOX'や'LIVE'で始まっていない場合)、<a href='#' onclick='window.location.href=window.location.href.split("?")[0]+"?environmentSpecificKeys=false"' rel='noopener noreferrer'>こちらの手順</a>を確認してください。</div>
</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
  <div markdown="span" class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> publicKeyIdの先頭に環境名が付与されている場合 (例: SANDBOX-AFVX7ULWSGBZ5535PCUQOY7B)、<a href='#' onclick='window.location.href=window.location.href.split("?")[0]+"?environmentSpecificKeys=true"' rel='noopener noreferrer'>こちらの手順</a>を確認してください。</div>
</div> -->

サポートされている操作：


<div style="display:none" class="environmentSpecificKeys">
<ul id="profileTabs" class="nav nav-tabs">
  <li class="nav-item"><a class="nav-link noExtIcon" href="#ustab" data-toggle="tab">US</a></li>
  <li class="nav-item"><a class="nav-link noExtIcon" href="#eutab" data-toggle="tab">EU / UK</a></li>
  <li class="nav-item"><a class="active nav-link noExtIcon" href="#jptab" data-toggle="tab">JP</a></li>
</ul>
<div class="tab-content">
  <div role="tabpanel" class="tab-pane" id="ustab" markdown="block">   
<div markdown="block">
* **Create Checkout Session** - POST https://pay-api.amazon.com/:version/checkoutSessions
* **Get Checkout Session** - GET https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId
* **Update Checkout Session** - PATCH https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId
* **Complete Checkout Session** - POST https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId/complete
</div>
  </div>
  <div role="tabpanel" class="tab-pane" id="eutab" markdown="block">
<div markdown="block">
* **Create Checkout Session** - POST https://pay-api.amazon.eu/:version/checkoutSessions
* **Get Checkout Session** - GET https://pay-api.amazon.eu/:version/checkoutSessions/:checkoutSessionId
* **Update Checkout Session** - PATCH https://pay-api.amazon.eu/:version/checkoutSessions/:checkoutSessionId
* **Complete Checkout Session** - POST https://pay-api.amazon.eu/:version/checkoutSessions/:checkoutSessionId/complete
</div>
  </div>
  <div role="tabpanel" class="tab-pane active" id="jptab" markdown="block">
<div markdown="block">
* **Create Checkout Session** - POST https://pay-api.amazon.jp/:version/checkoutSessions
* **Get Checkout Session** - GET https://pay-api.amazon.jp/:version/checkoutSessions/:checkoutSessionId
* **Update Checkout Session** - PATCH https://pay-api.amazon.jp/:version/checkoutSessions/:checkoutSessionId
* **Complete Checkout Session** - POST https://pay-api.amazon.jp/:version/checkoutSessions/:checkoutSessionId/complete
</div>
  </div>
</div>
</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<ul id="profileTabs" class="nav nav-tabs">
  <li class="nav-item"><a class="nav-link noExtIcon" href="#ustabNESK" data-toggle="tab">US</a></li>
  <li class="nav-item"><a class="nav-link noExtIcon" href="#eutabNESK" data-toggle="tab">EU / UK</a></li>
  <li class="nav-item"><a class="active nav-link noExtIcon" href="#jptabNESK" data-toggle="tab">JP</a></li>
</ul>
<div class="tab-content">
  <div role="tabpanel" class="tab-pane" id="ustabNESK" markdown="block">   
<div markdown="block">
* **Create Checkout Session** - POST https://pay-api.amazon.com/:environment/:version/checkoutSessions
* **Get Checkout Session** - GET https://pay-api.amazon.com/:environment/:version/checkoutSessions/:checkoutSessionId
* **Update Checkout Session** - PATCH https://pay-api.amazon.com/:environment/:version/checkoutSessions/:checkoutSessionId
* **Complete Checkout Session** - POST https://pay-api.amazon.com/:environment/:version/checkoutSessions/:checkoutSessionId/complete
</div>
  </div>
  <div role="tabpanel" class="tab-pane" id="eutabNESK" markdown="block">
<div markdown="block">
* **Create Checkout Session** - POST https://pay-api.amazon.eu/:environment/:version/checkoutSessions
* **Get Checkout Session** - GET https://pay-api.amazon.eu/:environment/:version/checkoutSessions/:checkoutSessionId
* **Update Checkout Session** - PATCH https://pay-api.amazon.eu/:environment/:version/checkoutSessions/:checkoutSessionId
* **Complete Checkout Session** - POST https://pay-api.amazon.eu/:environment/:version/checkoutSessions/:checkoutSessionId/complete
</div>
  </div>
  <div role="tabpanel" class="tab-pane active" id="jptabNESK" markdown="block">
<div markdown="block">
* **Create Checkout Session** - POST https://pay-api.amazon.jp/:environment/:version/checkoutSessions
* **Get Checkout Session** - GET https://pay-api.amazon.jp/:environment/:version/checkoutSessions/:checkoutSessionId
* **Update Checkout Session** - PATCH https://pay-api.amazon.jp/:environment/:version/checkoutSessions/:checkoutSessionId
* **Complete Checkout Session** - POST https://pay-api.amazon.jp/:environment/:version/checkoutSessions/:checkoutSessionId/complete
</div>
  </div>
</div>
</div>



***

* TOC
{:toc}
{::options toc_levels="3" /}

### Checkout Session オブジェクト

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAAMa0J'>
            <td id='s:ERL9CAAMa0J;ERL9CA4JgH8' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='s:ERL9CAAMa0J;ERL9CA2UFx4' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CAPW7YB'>
            <td id='s:ERL9CAPW7YB;ERL9CA4JgH8' style='vertical-align: top;'>checkoutSessionId<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAPW7YB;ERL9CA2UFx4' style='vertical-align: top;'>Checkout Session識別子
<br><br>
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>chargePermissionType<br /><br />Type: string
                <br /></td>
            <td id='' style='vertical-align: top;'>要求されたCharge Permissionのタイプ<br><br>サポートされている値：
                    <ul>
                      <li>'OneTime' - Charge PermissionはOneTimeの注文にのみ使用できます</li>
                      <li>'Recurring' - Charge PermissionはRecurringの注文に使用できます</li>
                      <li>'PaymentMethodOnFile' - Charge PermissionはPaymentMethodOnFile注文に使用できます</li>
                    </ul>
            デフォルト値: 'OneTime"
                <br /></td>
        </tr>
        <tr id=''>
             <td id='' style='vertical-align: top;'>recurringMetadata<br /><br />Type: <a href="#type-recurringmetadata">recurringMetadata</a>
                <br /></td>
            <td id='' style='vertical-align: top;'>RecurringのCharge Permissionの使用方法に関するメタデータ。 Amazon Payは、この情報を使用して、Charge Permissionの有効期限を計算し、購入者と連絡を取ります。
<br /><br />
            事業者の請求タイミングで購入者に請求するために<a href="charge.html#create-charge" target="_blank" rel="noopener noreferrer">Create Charge</a>を実行することは事業者責任であることに注意してください。
                <br /></td>
        </tr>
        <tr id='ERL9CAMHIJQ'>
            <td id='s:ERL9CAMHIJQ;ERL9CA4JgH8' style='vertical-align: top;'>webCheckoutDetails<br><br>Type: <a href="#type-webcheckoutdetails">webCheckoutDetails</a>
                <br /></td>
            <td id='s:ERL9CAMHIJQ;ERL9CA2UFx4' style='vertical-align: top;'>Checkout Sessionに関連付けられたURL情報で、決済を完了するために使用します
                <br /></td>
        </tr>
        <tr id='ERL9CA5u29J'>
            <td id='s:ERL9CA5u29J;ERL9CA4JgH8' style='vertical-align: top;'>productType<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CA5u29J;ERL9CA2UFx4' style='vertical-align: top;'>Amazon Payインテグレーションタイプ。Checkout Session操作を介してこの値を設定することはできず、ボタンに<code>productType</code> パラメータを使用して設定する必要があります。
                <br /></td>
        </tr>
        <tr id='ERL9CAW1ynS'>
            <td id='s:ERL9CAW1ynS;ERL9CA4JgH8' style='vertical-align: top;'>paymentDetails<br><br>Type: <a href="#type-paymentdetails">paymentDetails</a>
                <br /></td>
            <td id='s:ERL9CAW1ynS;ERL9CA2UFx4' style='vertical-align: top;'>購入者に請求する金額や方法など、事業者が指定した支払いの詳細情報
                <br /></td>
        </tr>
        <tr id='ERL9CAghftb'>
            <td id='s:ERL9CAghftb;ERL9CA4JgH8' style='vertical-align: top;'>merchantMetadata<br><br>Type: <a href="#type-merchantmetadata">merchantMetadata</a>
                <br /></td>
            <td id='s:ERL9CAghftb;ERL9CA2UFx4' style='vertical-align: top;'>事業者が提供する注文の詳細情報
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>paymentMethodOnFileMetadata<br /><br />Type: <a href="checkout-session.html#type-paymentmethodonfilemetadata">paymentMethodOnFileMetadata</a>
                <br /></td>
            <td id='' style='vertical-align: top;'>ChargePermissionをPaymentMethodOnFileの中でどのように利用するかを示す詳細情報。Amazon PayはPaymentMethodOnFileとして必要な情報を判別する為にこの情報を利用します。
                <br /></td>
        </tr>
        <tr id='ERL9CAzuBJe'>
            <td id='s:ERL9CAzuBJe;ERL9CA4JgH8' style='vertical-align: top;'>platformId<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAzuBJe;ERL9CA2UFx4' style='vertical-align: top;'>ソリューションプロバイダー（SP）の事業者ID<br><br>SPのみがこのフィールドを使用する必要があります
                <br /></td>
        </tr>
        <tr id='ERL9CAdYXcn'>
            <td id='s:ERL9CAdYXcn;ERL9CA4JgH8' style='vertical-align: top;'>providerMetadata<br><br>Type: <a href="#type-providermetadata">providerMetadata</a>
                <br /></td>
            <td id='s:ERL9CAdYXcn;ERL9CA2UFx4' style='vertical-align: top;'>決済サービスプロバイダー（PSP）が提供する注文情報<br><br>PSPのみがこれらのフィールドを使用する必要があります
                <br /></td>
        </tr>
        <tr id='ERL9CA3mi12'>
            <td id='s:ERL9CA3mi12;ERL9CA4JgH8' style='vertical-align: top;'>buyer<br><br>Type: <a href="#type-buyer">buyer</a>
                <br /></td>
            <td id='s:ERL9CA3mi12;ERL9CA2UFx4' style='vertical-align: top;'>購入者一意のID、名前、メールアドレスなど、購入者に関する詳細情報<br><br>この情報は、Opens状態のCheckout Sessionでのみ返されます
                <br /></td>
        </tr>
        <tr id='ERL9CA8sy3y'>
            <td id='s:ERL9CA8sy3y;ERL9CA4JgH8' style='vertical-align: top;'>shippingAddress<br><br>Type: <a href="#type-address">address</a>
                <br /></td>
            <td id='s:ERL9CA8sy3y;ERL9CA2UFx4' style='vertical-align: top;'>購入者が選択した配送先住所
                <br /></td>
        </tr>
        <tr id='ERL9CAbDPgI'>
            <td id='s:ERL9CAbDPgI;ERL9CAhTOM1' style='vertical-align: top;'>billingAddress<br><br>Type: <a href="#type-address">address</a>
                <br /></td>
            <td id='s:ERL9CAbDPgI;ERL9CAF5NFx' style='vertical-align: top;'>購入者が選択したお支払い方法の請求先住所。 
                <br /></td>
        </tr>
        <tr id='ERL9CA6b5JL'>
            <td id='s:ERL9CA6b5JL;ERL9CA4JgH8' style='vertical-align: top;'>paymentPreferences<br><br>Type: list&lt;<a href="#type-paymentpreferences">paymentPreferences</a>&gt;
                <br /></td>
            <td id='s:ERL9CA6b5JL;ERL9CA2UFx4' style='vertical-align: top;'>購入者が選択した支払い方法のリスト
                <br /></td>
        </tr>
        <tr id='ERL9CAQ5o5K'>
            <td id='s:ERL9CAQ5o5K;ERL9CA4JgH8' style='vertical-align: top;'>statusDetails<br><br>Type: <a href="#type-statusdetails">statusDetails</a>
                <br /></td>
            <td id='s:ERL9CAQ5o5K;ERL9CA2UFx4' style='vertical-align: top;'>CheckoutSessionオブジェクトの状態
                <br /></td>
        </tr>
        <tr id='ERL9CAnr8vi'>
            <td id='s:ERL9CAnr8vi;ERL9CA4JgH8' style='vertical-align: top;'>constraints<br><br>Type: list&lt;<a href="#type-constraint">constraint</a>&gt;
                <br /></td>
                <td id='s:ERL9CAnr8vi;ERL9CA2UFx4' style='vertical-align: top;'>Amazon Payの決済を完了するために対処する必要のある制約
                <br /></td>
        </tr>
        <tr id='ERL9CAFxu2I'>
            <td id='s:ERL9CAFxu2I;ERL9CA4JgH8' style='vertical-align: top;'>creationTimestamp<br><br>Type: dateTime
                <br /></td>
            <td id='s:ERL9CAFxu2I;ERL9CA2UFx4' style='vertical-align: top;'>Checkout Sessionが作成されたISO8601形式での協定世界時（UTC）日時
                <br /></td>
        </tr>
        <tr id='ERL9CAkNc6l'>
            <td id='s:ERL9CAkNc6l;ERL9CA4JgH8' style='vertical-align: top;'>expirationTimestamp<br><br>Type: dateTime
                <br /></td>
            <td id='s:ERL9CAkNc6l;ERL9CA2UFx4' style='vertical-align: top;'>Checkout Sessionが期限切れになるISO8601形式でのUTC日時
                <br /></td>
        </tr>
        <tr id='ERL9CAceihI'>
            <td id='s:ERL9CAceihI;ERL9CA4JgH8' style='vertical-align: top;'>chargePermissionId<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAceihI;ERL9CA2UFx4' style='vertical-align: top;'>Checkout Sessionが完了した後に返すChargePermissionID<br><br>  <a href="../amazon-pay-checkout/deferred-transactions.md">延期されたトランザクション</a>の請求を作成するために使用されます
                <br /></td>
        </tr>
        <tr id='ERL9CAAdmWH'>
            <td id='s:ERL9CAAdmWH;ERL9CA4JgH8' style='vertical-align: top;'>chargeId<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAAdmWH;ERL9CA2UFx4' style='vertical-align: top;'>Checkout Sessionの完了後に返されるCharge識別子<br><br>返金の処理に使用されます
                <br /></td>
        </tr>
        <tr id='ERL9CAS8DRa'>
            <td id='s:ERL9CAS8DRa;ERL9CA4JgH8' style='vertical-align: top;'>storeId<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAS8DRa;ERL9CA2UFx4' style='vertical-align: top;'>Amazon PayのStore IDです。 Amazon Pay インテグレーションセントラル<a href="https://sellercentral.amazon.com/gp/pyop/seller/integrationcentral/" target="_blank" rel="noopener noreferrer">US</a>, <a href="https://sellercentral-europe.amazon.com/gp/pyop/seller/integrationcentral/" target="_blank" rel="noopener noreferrer">EU</a>, <a href="https://sellercentral-japan.amazon.com/gp/pyop/seller/integrationcentral/" target="_blank" rel="noopener noreferrer">JP</a>からこの値を取得します。
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>deliverySpecifications<br /><br />Type: <a href="#type-deliveryspecifications">deliverySpecifications</a>
                <br /></td>
            <td id='' style='vertical-align: top;'>配送先制限機能で指定して、購入者がAmazonのアドレスリストからサポートされていないアドレスを選択できないようにします 
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>releaseEnvironment<br /><br />Type: string
                <br /></td>
            <td id='' style='vertical-align: top;'>CheckoutSessionオブジェクトが作成された環境（SANDBOXまたは本番）
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>supplementaryData<br /><br />Type: string
                <br /></td>
            <td id='' style='vertical-align: top;'>データエンリッチメントフィールド。ご利用できません。
                <br /></td>
        </tr>
    </tbody>
</table>

#### Type: webCheckoutDetails

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAz5j6a'>
            <td id='s:ERL9CAz5j6a;ERL9CAAufZX' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='s:ERL9CAz5j6a;ERL9CAneSOW' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CA6eLjw'>
            <td id='s:ERL9CA6eLjw;ERL9CAAufZX' style='vertical-align: top;'>checkoutReviewReturnUrl<br><br>Type: string
                <br /></td>
            <td id="s:ERL9CA6eLjw;ERL9CAneSOW" style="vertical-align: top;">事業者から提供された決済レビューURL。購入者が希望のお支払い方法と配送先住所を選択すると、 購入者はこのURLにリダイレクトします<br><br>Note：<br>本番環境では、URLはHTTPSプロトコルを使用する必要があります。 URLドメインをセラーセントラルに追加する必要があります。詳細については<a href="../amazon-pay-checkout/get-set-up-for-integration.md#2-add-domains-to-seller-central" target="_blank" rel="noopener noreferrer">、セラーセントラル</a>への<a href="../amazon-pay-checkout/get-set-up-for-integration.md#2-add-domains-to-seller-central" target="_blank" rel="noopener noreferrer">ドメインの追加を</a>参照してください。 <br>SANDBOX環境では SSL証明書は必要なく、ローカルホスト（http：// localhost）でテストしている場合はHTTPプロトコルを使用できます。 セラーセントラルのJavaScriptオリジンにURLを追加する必要はありません<br><br>最大長：1024文字/バイト<br></td>
        </tr>
        <tr id='ERL9CAxQRXB'>
            <td id='s:ERL9CAxQRXB;ERL9CAAufZX' style='vertical-align: top;'>checkoutResultReturnUrl<br><br>Type: string<br>
                <br /></td>
            <td id="s:ERL9CAxQRXB;ERL9CAneSOW" style="vertical-align: top;">事業者から提供された決済結果のURL。トランザクションの完了後、Amazon PayはこのURLにリダイレクトします<br><br>Note：本番環境では、URLはHTTPSプロトコルを使用する必要があります。SANDBOX環境では SSL証明書は必要なく、ローカルホスト（http：// localhost）でテストしている場合はHTTPプロトコルを使用できます。<br><br>最大長：1024文字/バイト<br></td>
        </tr>
        <tr>
            <td style="vertical-align: top;">checkoutCancelUrl<br><br>Type: string<br>
                <br></td>
            <td style="vertical-align: top;">決済をキャンセルした際に戻す事業者が指定するURLです。 購入者がAmazon Hosted Page上で決済をキャンセルした場合、Amazon PayはこのURLにリダイレクトします。
            <br><br>もし<code>checkoutCancelUrl</code>が設定されていない場合は、Amazon Payは以下のロジックでリダイレクトします。
            <ul>
                <li>Amazon Payボタンからの支払い方法およびお届け先住所選択ページ - リファラーURLにリダイレクトします。ただしリファラーのドメインが<code>checkoutReviewReturnUrl</code>と異なる場合は<code>checkoutReviewReturnUrl</code>にリダイレクトします。 </li>
                <li><code>checkoutResultReturnUrl</code>からの支払い方法およびお届け先住所選択ページ - <code>checkoutReviewReturnUrl</code>へリダイレクトします。</li>
                <li> オーソリ失敗ページ - <code>checkoutResultReturnUrl</code>へリダイレクトします。</li>
            </ul>
            最大長：1024文字/バイト</td>
            <br></td>
        </tr>       
        <tr id='ERL9CAixONe'>
            <td id='s:ERL9CAixONe;ERL9CAAufZX' style='vertical-align: top;'>amazonPayRedirectUrl<br><br>Type: string
                <br /></td>
            <td id="s:ERL9CAixONe;ERL9CAneSOW" style="vertical-align: top;">Amazon Payが提供するURL。決済を完了するためにトランザクションの詳細を設定した後、事業者はこのページにリダイレクトします。<br><br>最大長：256文字/バイト<br></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>checkoutMode<br><br>Type: string
                <br /></td>
            <td style="vertical-align: top;">決済を完了する前に、購入者がWebサイトに戻って注文を確認するかどうかを指定します<br><br>サポートされている値：<ul><li> 'ProcessOrder' - 購入者は、Amazon Payボタンをクリックした直後に、Amazon Payがホストするページで決済を完了します。 'PayAndShip'に設定して'ProcessOrder'を使用する場合は、 <code>paymentDetails</code>が必要です。 <code>productType</code>に'PayAndShip'を使用する場合も<code>addressDetails</code>が必要です</li></ul></td>
        </tr>
    </tbody>
</table>

#### Type: deliverySpecifications

<table width="100%" border="1">
    <tbody>
         <tr id='ERL9CAz5j6a'>
            <td id='s:ERL9CAz5j6a;ERL9CAAufZX' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='s:ERL9CAz5j6a;ERL9CAneSOW' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CA09KrK'>
            <td id='s:ERL9CA09KrK;ERL9CAGYV2f' style='vertical-align: top;'>specialRestrictions<br><br>Type:  list&lt;string&gt;
                <br /></td>
           <td id="s:ERL9CA09KrK;ERL9CAoKRxx" style="vertical-align: top;">ルールによる制限<br><br>Note：AmazonはSANDBOXの値のみをを検証します。サポートされていない値が使用されている場合、このパラメータは本番環境では無視されます。<br><br>サポートされている値：<ul> <li>'RestrictPOBoxes' - US、CA、GB、FR、DE、ES、PT、IT、AUの私書箱アドレスを制限付きとしてマークします</li><li>'RestrictPackstations'- DEのパックステーションアドレスを制限付きとしてマークします</li></ul></td>
        </tr>
        <tr id='ERL9CAXT6Om'>
            <td id='s:ERL9CAXT6Om;ERL9CAGYV2f' style='vertical-align: top;'>addressRestrictions<br><br>Type: <a href="#type-addressrestrictions">addressRestrictions</a><br>
                <br /></td>
            <td id='s:ERL9CAXT6Om;ERL9CAoKRxx' style='vertical-align: top;'>住所による制限
            <br><br>
                <br /></td>
        </tr>
    </tbody>
</table>

#### Type: addressRestrictions

<table width="100%" border="1">
     <tbody>
         <tr id='ERL9CAz5j6a'>
            <td id='s:ERL9CAz5j6a;ERL9CAAufZX' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='s:ERL9CAz5j6a;ERL9CAneSOW' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CAJOAHz'>
            <td id='s:ERL9CAJOAHz;ERL9CAcxSMm' style='vertical-align: top;'>type<br><br>Type: string
                <br /></td>
            <td id="s:ERL9CAJOAHz;ERL9CAYTz80" style="vertical-align: top;">制限設定に一致するアドレスを配送先制限するかどうかを指定します<br><br>Note：AmazonはSANDBOXの値を検証します。サポートされていない値が使用されている場合、このパラメータは本番環境では無視されます。<br><br>サポートされている値：<ul><li> 'Allowed' - 制限構成に一致しないアドレスを制限としてマークします</li> <li>'NotAllowed' - 制限構成に一致するアドレスを制限としてマークします</li></ul><br></td>
        </tr>
        <tr id='ERL9CAx7mom'>
            <td id='s:ERL9CAx7mom;ERL9CAcxSMm' style='vertical-align: top;'>restrictions<br><br>Type: hash&lt;countryCode:<a href="#type-restriction">restriction</a>&gt;<br>
                <br /></td>
            <td id="s:ERL9CAx7mom;ERL9CAYTz80" style="vertical-align: top;"> <code>addressRestrictions.type</code>に基づいて制限する必要があるアドレスと制限しないアドレスを決定する国レベルの制限のハッシュパラメータ。<br><br> CountryCodeは、アドレスの国コードをISO3166形式で表す文字列です。 AmazonはSANDBOXのCountryCodeのみを検証します。サポートされていない値が使用されている場合、 本番環境ではCountryCodeは無視されます。<br><br><br></td>
        </tr>
    </tbody>
</table>

#### Type: recurringMetadata

<table width="100%" border="1">
    <tbody>
         <tr id=''>
            <td id='' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>frequency<br><br>Type: <a href="#type-frequency">frequency</a>
                <br /></td>
            <td style="vertical-align: top;">RecurringのCharge Permissionを使用して購入者に請求される頻度。アドホックな料金が予想される場合でも、frequencyは指定する必要があります。<br><br>可能な組み合わせ：<ul><li>Year：1-3</li><li>Month：1-36</li><li>Week：1-57</li><li>Day：1-1095</li></ul></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>amount<br><br>Type: <a href="#type-price">price</a>
                <br /></td>
            <td id='' style='vertical-align: top;'>Recurringのサイクルごとに購入者される金額。金額が変動する場合はnullに設定します。
                <br /></td>
        </tr>
    </tbody>
</table>

#### Type: frequency

<table width="100%" border="1">
    <tbody>
         <tr id=''>
            <td id='' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>unit<br><br>Type: string
                <br /></td>
            <td style="vertical-align: top;">各請求サイクルの頻度の単位。複数のサブスクリプションの場合、最短の請求サイクルのfrequency unitを指定します。詳細については、 <a href="../amazon-pay-checkout/advanced-subscription-use-cases.md#handling-variable-cadence" target="_blank" rel="noopener noreferrer">支払い頻度が不定期の場合の処理</a>を参照してください。<br><br>サポートされている値： 'Year', 'Month', 'Week', 'Day', 'Variable'</td>
            <!-- 不規則なケイデンスで購入者に請求する場合にのみVariableを使用します。 -->
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>value<br><br>Type: string
                <br /></td>
            <td style="vertical-align: top;">請求サイクルごとのfrequency単位の数。たとえば、週単位を指定するには、<code>unit</code>を'Week'に設定し、<code>value</code>を1に設定します。Variable<code>unit</code>を使用している場合は、 <code>value</code>を0に設定する必要があります。</td>
        </tr>
    </tbody>
</table>

#### Type: restriction

<table width="100%" border="1">
    <tbody>
         <tr id='ERL9CAz5j6a'>
            <td id='s:ERL9CAz5j6a;ERL9CAAufZX' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='s:ERL9CAz5j6a;ERL9CAneSOW' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CADAGCN'>
            <td id='s:ERL9CADAGCN;ERL9CACXrxz' style='vertical-align: top;'>statesOrRegions<br><br>Type: list&lt;string&gt;
                <br /></td>
            <td id="s:ERL9CADAGCN;ERL9CA5jwy4" style="vertical-align: top;"><code>addressRestrictions.type</code>に基づいて制限する必要がある、または制限しないstatesOrRegionsのリストの<code>addressRestrictions.type</code>パラメータ<br><br>Note：<ul><li>決済USの住所 - 2文字のstateコードを使用します（例：WA、CA、IL）</li><li>他のすべての国 - この要素はフリーテキストです。該当するすべてのバリエーションを含まれます：2文字のコード、全文字列、略語</li></ul></td>
        </tr>
        <tr id='ERL9CAlyFPG'>
            <td id='s:ERL9CAlyFPG;ERL9CACXrxz' style='vertical-align: top;'>zipCodes<br><br>Type: list&lt;string&gt;<br>
                <br /></td>
            <td id="s:ERL9CAlyFPG;ERL9CA5jwy4" style="vertical-align: top;"> <code>addressRestrictions.type</code>基づいて制限する必要があるまたは制限しない国固有の郵便番号のパラメータ<br><br>
            郵便番号の設定にワイルドカード記号を用いることができます。"*"記号は任意の長さの任意の文字列、"?"記号は任意の一文字として扱います。
            <br></td>
        </tr>
    </tbody>
</table>

#### Type: paymentDetails

<table width="100%" border="1">
    <tbody>
        <tr id="ERL9CAXIylR">
            <td id="s:ERL9CAXIylR;ERL9CAW9hIG" style="vertical-align: top; font-weight: bold; width: 30%;" class="bold">
                パラメータ
                <br></td>
            <td id="s:ERL9CAXIylR;ERL9CAxLjJC" style="vertical-align: top; font-weight: bold; width: 70%;" class="bold">
                説明
                <br></td>
        </tr>
        <tr id="ERL9CA8cLyf">
            <td id="s:ERL9CA8cLyf;ERL9CAW9hIG" style="vertical-align: top;">paymentIntent<br><br>Type: string
                <br></td>
            <td id="s:ERL9CA8cLyf;ERL9CAxLjJC" style="vertical-align: top;">購入者に請求するための支払いフロー<br><br>サポートされている値：<ul>
                    <li>'Confirm' - 後でオーソリを確保するおよび売上請求するためのCharge Permissionを作成します</li>
                    <li>'Authorize' - すぐにオーソリし、後で売上請求します</li>
                    <li>'AuthorizeWithCapture' - すぐにオーソリおよび売上請求します。この<code>paymentIntent</code>を使用する場合、
                        <code>canHandlePendingAuthorization</code>をtrueに設定することはできません。 </li>
                </ul>
            </td>
        </tr>
        <tr id="ERL9CAlQj26">
            <td id="s:ERL9CAlQj26;ERL9CAW9hIG" style="vertical-align: top;">canHandlePendingAuthorization<br><br>Type:
                boolean</td>
            <td id="s:ERL9CAlQj26;ERL9CAxLjJC" style="vertical-align: top;">
                事業者が保留のレスポンスを処理できるかどうかを示すブール値<br><br>trueに設定されている場合：<ul>
                    <li>OneTimeでの処理：Dynamic Authorizationが有効になっています。Chargeは"Authorized",
                        "Declined"、または"AuthorizationInitiated" いずれかの状態になります。Chargeは"AuthorizationInitiated"
                        状態にある場合、アマゾン側で非同期でオーソリを処理し、24時間以内にオーソリの結果を返します。詳細については、<a
                            href="../amazon-pay-checkout/asynchronous-processing.md">非同期処理</a>と<a
                            href="charge.html#states-and-reason-codes">Charge状態</a>を参照してください</li>
                    <li>Recurring決済：Amazon Payはオーソリを非同期で処理し、24時間以内にオーソリ結果を返します。詳細については、<a
                            href="../amazon-pay-checkout/asynchronous-processing.md">非同期処理</a>を参照してください。</li>
                </ul><br></td>
        </tr>
        <tr id="ERL9CAm6rqs">
            <td id="s:ERL9CAm6rqs;ERL9CAW9hIG" style="vertical-align: top;">chargeAmount<br><br>Type: <a
                    href="#type-price">price</a>
                <br></td>
            <td id="s:ERL9CAm6rqs;ERL9CAxLjJC" style="vertical-align: top;">
                決済時に<code>paymentIntent</code>を使用して処理される金額<br></td>
        </tr>
        <tr>
            <td style="vertical-align: top;">totalOrderAmount<br><br>Type: <a href="#type-price">price</a>
                <br></td>
            <td style="vertical-align: top;">合計注文金額。決済が完了した後に追加の支払いを売上請求するするために注文を分割する必要がある場合にのみ使用してください
                <br></td>
        </tr>
        <tr>
            <td style="vertical-align: top;">presentmentCurrency<br><br>Type: string
                <br></td>
            <td style="vertical-align: top;">購入者がISO4217形式で請求する通貨。例：USD<br><br>詳細については、<a
                    href="../amazon-pay-checkout/multi-currency-integration.md">複数通貨のインテグレーション</a>を参照してください<br></td>
        </tr>
        <tr id="OLS9CAGyE7P">
            <td id="s:OLS9CAGyE7P;OLS9CAx2YtW" style="vertical-align: top;">softDescriptor<br><br>Type: string
                <br></td>
            <td id="s:OLS9CAGyE7P;OLS9CAC9I1k" style="vertical-align: top;">
                <code>paymentIntent</code>がAuthorizeWithCaptureに設定されている場合、購入者のお支払い方法ステートメントに表示される説明。別の<code>paymentIntent</code>を使用する場合は、この値を設定しないでください。この項目には、購入者や取引に関する機密データを保存しないでください(例えば、政府発行の身分証明書、銀行口座番号、クレジットカード番号などが含まれますが、これらに限定されません)<br><br><strong>日本では利用できません。固定値が表示されます。</strong><br><br>デフォルト：「AMZ
                * pay.amazon.co.jp」<br>
                    最大長：16文字/バイト<br>
            </td>
        </tr>
        <tr>
            <td style="vertical-align: top;">allowOvercharge<br><br>Type: boolean</td>
            <td style="vertical-align: top;">JPマーケットプレイスに登録した場合にのみ適用されます。このパラメータは、他のすべてのリージョンでは常にnullとして返されます</td>
        </tr>
        <tr>
            <td style="vertical-align: top;">extendExpiration<br><br>Type: boolean</td>
            <td style="vertical-align: top;">JPマーケットプレイスに登録した場合にのみ適用されます。このパラメータは、他のすべてのリージョンでは常にnullとして返されます
                <br></td>
        </tr>
    </tbody>
</table>

#### Type: price

<table width="100%" border="1">
    <tbody>
        <tr id="cJS9CA6kGFJ">
            <td id="s:cJS9CA6kGFJ;cJS9CATjif7" style="vertical-align: top; font-weight: bold; width: 30%;" class="bold">
                パラメータ<br></td>
            <td id="s:cJS9CA6kGFJ;cJS9CAkvbPi" style="vertical-align: top; font-weight: bold; width: 70%;" class="bold">
                説明<br></td>
        </tr>
        <tr id="cJS9CAWeWKt">
            <td id="s:cJS9CAWeWKt;cJS9CATjif7" style="vertical-align: top;">amount<br><br>Type: string<br></td>
            <td id="s:cJS9CAWeWKt;cJS9CAkvbPi" style="vertical-align: top;">取引金額<br></td>
        </tr>
        <tr id="cJS9CAGgFsj">
            <td id="s:cJS9CAGgFsj;cJS9CATjif7" style="vertical-align: top;">currencyCode<br><br>Type: string<br></td>
            <td id="s:cJS9CAGgFsj;cJS9CAkvbPi" style="vertical-align: top;">ISO4217形式の取引通貨コード<br><br>例：JPY<br></td>
        </tr>
    </tbody>
</table>

#### Type: providerMetadata

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAkCDAX'>
            <td id='' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CA263fp'>
            <td id='s:ERL9CA263fp;ERL9CAOoCvF' style='vertical-align: top;'>providerReferenceId<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CA263fp;ERL9CAIPemX' style='vertical-align: top;'>決済サービスプロバイダー（PSP）に提供された注文ID<br><br>PSPのみがこれらのフィールドを使用する必要があります
                <br /></td>
        </tr>
    </tbody>
</table>

#### Type: merchantMetadata

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAF4Vxl'>
            <td id='s:ERL9CAF4Vxl;ERL9CAx7Nnu' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='s:ERL9CAF4Vxl;ERL9CAUSpyh' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CAH2j8f'>
            <td id='s:ERL9CAH2j8f;ERL9CAx7Nnu' style='vertical-align: top;'>merchantReferenceId<br><br>Type: string
                <br /></td>
            <td id="s:ERL9CAH2j8f;ERL9CAUSpyh" style="vertical-align: top;">事業者注文識別子。merchantReferenceIdは、Amazon Pay<a href="https://pay.amazon.com">ウェブサイト</a>の<a href="../amazon-pay-checkout/buyer-communication.md">購入者とのコミュニケーション</a>および購入者の取引履歴で共有されます。<br><br>最大長：256文字/バイト<br></td>
        </tr>
        <tr id='ERL9CANEvec'>
            <td id='s:ERL9CANEvec;ERL9CAx7Nnu' style='vertical-align: top;'>merchantStoreName<br><br>Type: string
                <br /></td>
            <td id="s:ERL9CANEvec;ERL9CAUSpyh" style="vertical-align: top;">事業者名。このパラメータを設定すると、セラーセントラル （<a href="https://sellercentral.amazon.com/" target="_blank" rel="noopener noreferrer">US</a> 、<a href="https://sellercentral-europe.amazon.com/" target="_blank" rel="noopener noreferrer">EU</a> 、 <a href="https://sellercentral-japan.amazon.com/" target="_blank" rel="noopener noreferrer">JP</a>）で構成されたデフォルト値が上書きされます。MerchantStoreNameは、 <a href="https://pay.amazon.com">Amazon Payウェブサイト</a>の<a href="../amazon-pay-checkout/buyer-communication.md">購入者とのコミュニケーション</a>および購入者の取引履歴で共有されます。<br><br>最大長：50文字/バイト<br></td>
        </tr>
        <tr id='ERL9CACmKGe'>
            <td id='s:ERL9CACmKGe;ERL9CAx7Nnu' style='vertical-align: top;'>noteToBuyer<br><br>Type: string
                <br /></td>
            <td id="s:ERL9CACmKGe;ERL9CAUSpyh" style="vertical-align: top;"><a href="../amazon-pay-checkout/buyer-communication.md">購入者とのコミュニケーションで</a>共有される注文の説明。<br><br>購入者や取引に関する機密データを保存しないでください(例えば、政府発行の身分証明書、銀行口座番号、クレジットカード番号などが含まれますが、これらに限定されません)<br><br>最大長：255文字/バイト<br></td>
        </tr>
        <tr id='ERL9CAznrdA'>
            <td id='s:ERL9CAznrdA;ERL9CAx7Nnu' style='vertical-align: top;'>customInformation<br><br>Type: string
                <br /></td>
            <td id="s:ERL9CAznrdA;ERL9CAUSpyh" style="vertical-align: top;">注文のカスタム情報。このデータは、<a href="../amazon-pay-checkout/buyer-communication.md">購入者とのコミュニケーション</a>では共有されません。<br><br>購入者や取引に関する機密データを保存しないでください(例えば、政府発行の身分証明書、銀行口座番号、クレジットカード番号などが含まれますが、これらに限定されません)<br><br>最大長：4096文字/バイト<br></td>
        </tr>
    </tbody>
</table>

#### Type: paymentMethodOnFileMetadata

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAkCDAX'>
            <td id='' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CA263fp'>
            <td id='s:ERL9CA263fp;ERL9CAOoCvF' style='vertical-align: top;'>setupOnly<br><br>Type: ブール値
                <br /></td>
            <td id='s:ERL9CA263fp;ERL9CAIPemX' style='vertical-align: top;'>事業者が、お支払方法設定をする為のフローを選択できます。<br>true - 購入者に対して、事前にお支払い方法としての設定のみを行う為の画面を表示します。<br>false - 購入者に対して、決済と合わせてお支払い方法の設定を行う為の画面を表示します。<br>
                <br /></td>
        </tr>
    </tbody>
</table>

#### Type: buyer

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAbSsO3'>
            <td id='s:ERL9CAbSsO3;ERL9CAoXRkL' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='s:ERL9CAbSsO3;ERL9CABfkuC' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CAEGLpK'>
            <td id='s:ERL9CAEGLpK;ERL9CAoXRkL' style='vertical-align: top;'>buyerId<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAEGLpK;ERL9CABfkuC' style='vertical-align: top;'>一意のAmazon Pay購入者ID
                <br><br>最大長：42文字/バイト
                <br /></td>
        </tr>
        <tr id='ERL9CAvifJc'>
            <td id='s:ERL9CAvifJc;ERL9CAoXRkL' style='vertical-align: top;'>name<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAvifJc;ERL9CABfkuC' style='vertical-align: top;'>購入者名<br><br>最大長：50文字/バイト
                <br /></td>
        </tr>
        <tr id='ERL9CA9FgNU'>
            <td id='s:ERL9CA9FgNU;ERL9CAoXRkL' style='vertical-align: top;'>email<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CA9FgNU;ERL9CABfkuC' style='vertical-align: top;'>購入者のメールアドレス<br><br>最大長：64文字/バイト
                <br /></td>
        </tr>
         <tr id="eVX9CA2CiDk">
            <td style="vertical-align: top;">phoneNumber<br><br>Type: string
                <br></td>
            <td style="vertical-align: top;">購入者のデフォルトの請求先住所の電話番号<br><br>最大長：20文字/バイト
                <br></td>
        </tr>
        <tr>
            <td style="vertical-align: top;">primeMembershipTypes<br><br>Type: list&lt;primeMembershipType&gt;
                <br></td>
            <td style="vertical-align: top;">購入者のプライム会員リスト。この値の一般利用はできません。
            </td>
        </tr>
    </tbody>
</table>

#### Type: paymentPreferences

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAng4gt'>
            <td id='s:ERL9CAng4gt;ERL9CAhTOM1' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='s:ERL9CAng4gt;ERL9CAF5NFx' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CAlGrSe'>
            <td id='s:ERL9CAlGrSe;ERL9CAhTOM1' style='vertical-align: top;'>paymentDescriptor<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAlGrSe;ERL9CAF5NFx' style='vertical-align: top;'>購入者が選択したAmazon Payお支払い方法
<br><br>最大長：64文字/バイト
                <br /></td>
        </tr>
    </tbody>
</table>

#### Type: address

<table width="100%" border="1">
  <tbody>
      <tr id='ERL9CAz3T00'>
          <td id='s:ERL9CAz3T00;ERL9CA6sOj9' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
              <br /></td>
          <td id='s:ERL9CAz3T00;ERL9CAOJuKu' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
              <br /></td>
      </tr>
      <tr id='ERL9CA1KP3f'>
          <td id='s:ERL9CA1KP3f;ERL9CA6sOj9' style='vertical-align: top;'>name<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CA1KP3f;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの名前<br><br>最大長：50文字/バイト
              <br /></td>
      </tr>
      <tr id='ERL9CAh0jHA'>
          <td id='s:ERL9CAh0jHA;ERL9CA6sOj9' style='vertical-align: top;'>addressLine1<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAh0jHA;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの最初の行<br><br>最大長：180文字/バイト
              <br /></td>
      </tr>
      <tr id='ERL9CAPTgSi'>
          <td id='s:ERL9CAPTgSi;ERL9CA6sOj9' style='vertical-align: top;'>addressLine2<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAPTgSi;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの2行目<br><br>最大長：60文字/バイト
              <br /></td>
      </tr>
      <tr id='ERL9CAUyxoY'>
          <td id='s:ERL9CAUyxoY;ERL9CA6sOj9' style='vertical-align: top;'>addressLine3<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAUyxoY;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの3行目<br><br>最大長：60文字/バイト
              <br /></td>
      </tr>
      <tr id='ERL9CAouIB6'>
          <td id='s:ERL9CAouIB6;ERL9CA6sOj9' style='vertical-align: top;'>city<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAouIB6;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの市区町村<br><br>最大長：50文字/バイト<br>
<br><strong>日本では利用できません。</strong>
              <br /></td>
      </tr>
      <tr id='ERL9CA4C31a'>
          <td id='s:ERL9CA4C31a;ERL9CA6sOj9' style='vertical-align: top;'>county<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CA4C31a;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの国<br><br>最大長：50文字/バイト<br>
<br><strong>日本では利用できません。</strong>
              <br /></td>
      </tr>
      <tr id='ERL9CAKfMWP'>
          <td id='s:ERL9CAKfMWP;ERL9CA6sOj9' style='vertical-align: top;'>district<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAKfMWP;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの地域<br><br>最大長：50文字/バイト<br>
<br><strong>日本では利用できません。</strong>
              <br /></td>
      </tr>
      <tr id='ERL9CASuiJH'>
          <td id='s:ERL9CASuiJH;ERL9CA6sOj9' style='vertical-align: top;'>stateOrRegion<br><br>Type: string
              <br /></td>
          <td id="s:ERL9CASuiJH;ERL9CAOJuKu" style="vertical-align: top;">アドレスの州または行政区：<ul><li>USおよびCAの住所 - 応答は常に2文字のコードになります</li><li>他のすべての国-この要素はフリーテキストであり、2文字のコード、完全なスペル、または省略形のいずれかです。日本では都道府県名として利用します。※購入者の入力次第で「東京」「Tokyo-to」などの文字が返却されることもあります</li></ul>最大長：50文字/バイト<br></td>
      </tr>
      <tr id='ERL9CAuAJ0a'>
          <td id='s:ERL9CAuAJ0a;ERL9CA6sOj9' style='vertical-align: top;'>postalCode<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAuAJ0a;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの郵便番号<br><br>最大長：20文字/バイト
              <br /></td>
      </tr>
      <tr id='ERL9CAo7zgS'>
          <td id='s:ERL9CAo7zgS;ERL9CA6sOj9' style='vertical-align: top;'>countryCode<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAo7zgS;ERL9CAOJuKu' style='vertical-align: top;'>ISO3166形式のアドレスの国コード<br><br>最大長：3文字/バイト
              <br /></td>
      </tr>
      <tr id=''>
          <td id='' style='vertical-align: top;'>phoneNumber<br><br>Type: string
              <br /></td>
          <td id='' style='vertical-align: top;'>電話番号<br><br>最大長：20文字/バイト
              <br /></td>
      </tr>
  </tbody>
</table>

#### Type: addressDetails

リージョンに基づく必須パラメータ。詳細については、 <a href="../amazon-pay-checkout/address-formatting-and-validation.md"  target="_blank" rel="noopener noreferrer">アドレスのフォーマットと検証</a>を参照してください。


<table width="100%" border="1">
  <tbody>
      <tr id='ERL9CAz3T00'>
          <td id='s:ERL9CAz3T00;ERL9CA6sOj9' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
              <br /></td>
          <td id='s:ERL9CAz3T00;ERL9CAOJuKu' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
              <br /></td>
      </tr>
      <tr id='ERL9CA1KP3f'>
          <td id='s:ERL9CA1KP3f;ERL9CA6sOj9' style='vertical-align: top;'>name<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CA1KP3f;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの名前<br><br>最大長：50文字/バイト
              <br /></td>
      </tr>
      <tr id='ERL9CAh0jHA'>
          <td id='s:ERL9CAh0jHA;ERL9CA6sOj9' style='vertical-align: top;'>addressLine1<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAh0jHA;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの最初の行<br><br>最大長：180文字/バイト
              <br /></td>
      </tr>
      <tr id='ERL9CAPTgSi'>
          <td id='s:ERL9CAPTgSi;ERL9CA6sOj9' style='vertical-align: top;'>addressLine2<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAPTgSi;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの2行目<br><br>最大長：60文字/バイト
              <br /></td>
      </tr>
      <tr id='ERL9CAUyxoY'>
          <td id='s:ERL9CAUyxoY;ERL9CA6sOj9' style='vertical-align: top;'>addressLine3<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAUyxoY;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの3行目<br><br>最大長：60文字/バイト
              <br /></td>
      </tr>
      <tr id='ERL9CAouIB6'>
          <td id='s:ERL9CAouIB6;ERL9CA6sOj9' style='vertical-align: top;'>city<br><br>Type: string
              <br /></td>
          <td id='s:ERL9CAouIB6;ERL9CAOJuKu' style='vertical-align: top;'>アドレスの市区町村<br><br>最大長：50文字/バイト
              <br /></td>
      </tr>
        <tr id='LVQ9CAAXzqE'>
            <td id='s:LVQ9CAAXzqE;LVQ9CANUUzj' style='vertical-align: top;'>districtOrCounty<br><br>Type: string
                <br /></td>
            <td id='s:LVQ9CAAXzqE;LVQ9CAA9Qgt' style='vertical-align: top;'>アドレスの地域または国<br><br>最大長：50文字/バイト
                <br /></td>
        </tr>
        <tr id='LVQ9CApmbiD'>
            <td id='s:LVQ9CApmbiD;LVQ9CANUUzj' style='vertical-align: top;'>stateOrRegion<br><br>Type: string
                <br /></td>
            <td id='s:LVQ9CApmbiD;LVQ9CAA9Qgt' style='vertical-align: top;'>アドレスの州または行政区<br><br>最大長：50文字/バイト
                <br /></td>
        </tr>
        <tr id='LVQ9CAQniKl'>
            <td id='s:LVQ9CAQniKl;LVQ9CANUUzj' style='vertical-align: top;'>postalCode<br><br>Type: string
                <br /></td>
            <td id='s:LVQ9CAQniKl;LVQ9CAA9Qgt' style='vertical-align: top;'>アドレスの郵便番号<br><br>最大長：20文字/バイト
                <br /></td>
        </tr>
        <tr id='LVQ9CAKr1eM'>
            <td id='s:LVQ9CAKr1eM;LVQ9CANUUzj' style='vertical-align: top;'>countryCode<br><br>Type: string
                <br /></td>
            <td id='s:LVQ9CAKr1eM;LVQ9CAA9Qgt' style='vertical-align: top;'>ISO3166形式のアドレスの国コード<br><br>最大長：2文字/バイト
                <br /></td>
        </tr>
        <tr id='LVQ9CAFqb9V'>
            <td id='s:LVQ9CAFqb9V;LVQ9CANUUzj' style='vertical-align: top;'>phoneNumber<br><br>Type: string
                <br /></td>
            <td id='s:LVQ9CAFqb9V;LVQ9CAA9Qgt' style='vertical-align: top;'>電話番号<br><br>最大長：20文字/バイト
                <br /></td>
        </tr>
    </tbody>
</table>

#### Type: statusDetails

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CA6ZDgu'>
            <td id='s:ERL9CA6ZDgu;ERL9CANROdL' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>パラメータ
                <br /></td>
            <td id='s:ERL9CA6ZDgu;ERL9CAhxxdO' style='vertical-align: top; font-weight: bold; width: 70%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CAToyr7'>
            <td id='s:ERL9CAToyr7;ERL9CANROdL' style='vertical-align: top;'>state<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAToyr7;ERL9CAhxxdO' style='vertical-align: top;'>現在のオブジェクトの状態
                <br /></td>
        </tr>
        <tr id='ERL9CA2PnwF'>
            <td id='s:ERL9CA2PnwF;ERL9CAYoYDq' style='vertical-align: top;'>reasonCode<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CA2PnwF;ERL9CAiF60P' style='vertical-align: top;'>現在の状態理由コード
                <br /></td>
        </tr>
        <tr id='ERL9CACi1cW'>
            <td id='s:ERL9CACi1cW;ERL9CAYoYDq' style='vertical-align: top;'>reasonDescription<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CACi1cW;ERL9CAiF60P' style='vertical-align: top;'>Checkout Sessionの状態オプションの説明
                <br /></td>
        </tr>
        <tr id='ERL9CAPwBch'>
            <td id='s:ERL9CAPwBch;ERL9CANROdL' style='vertical-align: top;'>lastUpdatedTimestamp<br><br>Type: dateTime
                <br /></td>
            <td id='s:ERL9CAPwBch;ERL9CAhxxdO' style='vertical-align: top;'>stateが最後に更新されたISO8601形式でのUTC日時
                <br /></td>
        </tr>
    </tbody>
</table>

#### Type: constraint

<table width="100%" border="1">
    <tbody>
        <tr id="ERL9CAFBFUi">
            <td id="s:ERL9CAFBFUi;ERL9CAy7zLM" style="vertical-align: top; font-weight: bold; width: 30%;" class="bold">パラメータ
                <br></td>
            <td id="s:ERL9CAFBFUi;ERL9CAOjvnB" style="vertical-align: top; font-weight: bold; width: 70%;" class="bold">説明
                <br></td>
        </tr>
        <tr id="ERL9CAUItYj">
            <td id="s:ERL9CAUItYj;ERL9CAy7zLM" style="vertical-align: top; width: 30%;">constraintId<br><br>Type: string
                <br></td>
            <td id="s:ERL9CAUItYj;ERL9CAOjvnB" style="vertical-align: top; width: 70%;">Checkout Session制約のコード
                <br></td>
        </tr>
        <tr id="ERL9CA6D5f8">
            <td id="s:ERL9CA6D5f8;ERL9CAy7zLM" style="vertical-align: top;">description<br><br>Type: string<br>
                <br></td>
            <td id="s:ERL9CA6D5f8;ERL9CAOjvnB" style="vertical-align: top;">Checkout Session制約の説明
                <br></td>
        </tr>
    </tbody>
</table>

<table width="100%" border="1">
    <tbody>
        <tr id="ERL9CAaRYIF">
            <td id="s:ERL9CAaRYIF;ERL9CADFEFR" style="vertical-align: top; font-weight: bold; width: 30%;" class="bold">Constraint Code
                <br></td>
            <td id="s:ERL9CAaRYIF;ERL9CAhB19s" style="vertical-align: top; font-weight: bold; width: 70%;" class="bold">説明
                <br></td>
        </tr>
        <tr id="ERL9CAt1p5S">
            <td id="s:ERL9CAt1p5S;ERL9CADFEFR" style="vertical-align: top;">CheckoutResultReturnUrlNotSet
                <br></td>
            <td id="s:ERL9CAt1p5S;ERL9CAhB19s" style="vertical-align: top;"> <code>checkoutResultReturnURL</code>がCheckout Sessionで設定されていません<br></td>
        </tr>
        <tr id="ERL9CAKGEaB">
            <td id="s:ERL9CAKGEaB;ERL9CADFEFR" style="vertical-align: top;">ChargeAmountNotSet
                <br></td>
            <td id="s:ERL9CAKGEaB;ERL9CAhB19s" style="vertical-align: top;">Checkout Sessionで<code>chargeAmount</code>が設定されていません<br></td>
        </tr>
        <tr id="ERL9CAvPdOl">
            <td id="s:ERL9CAvPdOl;ERL9CADFEFR" style="vertical-align: top;">PaymentIntentNotSet
                <br></td>
            <td id="s:ERL9CAvPdOl;ERL9CAhB19s" style="vertical-align: top;">Checkout Sessionで<code>paymentIntent</code>が設定されていません<br></td>
        </tr>
        <tr id="ERL9CARlmK7">
            <td id="s:ERL9CARlmK7;ERL9CADFEFR" style="vertical-align: top;">BuyerNotAssociated
                <br></td>
            <td id="s:ERL9CARlmK7;ERL9CAhB19s" style="vertical-align: top;">購入者が希望するお支払い方法または配送先住所がCheckout Sessionで設定されていません<br><br><br> </td>
        </tr>
        <tr>
            <td style="vertical-align: top;">RecurringFrequencyNotSet
                <br></td>
            <td style="vertical-align: top;">Checkout Sessionで<code>frequency</code>が設定されていません。Recurringの請求Charge Permissionをリクエストする場合にのみ適用されます<br><br><br></td>
        </tr>
    </tbody>
</table>

### 状態と理由コード

<img src='https://m.media-amazon.com/images/G/01/EPSDocumentation/AmazonPay/Integration/CheckoutSessionStates._CB1565018489_.png' />


<table width="100%" border="1">
    <tbody>
        <tr id="ERL9CAz0jIG">
            <td id="s:ERL9CAz0jIG;ERL9CAyy2E1" style="vertical-align: top; font-weight: bold; width: 20%;" class="bold">状態
                <br></td>
            <td id="s:ERL9CAz0jIG;ERL9CADFSon" style="vertical-align: top; font-weight: bold; width: 40%;" class="bold">説明
                <br></td>
            <td id="s:ERL9CAz0jIG;ERL9CAEhfA5" style="vertical-align: top; font-weight: bold; width: 40%;" class="bold">理由コード
                <br></td>
        </tr>
        <tr id="ERL9CAYfTlD">
            <td id="s:ERL9CAYfTlD;ERL9CAyy2E1" style="vertical-align: top;">Open
                <br></td>
            <td id="s:ERL9CAYfTlD;ERL9CADFSon" style="vertical-align: top;">Checkout Sessionの初期状態。Checkout Sessionの状態は、Update Checkout Sessionを使用し事業者によって必須フィールドが提供されて、constraintsとして欠落しているものを返します。すべてのconstraintsが取り除かれた後、事業者は購入者をAmazonPayRedirectUrlにリダイレクトして、決済を完了します。その後、Checkout Sessionの状態は、Completed状態またはCanceled状態に移行します。<br><br>購入者が24時間以内に決済を完了しない場合、Checkout SessionはCanceled状態に移行することに注意してください<br><br>許可された処理：<br> GET Checkout Session <br>UPDATE Checkout Session<br>COMPLETE Checkout Session<br></td>
                <td id="s:ERL9CAYfTlD;ERL9CAEhfA5" style="vertical-align: top;">-
                <br></td>
        </tr>
        <tr id="ERL9CAhrHuP">
            <td id="s:ERL9CAhrHuP;ERL9CAyy2E1" style="vertical-align: top;">Completed
                <br></td>
            <td id="s:ERL9CAhrHuP;ERL9CADFSon" style="vertical-align: top;">決済は正常に完了しました。購入者は<code>AmazonPayRedirectUrl</code>にリダイレクトされ、決済は<a href="../amazon-pay-api-v2/checkout-session.md#complete-checkout-session" target="_blank" rel="noopener noreferrer">Complete Checkout Session</a>で確認されました。paymentIntentが確定しました。Checkout Sessionを使用して別の支払いを実行したり、請求を再試行したりすることはできなくなります。<br><br>
            Note：<code>canHandlePendingAuthorization</code> trueに設定の場合、<a href="../amazon-pay-api-v2/checkout-session.md#complete-checkout-session">Complete Checkout Session</a>の結果はオーソリに結果にかかわらず、Checkout SessionはCompleted状態になります。詳細については、 <a href="../amazon-pay-checkout/asynchronous-processing.md" target="_blank" rel="noopener noreferrer">非同期処理</a>を参照してください<br> <br>許可された処理：<br>GET Checkout Session（Charge PermissionID、ChargeID、およびその他のCheckout Sessionの詳細が返されます）<br>COMPLETE Checkout Session<br></td>
            <td id="s:ERL9CAhrHuP;ERL9CAEhfA5" style="vertical-align: top;">-
                <br></td>
        </tr>
        <tr id="ERL9CA0bBHq">
            <td id="s:ERL9CA0bBHq;ERL9CAyy2E1" style="vertical-align: top;">Canceled
                <br></td>
            <td id="s:ERL9CA0bBHq;ERL9CADFSon" style="vertical-align: top;">購入者のキャンセル、オーソリ失敗、または<a href="../amazon-pay-api-v2/checkout-session.md#complete-checkout-session">Complete Checkout Session</a>で確認されなかったため、決済が正常に完了しませんでした。<br><br>許可された処理：<br> GET CheckoutSession（stateとreasonCodeのみを返します）<br></td>
            <td id="s:ERL9CA0bBHq;ERL9CAEhfA5" style="vertical-align: top;"> <b>BuyerCanceled</b> - 購入者が決済をキャンセルしました<br><br><b>Expired</b> - amazonPayRedirectUrlへのリダイレクトがなく、Checkout Sessionは、作成後24時間の期限が切れました。購入者が支払いを完了させなっていない、またはComplete Checkout Sessionでの確認がされませんでした。<br> <br><b>AmazonCanceled</b> - サービスが利用できないため、Amazonはトランザクションをキャンセルしました。これは支払いに関連するキャンセルではありません。<br><br><b>Declined</b> - その他オーソリの失敗。不正な決済、多要素認証（MFA）チャレンジの失敗、およびお支払い方法の問題を含みます。<br></td>
        </tr>
    </tbody>
</table>

## オペレーション

### Create Checkout Session

新しいAmazon PayのCheckout Sessionを作成して、購入者がAmazon Payボタンをクリックしてから決済を完了するまで、購入者のエクスペリエンスをカスタマイズおよび管理します。


#### リクエスト



<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.com/:version/checkoutSessions/" \<br />
-X POST<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE" <br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"<br />
-d @request_body<br />
</code>
</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.com/:environment/:version/checkoutSessions/" \<br />
-X POST<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE" <br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"<br />
-d @request_body<br />
</code>
</div>


#### リクエストボディ

```
{
    "webCheckoutDetails": {
        "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
    },
    "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
    "scopes": ["name", "email", "phoneNumber", "billingAddress"],
    "deliverySpecifications": {
        "specialRestrictions": ["RestrictPOBoxes"],
        "addressRestrictions": {
            "type": "Allowed",
            "restrictions": {
                "US": {
                    "statesOrRegions": ["WA"],
                    "zipCodes": ["95050", "93405"]
                },
                "GB": {
                    "zipCodes": ["72046", "72047"]
                },
                "IN": {
                    "statesOrRegions": ["AP"]
                },
                "JP": {}
            }
        }
    }
}  
```

#### リクエストパラメータ

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAO0JHD'>
            <td id='s:ERL9CAO0JHD;ERL9CA2r6qD' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>名前
                <br /></td>
            <td id='s:ERL9CAO0JHD;ERL9CAZAZrc' style='vertical-align: top; font-weight: bold; width: 20%;' class='bold'>ロケーション
                <br /></td>
            <td id='s:ERL9CAO0JHD;ERL9CAoRgfP' style='vertical-align: top; font-weight: bold; width: 50%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CAMViVA'>
            <td id='s:ERL9CAMViVA;ERL9CA2r6qD' style='vertical-align: top;'>x-amz-pay-idempotency-key<br><b>(必須)</b><br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAMViVA;ERL9CAZAZrc' style='vertical-align: top;'>Header
                <br /></td>
            <td id='s:ERL9CAMViVA;ERL9CAoRgfP' style='vertical-align: top;'>リクエストをを安全に再試行するための<a href="../amazon-pay-api-v2/idempotency.md" target="_blank" rel="noopener noreferrer">冪等キー</a>
                <br /></td>
        </tr>
        <tr id='ERL9CAvm2Or'>
            <td id='s:ERL9CAvm2Or;ERL9CAFccoh' style='vertical-align: top;'>webCheckoutDetails<br><b>(必須)</b><br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-webcheckoutdetails" target="_blank" rel="noopener noreferrer">webCheckoutDetails</a>
                <br /></td>
            <td id='s:ERL9CAvm2Or;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CAvm2Or;ERL9CAxmCJ7' style='vertical-align: top;'>事業者から提供された決済結果のURL。トランザクションの完了後、Amazon PayはこのURLにリダイレクトします<br><br>変更可否: 購入者が<code>amazonPayReturnUrl</code>にリダイレクトされるまで回数制限なし
                <br /></td>
        </tr>
        <tr id='ERL9CAVOprL'>
            <td id='s:ERL9CAVOprL;ERL9CA2r6qD' style='vertical-align: top;'>storeId<br><b>(必須)</b><br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAVOprL;ERL9CAZAZrc' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CAVOprL;ERL9CAoRgfP' style='vertical-align: top;'>Amazon Pay store ID. Amazon Pay インテグレーションセントラルからこの値を取得します: <a href="https://sellercentral.amazon.com/gp/pyop/seller/integrationcentral/" target="_blank" rel="noopener noreferrer">US</a>, <a href="https://sellercentral-europe.amazon.com/gp/pyop/seller/integrationcentral/" target="_blank" rel="noopener noreferrer">EU</a>, <a href="https://sellercentral-japan.amazon.com/gp/pyop/seller/integrationcentral/" target="_blank" rel="noopener noreferrer">JP</a>
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>chargePermissionType<br /><br />Type: string
                <br /></td>
            <td id='' style='text-align: left;vertical-align: top;'>Body
                <br /></td>
            <td id='' style='vertical-align: top;'>リクエストされたCharge PermissionのType<br><br>サポートされている値:
                    <ul>
                      <li>'OneTime' - このCharge Permissionは単発の注文に使用できます</li>
                      <li>'Recurring' - このCharge Permissionは定期的な注文に使用できます</li>
                      <li>'PaymentMethodOnFile' - このCharge PermissionはPaymentMethodOnFile注文に使用できます</li>
                    </ul>
            Default value: 'OneTime"
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>recurringMetadata<br /><br />Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-recurringmetadata" target="_blank" rel="noopener noreferrer">recurringMetadata</a>
                <br /></td>
            <td id='' style='text-align: left;vertical-align: top;'>Body
                <br /></td>
            <td id='' style='vertical-align: top;'>recurringのChargePermissionの使用方法に関するメタデータ。 Amazon Payは、この情報をChargePermissionの有効期限を計算と、購入者とのコミュニケーションにのみ使用します<br /><br />
            各請求サイクルで購入者に請求するために<a href="../amazon-pay-api-v2/charge.md#create-charge" target="_blank" rel="noopener noreferrer" target="_blank" rel="noopener noreferrer">Create Charge</a>を呼び出すのは、依然として事業者の責任であることに注意してください。
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>paymentMethodOnFileMetadata<br /><br />Type: <a href="checkout-session.html#type-paymentmethodonfilemetadata" target="_blank" rel="noopener noreferrer">paymentMethodOnFileMetadata</a>
                <br /></td>
            <td id='' style='text-align: left;vertical-align: top;'>Body
                <br /></td>
            <td id='' style='vertical-align: top;'>ChargePermissionをPaymentMethodOnFileの中でどのように利用するかを示す詳細情報。Amazon PayはPaymentMethodOnFileとして必要な情報を判別する為にこの情報を利用します。
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>deliverySpecifications<br /><br />Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-deliveryspecifications" target="_blank" rel="noopener noreferrer">deliverySpecifications</a>
                <br /></td>
            <td id='' style='text-align: left;vertical-align: top;'>Body
                <br /></td>
            <td id='' style='vertical-align: top;'>配送先の制限を指定して、購入者がAmazonアドレス帳からサポートされていないアドレスを選択できないようにします
                <br /></td>
        </tr>
        <tr id='ERL9CAgQ4T4'>
            <td id='s:ERL9CAgQ4T4;ERL9CAFccoh' style='vertical-align: top;'>paymentDetails<br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-paymentdetails" target="_blank" rel="noopener noreferrer">paymentDetails</a>
                <br /></td>
            <td id='s:ERL9CAgQ4T4;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CAgQ4T4;ERL9CAxmCJ7' style='vertical-align: top;'>購入者に請求する金額や方法など、販売者が指定した支払いの詳細<br><br>変更可否: 購入者が<code>amazonPayReturnUrl</code>にリダイレクトされるまで回数制限なし
                <br /></td>
        </tr>
        <tr id='ERL9CA6JHj6'>
            <td id='s:ERL9CA6JHj6;ERL9CAFccoh' style='vertical-align: top;'>merchantMetadata<br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-merchantmetadata" target="_blank" rel="noopener noreferrer">merchantMetadata</a>
                <br /></td>
            <td id='s:ERL9CA6JHj6;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CA6JHj6;ERL9CAxmCJ7' style='vertical-align: top;'>事業者から提供された外部の注文詳細<br><br>変更可否: 購入者が<code>amazonPayReturnUrl</code>にリダイレクトされるまで回数制限なし
                <br /></td>
        </tr>
        <tr id='ERL9CA7OsPD'>
            <td id='s:ERL9CA7OsPD;ERL9CAFccoh' style='vertical-align: top;'>platformId<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CA7OsPD;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CA7OsPD;ERL9CAxmCJ7' style='vertical-align: top;'>ソリューションプロバイダー（SP）の事業者識別子<br><br>SPのみがこのフィールドを使用します。<br><br>変更可否: 購入者が<code>amazonPayReturnUrl</code>にリダイレクトされるまで回数制限なし.
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>providerMetadata<br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-providermetadata" target="_blank" rel="noopener noreferrer">providerMetadata</a>
                <br /></td>
            <td id='' style='vertical-align: top;'>Body
                <br /></td>
            <td id='' style='vertical-align: top;'>決済サービスプロバイダー（PSP）によって作成されたトランザクション識別子<br><br>PSPのみがこれらのフィールドを使用します。
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>addressDetails<br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-addressdetails" target="_blank" rel="noopener noreferrer">addressDetail</a>
                <br /></td>
            <td id='' style='vertical-align: top;'>Body
                <br /></td>
            <td id='' style='vertical-align: top;'>購入者が提供したお届け先住所。このパラメーターは、 <code>checkoutMode</code>がProcessOrderかつ<code>productType</code>がPayAndShipの場合にのみ使用してください。
                <br /></td>
        </tr>
    </tbody>
</table>

#### レスポンス

処理が成功した場合、<a href="https://restfulapi.net/http-status-201-created/" target="_blank" rel="noopener noreferrer">HTTP 201 </a>ステータスコードを返します。<a href="../amazon-pay-api-v2/idempotency.md" target="_blank" rel="noopener noreferrer">冪等キー</a>を用いた後続の再試行で新しいリソースが作成されていない場合は <a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200 </a>ステータスコードを返すことがあります。


```
{
    "checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
    "webCheckoutDetails": {
        "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
        "checkoutResultReturnUrl": null,
        "checkoutCancelUrl": null,
        "amazonPayRedirectUrl": null
    },
    "productType": "PayAndShip",
    "chargePermissionType": "Recurring",   
    "recurringMetadata": {
        "frequency": { 
            "unit": "Month", 
            "value": "1" 
        },
        "amount": { 
            "amount": "30",
            "currencyCode": "USD"
        }
    }, 
    "paymentDetails": {
        "paymentIntent": null,
        "canHandlePendingAuthorization":false,
        "chargeAmount": null,
        "totalOrderAmount": null,
        "softDescriptor": null,
        "presentmentCurrency": null,
        "allowOvercharge": null,
        "extendExpiration": null
    },
    "merchantMetadata": {
        "merchantReferenceId": null,
        "merchantStoreName": null,
        "noteToBuyer": null,
        "customInformation": null
    },
    "paymentMethodOnFileMetadata": null,
    "supplementaryData": null, // Amazon Pay system data
    "buyer": null,
    "billingAddress": null,
    "paymentPreferences": [
        null
    ],
    "statusDetails": {
        "state": "Open",
        "reasonCode": null,
        "reasonDescription": null,
        "lastUpdatedTimestamp": "20191015T204327Z"
    },
    "shippingAddress": null,  // Null for PayOnly product type
    "platformId": null,
    "chargePermissionId": null,
    "chargeId": null,
    "constraints": [
        {
           "constraintId": "BuyerNotAssociated",
            "description": "There is no buyer associated with the Checkout Session. Return the checkout session id to the Amazon Pay Button to allow buyer to login."
        },
        {
           "constraintId": "ChargeAmountNotSet",
            "description": "chargeAmount is not set."
        },
        {
            "constraintId": "CheckoutResultReturnUrlNotSet",
            "description": "checkoutResultReturnUrl is not set."
        },
        {
            "constraintId": "PaymentIntentNotSet",
            "description": "paymentIntent is not set."
        }
    ],
    "creationTimestamp": "20191015T204313Z",
    "expirationTimestamp": "20191016T204313Z",
    "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
    "deliverySpecifications": {
        "specialRestrictions": ["RestrictPOBoxes"],
        "addressRestrictions": {
            "type": "Allowed",
            "restrictions": {
                "US": {
                    "statesOrRegions": ["WA"],
                    "zipCodes": ["95050", "93405"]
                },
                "GB": {
                    "zipCodes": ["72046", "72047"]
                },
                "IN": {
                    "statesOrRegions": ["AP"]
                },
                "JP": {}
            }
        }
    },
    "providerMetadata": {
        "providerReferenceId": null
    },
    "releaseEnvironment": "Sandbox"
}
```

#### エラーコード

<table width="100%" border="1">
    <tbody>
        <tr id=''>
            <td id='' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>HTTPステータスコード
                <br /></td>
            <td id='' style='vertical-align: top; font-weight: bold; width: 20%;' class='bold'>理由コード
                <br /></td>
            <td id='' style='vertical-align: top; font-weight: bold; width: 50%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'><br>400 BAD_REQUEST
                <br /></td>
            <td id='' style='vertical-align: top;'><br>CurrencyMismatch
                <br /></td>
            <td id='' style='vertical-align: top;'>リクエストに設定されている<code>chargeAmount</code>の通貨コードが<code>presentmentCurrency</code>の通貨コードと一致しません
                <br /></td>
        </tr>
    </tbody>
</table>

その他エラーは<a href="../amazon-pay-api-v2/error-handling.md" target="_blank" rel="noopener noreferrer">こちら</a>を参照してください。

### Get Checkout Session

Get Checkout Sessionの詳細には、購入者情報、お支払い方法の詳細、配送先住所が含まれます。配送先住所は、Checkout Sessionにproduct typeがPayAndShip である場合にのみ返されます。この処理を使用して、購入者が<code class="language-plaintext highlighter-rouge">AmazonPayRedirectUrl</code>から指定された<code class="language-plaintext highlighter-rouge">checkoutResultReturnUrl</code>戻った後に決済が成功したかどうかを判別します。

#### リクエスト


<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId"<br />
-X GET<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>
</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.com/:environment/:version/checkoutSessions/:checkoutSessionId"<br />
-X GET<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>
</div>


#### リクエストパラメータ

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAVsuDr'>
            <td id='s:ERL9CAVsuDr;ERL9CAdoMUq' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>名前
                <br /></td>
            <td id='s:ERL9CAVsuDr;ERL9CAoJhYx' style='vertical-align: top; font-weight: bold; width: 20%;' class='bold'>ロケーション
                <br /></td>
            <td id='s:ERL9CAVsuDr;ERL9CA4xLvY' style='vertical-align: top; font-weight: bold; width: 50%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CAmASXg'>
            <td id='s:ERL9CAmASXg;ERL9CAdoMUq' style='vertical-align: top;'>CheckoutSessionId<br><b>(必須)</b><br><br>Type: string
                <br /></td>
            <td id='s:ERL9CAmASXg;ERL9CAoJhYx' style='vertical-align: top;'>Path Parameter
                <br /></td>
            <td id='s:ERL9CAmASXg;ERL9CA4xLvY' style='vertical-align: top;'>Checkout session識別子
                <br /></td>
        </tr>
    </tbody>
</table>

#### レスポンス

処理が成功した場合、 <a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200 </a> ステータスコードを返します。

```
{
    "checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
    "webCheckoutDetails": {
        "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
        "checkoutResultReturnUrl": null,
        "checkoutCancelUrl": null,
        "amazonPayRedirectUrl": null
    },
    "chargePermissionType": "Recurring",   
    "recurringMetadata": {
        "frequency": { 
            "unit": "Month", 
            "value": "1" 
        },
        "amount": { 
            "amount": "30",
            "currencyCode": "USD"
        }
    },
    "productType": "PayAndShip",
    "paymentDetails": {
        "paymentIntent": null,
        "canHandlePendingAuthorization": false,
        "chargeAmount": null,
        "totalOrderAmount": null,
        "softDescriptor": null,
        "presentmentCurrency": null,
        "allowOvercharge": null,
        "extendExpiration": null
    },
    "merchantMetadata": {
        "merchantReferenceId": null,
        "merchantStoreName": null,
        "noteToBuyer": null,
        "customInformation": null
    },
    "paymentMethodOnFileMetadata": null,
    "supplementaryData": null, // Amazon Pay system data
    "buyer": {
        "buyerId": "buyerId",
        "name": "name-1",
        "email": "name@amazon.com",
        "phoneNumber": "800-000-0000",
        "primeMembershipTypes": null
    },
    "billingAddress": {
        "name": "Work",
        "addressLine1": "440 Terry Ave",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Seattle",
        "county": "King",    
        "district": "Seattle",
        "stateOrRegion": "WA",
        "postalCode": "98121",
        "countryCode": "US",
        "phoneNumber": "800-000-0000"
    },
    "paymentPreferences": [
        {
            "paymentDescriptor": "Visa ****1111 (Amazon Pay)"
        }
    ],
    "statusDetails": {
        "state": "Open",
        "reasonCode": null,
        "reasonDescription": null,
        "lastUpdatedTimestamp": "20191015T204327Z"
    },
    "shippingAddress": {  // Null for PayOnly product type
        "name": "Susie Smith",
        "addressLine1": "10 Ditka Ave",
        "addressLine2": "Suite 2500",
        "addressLine3": null,
        "city": "Chicago",
        "county": null,
        "district": null,
        "stateOrRegion": "IL",
        "postalCode": "60602",
        "countryCode": "US",
        "phoneNumber": "800-000-0000"
    },
    "platformId": null,
    "chargePermissionId": null,
    "chargeId": null,
    "constraints": [
        {
            "constraintId": "ChargeAmountNotSet",
            "description": "chargeAmount is not set."
        },
        {
            "constraintId": "CheckoutResultReturnUrlNotSet",
            "description": "checkoutResultReturnUrl is not set."
        },
        {
            "constraintId": "PaymentIntentNotSet",
            "description": "paymentIntent is not set."
        }
    ],
    "creationTimestamp": "20191015T204313Z",
    "expirationTimestamp": "20191016T204313Z",
    "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
    "deliverySpecifications": {
        "specialRestrictions": ["RestrictPOBoxes"],
        "addressRestrictions": {
            "type": "Allowed",
            "restrictions": {
                "US": {
                    "statesOrRegions": ["WA"],
                    "zipCodes": ["95050", "93405"]
                },
                "GB": {
                    "zipCodes": ["72046", "72047"]
                },
                "IN": {
                    "statesOrRegions": ["AP"]
                },
                "JP": {}
          }
        }
    },
    "providerMetadata": {
        "providerReferenceId": null
    },
    "releaseEnvironment": "Sandbox"
}
```

#### エラーコード

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CA3tCf3'>
            <td id='s:ERL9CA3tCf3;ERL9CACltB2' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>HTTPステータスコード
                <br /></td>
            <td id='s:ERL9CA3tCf3;ERL9CAzkjOM' style='vertical-align: top; font-weight: bold; width: 20%;' class='bold'>理由コード
                <br /></td>
            <td id='s:ERL9CA3tCf3;ERL9CAbhh9x' style='vertical-align: top; font-weight: bold; width: 50%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CAtHu1q'>
            <td id='s:ERL9CAtHu1q;ERL9CACltB2' style='vertical-align: top;'><br>404 NOT_FOUND
                <br /></td>
            <td id='s:ERL9CAtHu1q;ERL9CAzkjOM' style='vertical-align: top;'><br>ResourceNotFound
                <br /></td>
            <td id='s:ERL9CAtHu1q;ERL9CAbhh9x' style='vertical-align: top;'>Checkout Sessionの詳細は、30日後に完全に削除されます。以降、Checkout Sessionに対してリクエストを行うと、このエラーコードが返されます
                <br /></td>
        </tr>
    </tbody>
</table>

その他エラーは<a href="../amazon-pay-api-v2/error-handling.md" target="_blank" rel="noopener noreferrer">こちら</a>をご参照ください。

### Update Checkout Session

トランザクションの詳細でCheckout Sessionを更新します。購入者が<code class="language-plaintext highlighter-rouge">amazonPayRedirectUrl</code>リダイレクトされるまで、Checkout Sessionを更新し続けることができます。すべての必須パラメータが設定されると、 CheckoutSessionオブジェクトは、購入者を決済を完了するようにリダイレクトするために使用する一意の<code class="language-plaintext highlighter-rouge">amazonPayRedirectUrl</code>で応答します。

決済時に<code class="language-plaintext highlighter-rouge">paymentIntent</code>を使用して処理する必要がある<code class="language-plaintext highlighter-rouge">chargeAmount</code>を設定してください。決済が完了した後に分割して追加請求する必要がある場合は、フルオーダー金額をオプションの<code class="language-plaintext highlighter-rouge">totalOrderAmount</code>パラメータで使用してください。


#### リクエスト


<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId" \<br />
-X PATCH<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-d @request_body<br />
</code>
</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.com/:environment/:version/checkoutSessions/:checkoutSessionId" \<br />
-X PATCH<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-d @request_body<br />
</code>
</div>


#### リクエストボディ

```
{
    "webCheckoutDetails": {
        "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page"
    },
    "paymentDetails": {
        "paymentIntent": "AuthorizeWithCapture",
        "canHandlePendingAuthorization":false,
        "softDescriptor": "Descriptor",
        "chargeAmount": {
            "amount": "1",
            "currencyCode": "USD"
        }
     },
    "merchantMetadata": {
        "merchantReferenceId": "Merchant reference ID",
        "merchantStoreName": "Merchant store name",
        "noteToBuyer": "Note to buyer",
        "customInformation": "Custom information"
    }
}
```



#### リクエストパラメータ

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAipzsl'>
            <td id='s:ERL9CAipzsl;ERL9CAFccoh' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>名前
                <br /></td>
            <td id='s:ERL9CAipzsl;ERL9CAjQdu4' style='vertical-align: top; font-weight: bold; width: 20%;' class='bold'>ロケーション
                <br /></td>
            <td id='s:ERL9CAipzsl;ERL9CAxmCJ7' style='vertical-align: top; font-weight: bold; width: 50%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CA4LMaA'>
            <td id='s:ERL9CA4LMaA;ERL9CAFccoh' style='vertical-align: top;'>checkoutSessionId<br><b>(必須)</b><br><br>Type: string
                <br /></td>
            <td id='s:ERL9CA4LMaA;ERL9CAjQdu4' style='vertical-align: top;'>Path parameter
                <br /></td>
            <td id='s:ERL9CA4LMaA;ERL9CAxmCJ7' style='vertical-align: top;'>Checkout Session識別子
                <br /></td>
        </tr>
        <tr id='ERL9CAvm2Or'>
            <td id='s:ERL9CAvm2Or;ERL9CAFccoh' style='vertical-align: top;'>webCheckoutDetails<br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-webcheckoutdetails" target="_blank" rel="noopener noreferrer">webCheckoutDetails</a>
                <br /></td>
            <td id='s:ERL9CAvm2Or;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CAvm2Or;ERL9CAxmCJ7' style='vertical-align: top;'>事業者から提供された決済結果のURL。トランザクションの完了後、Amazon PayはこのURLにリダイレクトします<br><br>変更可否: 購入者が<code>amazonPayReturnUrl</code>にリダイレクトされるまで回数制限なし
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>recurringMetadata<br /><br />Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-recurringmetadata" target="_blank" rel="noopener noreferrer">recurringMetadata</a>
                <br /></td>
            <td id='' style='text-align: left;vertical-align: top;'>Body
                <br /></td>
            <td id='' style='vertical-align: top;'>recurringのChargePermissionの使用方法に関するメタデータ。 Amazon Payは、この情報をChargePermissionの有効期限を計算と、購入者とのコミュニケーションにのみ使用します<br /><br />
            各請求サイクルで購入者に請求するために<a href="../amazon-pay-api-v2/charge.md#create-charge" target="_blank" rel="noopener noreferrer">Create Charge</a>を呼び出すのは、依然として事業者の責任であることに注意してください。
                <br /></td>
        </tr>
        <tr id='ERL9CAgQ4T4'>
            <td id='s:ERL9CAgQ4T4;ERL9CAFccoh' style='vertical-align: top;'>paymentDetails<br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-paymentdetails" target="_blank" rel="noopener noreferrer">paymentDetails</a>
                <br /></td>
            <td id='s:ERL9CAgQ4T4;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CAgQ4T4;ERL9CAxmCJ7' style='vertical-align: top;'>購入者に請求する金額や方法など、販売者が指定した支払いの詳細<br><br>変更可否: 購入者が<code>amazonPayReturnUrl</code>にリダイレクトされるまで回数制限なし
                <br /></td>
        </tr>
        <tr id='ERL9CA6JHj6'>
            <td id='s:ERL9CA6JHj6;ERL9CAFccoh' style='vertical-align: top;'>merchantMetadata<br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-merchantmetadata" target="_blank" rel="noopener noreferrer">merchantMetadata</a>
                <br /></td>
            <td id='s:ERL9CA6JHj6;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CA6JHj6;ERL9CAxmCJ7' style='vertical-align: top;'>事業者から提供された外部の注文詳細<br><br>変更可否: 購入者が<code>amazonPayReturnUrl</code>にリダイレクトされるまで回数制限なし
                <br /></td>
        </tr>
        <tr id='ERL9CA7OsPD'>
            <td id='s:ERL9CA7OsPD;ERL9CAFccoh' style='vertical-align: top;'>platformId<br><br>Type: string
                <br /></td>
            <td id='s:ERL9CA7OsPD;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CA7OsPD;ERL9CAxmCJ7' style='vertical-align: top;'>ソリューションプロバイダー（SP）の事業者識別子<br><br>SPのみがこのフィールドを使用します。<br><br>変更可否: 購入者が<code>amazonPayReturnUrl</code>にリダイレクトされるまで回数制限なし
                <br /></td>
        </tr>
        <tr id='ERL9CAuzzTA'>
            <td id='s:ERL9CAuzzTA;ERL9CAFccoh' style='vertical-align: top;'>providerMetadata<br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-providermetadata" target="_blank" rel="noopener noreferrer">providerMetadata</a>
                <br /></td>
            <td id='s:ERL9CAuzzTA;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CAuzzTA;ERL9CAxmCJ7' style='vertical-align: top;'>決済サービスプロバイダー（PSP）によって作成されたトランザクション識別子<br><br>PSPのみがこれらのフィールドを使用します。<br><br>変更可否: 購入者が<code>amazonPayReturnUrl</code>にリダイレクトされるまで回数制限なし
                <br /></td>
        </tr>
    </tbody>
</table>

#### レポンス

処理が成功した場合、 <a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200 </a> ステータスコードを返します。



```
{
    "checkoutSessionId": "ada3f397-7d4b-4a55-abac-786685c02d8b",
    "webCheckoutDetails": {
        "checkoutReviewReturnUrl": "https://a.com/merchant-review-page",
        "checkoutResultReturnUrl": "https://a.com/merchant-confirm-page",
        "checkoutCancelUrl": null,
        "amazonPayRedirectUrl": "https://pay.amazon.com/redirect/checkoutId-1"
    },
    "productType": "PayAndShip",
    "paymentDetails": {
        "paymentIntent": "AuthorizeWithCapture",
        "canHandlePendingAuthorization": false,
        "chargeAmount": {
            "amount": "1",
            "currencyCode": "USD"
        },
        "totalOrderAmount": null,
        "softDescriptor": "Descriptor",
        "presentmentCurrency": "USD",
        "allowOvercharge": null,
        "extendExpiration": null
    },
    "merchantMetadata": {
        "merchantReferenceId": "Merchant reference ID",
        "merchantStoreName": "Merchant store name",
        "noteToBuyer": "Note to buyer",
        "customInformation": "Custom information"
    },
    "paymentMethodOnFileMetadata": null,
    "supplementaryData": null, // Amazon Pay system data 
    "buyer": {
        "buyerId": "buyerId",
        "name": "name-1",
        "email": "name@amazon.com",
        "phoneNumber": "800-000-0000",
        "primeMembershipTypes": null
    },
    "billingAddress":{ 
        "name": "Work",
        "addressLine1": "440 Terry Ave",
        "addressLine2": "",
        "addressLine3": "",
        "city": "Seattle",
        "county": "King",    
        "district": "Seattle",
        "stateOrRegion": "WA",
        "postalCode": "98121",
        "countryCode": "US",
        "phoneNumber": "800-000-0000"
    },
    "paymentPreferences": [
        {
            "paymentDescriptor": "Visa ****1111 (Amazon Pay)"
        }
    ],
    "statusDetails": {
        "state": "Open",
        "reasonCode": null,
        "reasonDescription": null,
        "lastUpdatedTimestamp": "20191015T195703Z"
    },
    "shippingAddress": {  // Null for PayOnly product type
        "name": "Susie Smith",
        "addressLine1": "10 Ditka Ave",
        "addressLine2": "Suite 2500",
        "addressLine3": null,
        "city": "Chicago",
        "county": null,
        "district": null,
        "stateOrRegion": "IL",
        "postalCode": "60602",
        "countryCode": "US",
        "phoneNumber": "800-000-0000"
    },
    "platformId": null,
    "chargePermissionId": null,
    "chargeId": null,
    "constraints": [],
    "creationTimestamp": "20191015T195655Z",
    "expirationTimestamp": "20191016T195655Z",
    "storeId": "amzn1.application-oa2-client.8b5e45312b5248b69eeaStoreId",
    "deliverySpecifications": {
        "specialRestrictions": ["RestrictPOBoxes"],
        "addressRestrictions": {
            "type": "Allowed",
            "restrictions": {
                "US": {
                    "statesOrRegions": ["WA"],
                    "zipCodes": ["95050", "93405"]
                },
                "GB": {
                    "zipCodes": ["72046", "72047"]
                },
                "IN": {
                    "statesOrRegions": ["AP"]
                },
                "JP": {}
            }
        }
    },
    "providerMetadata": {
        "providerReferenceId": null
    },
    "releaseEnvironment": "Sandbox"
}
```

#### エラーコード

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CA9q0ob'>
            <td id='s:ERL9CA9q0ob;ERL9CADTh10' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>HTTPステータスコード
                <br /></td>
            <td id='s:ERL9CA9q0ob;ERL9CAq22MQ' style='vertical-align: top; font-weight: bold; width: 20%;' class='bold'>理由コード
                <br /></td>
            <td id='s:ERL9CA9q0ob;ERL9CAFbHzY' style='vertical-align: top; font-weight: bold; width: 50%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CASmvZN'>
            <td id='s:ERL9CASmvZN;ERL9CADTh10' style='vertical-align: top;'><br>404 NOT_FOUND
                <br /></td>
            <td id='s:ERL9CASmvZN;ERL9CAq22MQ' style='vertical-align: top;'><br>ResourceNotFound
                <br /></td>
            <td id='s:ERL9CASmvZN;ERL9CAFbHzY' style='vertical-align: top;'>Checkout Sessionは、30日後に完全に削除されます。以降、Checkout Sessionに対してリクエストを行うと、このエラーコードが返されます
                <br /></td>
        </tr>
        <tr id='ERL9CA7wecp'>
            <td id='s:ERL9CA7wecp;ERL9CADTh10' style='vertical-align: top;'><br>422 UNPROCESSABLE_ENTITY
                <br /></td>
            <td id='s:ERL9CA7wecp;ERL9CAq22MQ' style='vertical-align: top;'>InvalidCheckoutSessionStatus
                <br /></td>
            <td id='s:ERL9CA7wecp;ERL9CAFbHzY' style='vertical-align: top;'>その処理が許可されていないstateのCheckout Sessionに対して処理を実行しようとしました
                <br /></td>
        </tr>
    </tbody>
</table>

その他エラーは<a href="../amazon-pay-api-v2/error-handling.md" target="_blank" rel="noopener noreferrer">こちら</a>を参照してください。

### Complete Checkout Session

購入者が<code class="language-plaintext highlighter-rouge">checkoutResultReturnUrl</code>に戻って、<code class="language-plaintext highlighter-rouge">paymentIntent</code>を確定した後、Checkout Sessionを完了します。

<code
        リクエストが成功した場合は、<a href="https://restfulapi.net/http-status-200-ok" target="_blank"
        rel="noopener noreferrer">HTTP 200 </a>ステータスコードを返します。もしリクエストが失敗した場合は 4xx/5xxのレスポンスを返します。


#### リクエスト


<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.com/:version/checkoutSessions/:checkoutSessionId/complete" \<br />
-X POST<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-d @request_body<br />
</code>
</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.com/:environment/:version/checkoutSessions/:checkoutSessionId/complete" \<br />
-X POST<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"<br />
-d @request_body<br />
</code>
</div>


#### リクエストボディ

```
{ }
```



#### リクエストパラメータ

<table width="100%" border="1">
    <tbody>
        <tr id='ERL9CAipzsl'>
            <td id='s:ERL9CAipzsl;ERL9CAFccoh' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>名前
                <br /></td>
            <td id='s:ERL9CAipzsl;ERL9CAjQdu4' style='vertical-align: top; font-weight: bold; width: 20%;' class='bold'>ロケーション
                <br /></td>
            <td id='s:ERL9CAipzsl;ERL9CAxmCJ7' style='vertical-align: top; font-weight: bold; width: 50%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id='ERL9CA4LMaA'>
            <td id='s:ERL9CA4LMaA;ERL9CAFccoh' style='vertical-align: top;'>checkoutSessionId<br><b>(必須)</b><br><br>Type: string
                <br /></td>
            <td id='s:ERL9CA4LMaA;ERL9CAjQdu4' style='vertical-align: top;'>Path parameter
                <br /></td>
            <td id='s:ERL9CA4LMaA;ERL9CAxmCJ7' style='vertical-align: top;'>Checkout Session識別子
                <br /></td>
        </tr>
        <tr id='ERL9CAvm2Or'>
            <td id='s:ERL9CAvm2Or;ERL9CAFccoh' style='vertical-align: top;'>chargeAmount<br><b>(必須)</b><br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-price" target="_blank" rel="noopener noreferrer">price</a>
                <br /></td>
            <td id='s:ERL9CAvm2Or;ERL9CAjQdu4' style='vertical-align: top;'>Body
                <br /></td>
            <td id='s:ERL9CAvm2Or;ERL9CAxmCJ7' style='vertical-align: top;'>決済時に<code>paymentIntent</code>を使用して処理される金額。Checkout Sessionオブジェクトの<code>paymentDetails.chargeAmount</code>と一致する必要があります
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'>totalOrderAmount<br><br>Type: <a href="../amazon-pay-api-v2/checkout-session.md#type-price" target="_blank" rel="noopener noreferrer">price</a>
                <br /></td>
            <td id='' style='vertical-align: top;'>Body
                <br /></td>
            <td id='' style='vertical-align: top;'>注文の総額。この項目に値が指定されている場合は、Checkout Sessionオブジェクト<code>paymentDetails.totalOrderAmount</code>と一致する必要があります
                <br /></td>
        </tr>
    </tbody>
</table>

#### レスポンス

<p><code class="language-plaintext highlighter-rouge">paymentIntent</code>が成功した場合、 <a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200 </a>ステータスコードを返します。</p>

```
{
    "checkoutSessionId": "bd504926-f659-4ad7-a1a9-9a747aaf5275",
    "webCheckoutDetails": null,
    "chargePermissionType": null,   
    "recurringMetadata": null,
    "productType": null,
    "paymentDetails": null,
    "merchantMetadata": null,
    "paymentMethodOnFileMetadata": null,    
    "supplementaryData":null, // Amazon Pay system data 
    "buyer": null,
    "billingAddress": null,
    "paymentPreferences": [
        null
    ],
    "statusDetails": {
        "state": "Completed",
        "reasonCode": null,
        "reasonDescription": null,
        "lastUpdatedTimestamp": "20191015T204327Z"
    },
    "shippingAddress": null,
    "platformId":null,
    "chargePermissionId": "S01-5105180-3221187",
    "chargeId": "S01-5105180-3221187-C056351",
    "constraints": [
        null
    ],
    "creationTimestamp": "20191015T204313Z",
    "expirationTimestamp": null,
    "storeId": null,
    "deliverySpecifications": null,
    "providerMetadata": null,
    "releaseEnvironment": null
}
```

#### エラーコード 

<table width="100%" border="1">
    <tbody>
        <tr id='RRV9CAAwEhs'>
            <td id='s:ERL9CA9q0ob;ERL9CADTh10' style='vertical-align: top; font-weight: bold; width: 30%;' class='bold'>HTTPステータスコード
                <br /></td>
            <td id='s:ERL9CA9q0ob;ERL9CAq22MQ' style='vertical-align: top; font-weight: bold; width: 20%;' class='bold'>理由コード
                <br /></td>
            <td id='s:ERL9CA9q0ob;ERL9CAFbHzY' style='vertical-align: top; font-weight: bold; width: 50%;' class='bold'>説明
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'><br>400 BAD_REQUEST
                <br /></td>
            <td id='' style='vertical-align: top;'><br>CurrencyMismatch
                <br /></td>
            <td id='' style='vertical-align: top;'>リクエストで提供された通貨コードが、決済時に設定された通貨と一致しません
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'><br>400 BAD_REQUEST
                <br /></td>
            <td id='' style='vertical-align: top;'><br>TransactionAmountExceeded
                <br /></td>
            <td id='' style='vertical-align: top;'>Checkout Sessionで許可されている最大請求金額を超えました
                <br /></td>
        </tr>
        <tr id='RRV9CApF183'>
            <td id='s:RRV9CApF183;RRV9CADEXUO' style='vertical-align: top;'><br>404 NOT_FOUND
                <br /></td>
            <td id='s:RRV9CApF183;RRV9CADSdxj' style='vertical-align: top;'><br>ResourceNotFound
                <br /></td>
            <td id='s:RRV9CApF183;RRV9CAxD9sC' style='vertical-align: top;'>Checkout Sessionは、30日後に完全に削除されます。以降、Checkout Sessionに対してリクエストを行うと、このエラーコードが返されます
                <br /></td>
        </tr>
        <tr id='RRV9CAFTKSt'>
            <td id='s:RRV9CAFTKSt;RRV9CADEXUO' style=''>409 CONFLICT
                <br /></td>
            <td id='s:RRV9CAFTKSt;RRV9CADSdxj' style=''>AmountMismatch
                <br /></td>
            <td id='s:RRV9CAFTKSt;RRV9CAxD9sC' style=''>Checkout Sessionオブジェクトの<code>chargeAmount</code>とリクエスト<code>chargeAmount</code>が一致していません
                <br /></td>
        </tr>
        <tr id=''>
            <td id='' style='vertical-align: top;'><br>422 UNPROCESSABLE_ENTITY
                <br /></td>
            <td id='' style='vertical-align: top;'><br>CheckoutSessionCanceled
                <br /></td>
            <td id='' style='vertical-align: top;'>購入者が取引をキャンセルしたか、支払いが拒否されたため、決済に失敗しました
                <br /></td>
        </tr>
        <tr id='RRV9CApBW84'>
            <td id='s:RRV9CApBW84;RRV9CADEXUO' style='vertical-align: top;'><br>422 UNPROCESSABLE_ENTITY
                <br /></td>
            <td id='s:RRV9CApBW84;RRV9CADSdxj' style='vertical-align: top;'>InvalidCheckoutSessionStatus
                <br /></td>
            <td id='s:RRV9CApBW84;RRV9CAxD9sC' style='vertical-align: top;'>その処理が許可されていないstateのCheckout Sessionに対して処理を実行しようとしました
                <br /></td>
        </tr>
        <tr id='RRV9CApBW84'>
            <td id='s:RRV9CApBW84;RRV9CADEXUO' style='vertical-align: top;'><br>422 UNPROCESSABLE_ENTITY
                <br /></td>
            <td id='s:RRV9CApBW84;RRV9CADSdxj' style='vertical-align: top;'>InvalidChargeStatus
                <br /></td>
            <td id='s:RRV9CApBW84;RRV9CAxD9sC' style='vertical-align: top;'>その処理が許可されていないstateのChargeに対して処理を実行しようとしました。または、<code>paymentIntent</code>がAuthorizeWithCaptureで<code>canHandlePendingAuthorization</code>をtrueに設定しているCheckout Sessionに対して、Complete Checkout Sessionを実行しようとしました
                <br /></td>
        </tr>
        <tr id='RRV9CARZv8O'>
            <td id='s:RRV9CARZv8O;RRV9CADEXUO' style='vertical-align: top;'>422 UNPROCESSABLE_ENTITY
                <br /></td>
            <td id='s:RRV9CARZv8O;RRV9CADSdxj' style='vertical-align: top;'>HardDeclined
                <br /></td>
            <td id='s:RRV9CARZv8O;RRV9CAxD9sC' style='vertical-align: top;'>Chargeはhard declinedとなりました。再試行は成功しません。購入者に連絡して、別のお支払い方法を選択してもらいます
                <br /></td>
        </tr>
        <tr id='RRV9CADgbCA'>
            <td id='s:RRV9CADgbCA;RRV9CADEXUO' style='vertical-align: top;'>422 UNPROCESSABLE_ENTITY
                <br /></td>
            <td id='s:RRV9CADgbCA;RRV9CADSdxj' style='vertical-align: top;'>PaymentMethodNotAllowed
                <br /></td>
            <td id='s:RRV9CADgbCA;RRV9CAxD9sC' style='vertical-align: top;'>購入者が選択した支払い方法は、このChargeに対しては許可されていません
                <br /></td>
        </tr>
        <tr id='RRV9CAUzZgT'>
            <td id='s:RRV9CAUzZgT;RRV9CADEXUO' style='vertical-align: top;'>422 UNPROCESSABLE_ENTITY
                <br /></td>
            <td id='s:RRV9CAUzZgT;RRV9CADSdxj' style='vertical-align: top;'>AmazonRejected
                <br /></td>
            <td id='s:RRV9CAUzZgT;RRV9CAxD9sC' style='vertical-align: top;'>ChargeはAmazonによって拒否されました。紐づくCharge Permissionもキャンセルされます
                <br /></td>
        </tr>
        <tr id='RRV9CAY9tT2'>
            <td id='s:RRV9CAY9tT2;RRV9CADEXUO' style='vertical-align: top;'>422 UNPROCESSABLE_ENTITY
                <br /></td>
            <td id='s:RRV9CAY9tT2;RRV9CADSdxj' style='vertical-align: top;'>MFANotCompleted
                <br /></td>
            <td id='s:RRV9CAY9tT2;RRV9CAxD9sC' style='vertical-align: top;'>トランザクションを処理するには、購入者が多要素認証(MFA)を完了する必要があります
                <br /></td>
        </tr>
        <tr id='RRV9CAm8slJ'>
            <td id='s:RRV9CAm8slJ;RRV9CADEXUO' style='vertical-align: top;'>422 UNPROCESSABLE_ENTITY
                <br /></td>
            <td id='s:RRV9CAm8slJ;RRV9CADSdxj' style='vertical-align: top;'>TransactionTimedOut
                <br /></td>
            <td id='s:RRV9CAm8slJ;RRV9CAxD9sC' style='vertical-align: top;'><code>canHandlePendingAuthorization</code>がfalseの場合,Amazon Payがオーソリを取得するのに十分な時間な時間が取れずChargeは拒否されました。購入者に連絡して、別の支払い方法を選択してもらいます。このエラーが頻繁に発生する場合は、<code>canHandlePendingAuthorization</code>をtrueに設定して下さい。もし<code>canHandlePendingAuthorization</code>をtrueにした場合,Amazon Payが注文の有効性を判断できなかったため、このChargeは拒否されました。購入者に連絡して、別の支払い方法を選択してもらいます。詳細については、<a href="https://pay.amazon.com">非同期処理</a>を参照してください
                <br /></td>
        </tr>
        <tr id='RRV9CA59kyj'>
            <td id='s:RRV9CA59kyj;RRV9CADEXUO' style='vertical-align: top;'>500 INTERNAL_SERVER_ERROR
                <br /></td>
            <td id='s:RRV9CA59kyj;RRV9CADSdxj' style='vertical-align: top;'>ProcessingFailure
                <br /></td>
            <td id='s:RRV9CA59kyj;RRV9CAxD9sC' style='vertical-align: top;'>内部処理エラーのため、AmazonはChargeを処理できませんでした。 Charge PermissionがChargeable状態の場合にのみChargeを再試行する必要があります
                <br /></td>
        </tr>
    </tbody>
</table>

その他エラーは<a href="../amazon-pay-api-v2/error-handling.md" target="_blank" rel="noopener noreferrer">こちら</a>を参照してください。

### 関連トピック

* [Charge Permissionオブジェクト](charge-permission.html)
* [Chargeオブジェクト](charge.html)


