CloseBillingAgreement | Amazon Pay Japan

CloseBillingAgreement

購入者のBilling Agreementを終了させるために承認し、このBilling Agreementから新しいOrder Referenceまたはオーソリを生成できないようにします。

説明

このBilling Agreementで新しいOrder Referenceやオーソリを生成する必要がなくなり、Billing Agreementを終了したい場合は、以前に承認したBilling Agreementに対してCloseBillingAgreement処理を呼び出します。Billing Agreement上にある全てのまだOpen状態のオーソリは売上請求することができます。

この処理の呼び出しに成功した後で、Billing AgreementはClosed状態に遷移します。

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

リクエストパラメータ

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

この値は購入者がAmazonによって認証に成功した後にAmazonボタン、アドレス帳、お支払い方法ウィジェットから取得されます。
ClosureReason オプション xs:string Billing AgreementをCloseにした理由を指定します。

最大:1024文字

レスポンス要素

この処理は、標準レスポンス要素のみ返します。

サンプル

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

 
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=CloseBillingAgreement  
&AmazonBillingAgreementId=C01-8824045-7416542  
&ClosureReason=Closing%20OR%20for%20Test  
&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE  
&SellerId=YOUR_SELLER_ID_HERE  
&SignatureMethod=HmacSHA256  
&SignatureVersion=2  
&Timestamp=2013-12-11T12%3A32%3A42.000Z  
&Version=2013-01-01  
&Signature=yrpMpoDfGLu567t611z27v4yJ8SURIVMKcy26sJEXAMPLE

レスポンスのサンプル

 
<CloseBillingAgreementResponse  
  xmlns="https://mws.amazonservices.com/  
    schema/OffAmazonPayments_Sandbox/2013-01-01">  
<ResponseMetadata>  
  <RequestId>2649e9a4-9a1e-4097-8ce5-bcbc307e5eb8</RequestId>  
</ResponseMetadata>  
</CloseBillingAgreementResponse>