Amazon Pay Auto Pay機能 API | Amazon Pay Japan

Amazon Pay Auto Pay機能 API

AuthorizeOnBillingAgreement

Billing Agreementに保存された支払方法に対して指定の金額を確保します。

説明

AuthorizeOnBillingAgreement処理は、Billing Agreementに保存された支払方法に対して指定の金額を確保します。支払方法で請求するためには、 CaptureNowリクエストパラメータにtrue をセットするか、この処理の後でCapture処理を呼び出さなければなりません。オーソリはこの処理で返された一定期間のみ有効です。インスタント支払通知(IPN)をセットアップしている場合は、この期限の終わりにオーソリが期限切れと通知を送信します。インスタント支払通知(IPN)の詳しい情報については、Amazon Payインテグレーションガイドを参照してください。オーソリの詳細はGetAuthorizationDetails処理で要求することができます。

注意 :これはOrder Referenceオブジェクトを生成し承認する便利な処理であり、オーソリをリクエストし、その後でOrder Referenceを Closedにします。

本番環境では、この処理の最大リクエストクォーターは10であり、回復レートは1秒間に1回です。SANDBOX環境では、最大リクエストクォーターは2であり、回復レートは2秒間に1回です。

リクエストパラメータ

パラメータ名 必須 タイプ 説明
AmazonBillingAgreementId 必須 xs:string Billing AgreementのIDです。

この値は購入者がAmazonによって認証に成功した後にAmazonボタン、アドレス帳、お支払い方法ウィジェットから取得されます。
AuthorizationReferenceId 必須 xs:string システムで指定するこのオーソリトランザクションのIDです。このIDは販売事業者の全てのオーソリトランザクションでユニークである必要があります。

Amazonは以下の文字のみ利用することを推奨します。
  • 小文字の英字
  • 大文字の英字
  • 数字
  • ハイフン(ダッシュ)
  • アンダースコア
最大:32文字
AuthorizationAmount 必須 Price オーソリする金額
SellerAuthorizationNote オプション xs:string 購入者のメールに表示されるトランザクションの説明です。

最大:255文字
TransactionTimeout オプション xs:nonNegative

Integer
オーソリ処理を完了するまでの最大分数を割り当てます。時間をオーバーした場合は、自動的に失敗になり、オーソリに対しての売上請求はできません。

有効な値:0または5の倍数(5、10、15など)です。

最小値:0

最大値:1440

デフォルト:1440

値が0は常に同期処理でOpenDeclined ステータスを返します。値が0ではない場合は、常にPending ステータスを返し、インスタント支払通知(IPN)にて最終処理ステータスを受け取ります。
CaptureNow オプション xs:boolean Order Referenceに対してAuthorizationAmountリクエストパラメータで指定した金額をすぐに売上請求するか指定します。(Capture処理呼び出しをせず、注文出荷まで待ちません。)売上請求された金額は次の支払サイクルで販売事業者のアカウントに支払われます。

許可されている値
  • true - 指定された金額がすぐに売上請求されます。Capture処理を呼び出す必要はありません。
  • false - このオーソリで指定された金額を売上請求するためには、Capture処理を実行しなければなりません。
デフォルトはfalseです。
SoftDescriptor オプション xs:string CaptureNow がtrueにセットされている場合に、購入者の請求明細に表示される説明です。SoftDescriptorは支払処理から"AMZ*<SoftDescriptor>"の形式で送信されます。

日本ではJCBのみ有効です。(JCBでSoftDescriptorが設定されていない場合、法人名を自動で設定)JCB以外は固定値が表示されます。

*設定いただくパラメータは、英数字である必要があります。

最大:16文字
SellerNote オプション xs:string 購入者のメールに表示される注文の説明です。

最大:1024文字
PlatformId オプション xs:string ECサイトプラットフォームを構築するソリューションプロバイダーのSellerIdを指定します。

必要な場合のみソリューションプロバイダーのみ利用できます。販売事業者がカスタマイズしてインテグレーションする場合は提供しません。このリクエストパラメータには販売事業者のSellerIdを指定できません。

