ワンタイム Amazon Pay API | Amazon Pay Japan

ワンタイム Amazon Pay API

Authorize

Order Referenceに保存されている支払方法に対して指定した費用を確保します。

説明

Authorize処理は、Order Referenceに保存されている支払方法に対して指定した資金を確保します。支払方法に請求するためには、 CaptureNowリクエストパラメータにtrue をセットするか、この処理を呼び出した後でCapture処理を呼び出します。オーソリは、処理のレスポンスで指定された特定の期間でのみ有効です。有効期限が終了すると、オーソリは期限切れになり、インスタント支払通知(IPN)の設定している場合は、通知が送信されます。

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

詳しい情報は次の通りです。

リクエストパラメータ

パラメータ名 必須 タイプ 説明
AmazonOrderReferenceId 必須 xs:string Order ReferenceのIDです。

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

Amazonは以下の文字のみ利用することを推奨します。
  • 小文字の英字
  • 大文字の英字
  • 数字
  • ハイフン(ダッシュ)
  • アンダースコア
最大:32文字
AuthorizationAmount 必須 Price オーソリする金額

最大:¥10,000,000 + 増額可能な上限金額
SellerAuthorizationNote オプション xs:string 購入者のメールに表示されるトランザクションの説明です。CaptureNowをtrue にした場合のみ表示されます。

最大:255文字
TransactionTimedOut オプション xs:non
negativ
integer
オーソリ処理を完了するまでの最大分数を割り当てます。時間をオーバーした場合は、自動的に失敗になり、オーソリに対しての売上請求はできません。

注意 :非同期モードでは、オーソリ処理は最初は常にPending状態を返します。オーソリはAmazonが処理するまでこの状態を維持します。処理が完了した後は、Amazonは最終処理ステータスを通知します。

有効な値:0または5の倍数(5、10、15など)です。0をセットした場合は同期モードです。0より大きな値をセットした場合は非同期モードです。

同期モードでのTransactionTimeout値は、0をセットしてください。

非同期モードでのTransactionTimeout値は、最小5、最大1440、デフォルトは1440です。
CaptureNow オプション xs:boolean AuthorizationAmountに指定した金額をすぐに売上請求するか指定します。(Capture処理呼び出しをせず、注文出荷まで待ちません。)この値を true にセットする場合は、SellerAuthorizationNoteを指定してください。売上請求された金額は次の支払サイクルで販売事業者のアカウントに支払われます。

注意 :Amazon Payのポリシーでは、注文商品が出荷されてから購入者に請求します。注文出荷前に費用を請求してはいけません。

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

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

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

最大:16文字

レスポンス要素

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

タイプ:AuthorizationDetails

サンプル

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

 
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=AKIAFBM3LG5JEEXAMPLE  
&Action=Authorize  
&AmazonOrderReferenceId=P01-1234567-1234567  
&AuthorizationAmount.Amount=94.50  
&AuthorizationAmount.CurrencyCode=USD  
&AuthorizationReferenceId=test_authorize_1  
&SellerAuthorizationNote=Lorem ipsum  
&SellerId=YOUR_SELLER_ID_HERE  
&SignatureMethod=HmacSHA256  
&SignatureVersion=2  
&Timestamp=2012-10-03T19:01:11Z  
&TransactionTimeout=60  
&Version=2013-01-01  
&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE  

レスポンスのサンプル

 
<AuthorizeResponse xmlns=" https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01">  
  <AuthorizeResult>  
    <AuthorizationDetails>  
      <AmazonAuthorizationId>  
        P01-1234567-1234567-0000001  
      </AmazonAuthorizationId>  
    <AuthorizationReferenceId>test_authorize_1</AuthorizationReferenceId>  
      <SellerAuthorizationNote>Lorem ipsum</SellerAuthorizationNote>  
      <AuthorizationAmount>  
        <CurrencyCode>USD</CurrencyCode>  
        <Amount>94.50</Amount>  
      </AuthorizationAmount>  
      <AuthorizationFee>  
        <CurrencyCode>USD</CurrencyCode>  
        <Amount>0</Amount>  
      </AuthorizationFee>  
	<SoftDecline>true</SoftDecline>  
      <AuthorizationStatus>  
        <State>Pending</State>  
        <LastUpdateTimestamp>2012-11-03T19:10:16Z</LastUpdateTimestamp>  
      </AuthorizationStatus>  
      <CreationTimestamp>2012-11-02T19:10:16Z</CreationTimestamp>  
      <ExpirationTimestamp>2012-12-02T19:10:16Z</ExpirationTimestamp>  
    </AuthorizationDetails>  
  </AuthorizeResult>  
  <ResponseMetadata>  
    <RequestId>b4ab4bc3-c9ea-44f0-9a3d-67cccef565c6</RequestId>  
  </ResponseMetadata>  
</AuthorizeResponse>