GetBillingAgreementDetails
Billing Agreementオブジェクトの詳細と現在の状態を返します。
説明
GetBillingAgreementDetails処理は、Billing Agreementオブジェクトの詳細と現在の状態を返します。Billing Agreementオブジェクトは次の情報を提供します。
- 購入者
- 説明
- 説明(オプション)
- 販売事業者のBilling Agreement詳細(オプション)
- 制約のリスト(オプション)
本番環境では、この処理の最大リクエストクォーターは20であり、回復レートは1秒間に2回です。SANDBOX環境では、最大リクエストクォーターは5であり、回復レートは1秒間に1回です。
リクエストパラメータ
パラメータ名 | 必須 | タイプ | 説明 |
---|---|---|---|
AmazonBillingAgreementId | 必須 | xs:string |
Billing AgreementのIDです。
この値は購入者がAmazonによって認証に成功した後にAmazonボタン、アドレス帳、お支払い方法ウィジェットから取得されます。 |
AccessToken | オプション | xs:string |
購入者住所への同意トークンです。完全な住所をBilling Agreementを認証する前に取得したい場合は、有効な AccessToken を提供しなければなりません。それ以外の場合は、Billing Agreementを承認する前では、都道府県、郵便番号のみ受け取ります。
この値は、Amazonによって認証に成功した後でAmazonボタンウィジェットから取得されます。 |
レスポンス要素
パラメータ名 | 説明 |
---|---|
BillingAgreementDetails |
Billing Agreementオブジェクトの詳細と現在の状態が含まれます。
タイプ:BillingAgreementDetails |
サンプル
呼び出しリクエストのサンプル
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=GetBillingAgreementDetails
&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
レスポンスのサンプル
<GetBillingAgreementDetailsResponse
xmlns="https://mws.amazonservices.com/
schema/OffAmazonPayments_Sandbox/2013-01-01">
<GetBillingAgreementDetailsResult>
<BillingAgreementDetails>
<AmazonBillingAgreementId>C01-8824045-7416542</AmazonBillingAgreementId>
<Constraints>
<ConstraintID>BuyerConsentNotSet</ConstraintID>
<Description>
Buyer has not given consent for this Billing Agreement.
</Description>
</Constraints>
<CreationTimestamp>2013-12-05T00:21:19Z</CreationTimestamp>
<Destination>
<DestinationType>Physical</DestinationType>
<PhysicalDestination>
<City>Seattle</City>
<CountryCode>US</CountryCode>
<PostalCode>98104</PostalCode>
<StateOrRegion>WA</StateOrRegion>
</PhysicalDestination>
</Destination>
<BillingAgreementLimits>
<AmountLimitPerTimePeriod>
<CurrencyCode>USD</CurrencyCode>
<Amount>500</Amount>
</AmountLimitPerTimePeriod>
<TimePeriodStartDate>2013-12-01T00:00:00Z</TimePeriodStartDate>
<TimePeriodEndDate>2014-01-01T00:00:00Z</TimePeriodEndDate>
<CurrentRemainingBalance>
<CurrencyCode>USD</CurrencyCode>
<Amount>94.50</Amount>
</CurrentRemainingBalance>
</BillingAgreementLimits>
<BillingAgreementStatus>
<State>Draft</State>
</BillingAgreementStatus>
<ReleaseEnvironment>Sandbox</ReleaseEnvironment>
</BillingAgreementDetails>
</GetBillingAgreementDetailsResult>
<ResponseMetadata>
<RequestId>4a08624e-fffa-4fe7-bc19-ef9330c42f6a</RequestId>
</ResponseMetadata>
</GetBillingAgreementDetailsResponse>