販売事業者である場合はPlatformIdを入力してはいけません。
SellerOrderAttributes オプション SellerOrder

Attributes
OrderReferenceオブジェクトの更に詳しい情報を提示します。
InheritShippingAddress オプション xs:boolean Billing Agreementオブジェクトから配送先住所詳細を引き継ぐか指定します。

許可されている値
  • true - Order ReferenceオブジェクトにBilling Agreementオブジェクトに指定されている配送先住所詳細が設定されます。
  • false - Order Referenceオブジェクトに配送先住所詳細が設定されません。
*明示的に値を設定してください。

レスポンス要素

パラメータ名 説明
AuthorizationDetails ステータス、売上請求金額などを含むオーソリオブジェクトの詳細が含まれます。

タイプ:AuthorizationDetails
AmazonOrderReferenceId Order ReferenceのIDです。

タイプ:xs:string

サンプル

呼び出しリクエストのサンプル

 
POST /OffAmazonPayments/2013-01-01 HTTP/1.1  
Content-Type: x-www-form-urlencoded  
Host: mws.amazonservices.com  
User-Agent: <Your User Agent Header>  
AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE  
&Action=AuthorizeOnBillingAgreement  
&AmazonBillingAgreementId=C01-1234567-1234567  
&AuthorizationAmount.Amount=10  
&AuthorizationAmount.CurrencyCode=USD  
&AuthorizationReferenceId=test_authorize_1  
&InheritShippingAddress=true  
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE  
&SellerAuthorizationNote=For November Order  
&SellerId=YOUR_SELLER_ID_HERE  
&SellerOrderAttributes.CustomInformation=Example Information  
&SellerOrderAttributes.SellerOrderId=testSellerOrderId  
&SellerOrderAttributes.StoreName=testStore  
&SignatureMethod=HmacSHA256  
&SignatureVersion=2  
&Timestamp=2012-10-03T19%3A01%3A11Z  
&TransactionTimeout=60  
&Version=2013-01-01  
&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

レスポンスのサンプル

 
<AuthorizeOnBillingAgreementResponse  
  xmlns="https://mws.amazonservices.com/  
    schema/OffAmazonPayments_Sandbox/2013-01-01">  
<AuthorizeOnBillingAgreementResult>  
  <AuthorizationDetails>  
    <AmazonAuthorizationId>C01-1234567-1234567-A006334</AmazonAuthorizationId>  
    <AuthorizationReferenceId>AuthReference4</AuthorizationReferenceId>  
    <SellerAuthorizationNote>ForNovemberOrder</SellerAuthorizationNote>  
    <AuthorizationAmount>  
      <Amount>20.00</Amount>  
      <CurrencyCode>USD</CurrencyCode>  
    </AuthorizationAmount>  
    <CapturedAmount>  
      <Amount>0</Amount>  
      <CurrencyCode>USD</CurrencyCode>  
    </CapturedAmount>  
    <AuthorizationFee>  
      <Amount>0.00</Amount>  
      <CurrencyCode>USD</CurrencyCode>  
    </AuthorizationFee>  
    <SoftDecline>true</SoftDecline>  
    <AuthorizationStatus>  
      <LastUpdateTimestamp>2013-12-05T00:21:19Z</LastUpdateTimestamp>  
      <State>Pending</State>  
    </AuthorizationStatus>  
    <CreationTimestamp>2013-12-01T00:21:19Z</CreationTimestamp>  
    <ExpirationTimestamp>2014-01-01T00:21:19Z</ExpirationTimestamp>  
    <CaptureNow>false</CaptureNow>  
  </AuthorizationDetails>  
<AmazonOrderReferenceId>S01-1234569-1234568</AmazonOrderReferenceId>  
</AuthorizeOnBillingAgreementResult>  
<ResponseMetadata>  
  <RequestId>2649e9a4-9a1e-4097-8ce5-bcbc307e5eb8</RequestId>  
</ResponseMetadata>  
</AuthorizeOnBillingAgreementResponse>