ValidateBillingAgreement | Amazon Pay Japan

ValidateBillingAgreement

Billing Agreementオブジェクトのステータスと関連された支払方法を確認します。

説明

Billing AgreementがOpen 状態に遷移した(ConfirmBillingAgreement処理の呼び出しに成功した)場合にValidateBillingAgreement処理を呼び出します。この処理はBilling Agreementのステータスを確認し、関連した支払方法について確認します。

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

リクエストパラメータ

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

この値は購入者がAmazonによって認証に成功した後にAmazonボタン、アドレス帳、お支払い方法ウィジェットから取得されます。

レスポンス要素

パラメータ名 説明
ValidationResult 許可されている値:
  • Success - 確認が成功したことを意味します。
  • Faiure - 確認に失敗したことを意味します。
タイプ:xs:string
FaiureReasonCode ValidationResultが失敗した理由を説明します。

許可されている値:
  • InvalidPaymentMethod - Blling Agreementに関連している支払方法が無効です。
  • ValidationTimeOut - 確認がタイムアウトであるか、完了できませんでした。
ValidationResultが失敗した場合のみ返されます。

タイプ:xs:string
BillingAgreementStatus Billing Agreementの現在のステータスを表します。

タイプ:BillingAgreementStatus

サンプル

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

 
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=ValidateBillingAgreement  
&AmazonBillingAgreementId=C01-8824045-7416542  
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE  
&SellerId=YOUR_SELLER_ID_HERE  
&SignatureMethod=HmacSHA256  
&SignatureVersion=2  
&Timestamp=2013-12-11T10%3A38%3A44.000Z  
&Version=2013-01-01  
&Signature=gP11oEBaaiQdASWsLDyid18Wn%2BB%2FKZQQtKgpHCtEXAMPLE

レスポンスのサンプル

 
<ValidateBillingAgreementResponse  
  xmlns="https://mws.amazonservices.com/  
    schema/OffAmazonPayments_Sandbox/2013-01-01">  
<ValidateBillingAgreementResult>  
  <ValidationResult>Failure</ValidationResult>  
  <FailureReasonCode>InvalidPaymentMethod</FailureReasonCode>  
  <BillingAgreementStatus>  
    <LastUpdateTimestamp>2013-12-05T00:21:19Z</LastUpdateTimestamp>  
    <State>Suspended</State>  
    <ReasonCode>InvalidPaymentMethod</ReasonCode>  
    <ReasonDescription>Payment method is not valid.</ReasonDescription>  
  </BillingAgreementStatus>  
</ValidateBillingAgreementResult>  
<ResponseMetadata>  
  <RequestId>f42df4b1-8047-11df-8d5c-bf56a38ef3b4</RequestId>  
</ResponseMetadata>  
</ValidateBillingAgreementResponse>