Capture | Amazon Pay Japan

Capture

オーソリされた支払方法から資金を売上請求します。

説明

オーソリされた支払方法から資金を売上請求するためにCapture処理を呼び出します。支払の売上請求を成功させるためには、オーソリオブジェクトの有効期限が切れる前にこの処理を呼び出さなければなりません。その有効期限はAuthorize処理呼び出しのレスポンスで返された ExpirationTimestamp に指定されています。売上請求するには、売上請求金額を指定しなければならず、その金額は元のオーソリされた金額を超えることはできません。

売上請求の状態を確認するには、GetCaptureDetails処理を呼び出します。

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

リクエストパラメータ

パラメータ名 必須 タイプ 説明
AmazonAuthorizationId 必須 xs:string 以前のAuthorizeまたはAuthorizeOnBillingAgreementでAmazonによって生成されたオーソリのIDです。
CaptureReferenceId 必須 xs:string 販売事業者が指定できるこの売上請求のトランザクションのIDです。このIDは全ての売上請求トランザクションでユニークでなければなりません。

Amazonは以下の文字のみ利用することを推奨します。
  • 小文字の英字
  • 大文字の英字
  • 数字
  • ハイフン(ダッシュ)
  • アンダースコア
最大:32文字
CaptureAmount 必須 Price このトランザクションで売上請求する金額です。

この金額は、売上請求する前にオーソリを行った金額以下でしか指定できません。

最大:¥10,000,000 + 増額可能な上限金額
SellerCaptureNote オプション xs:string 売上請求トランザクションの説明であり、購入者へのメールに表示されます。
SoftDescriptor オプション xs:string 購入者の請求明細に表示される説明です。SoftDescriptorは支払処理から"AMZ*<SoftDescriptor>"の形式で送信されます。

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

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

最大:16文字

レスポンス要素

パラメータ名 説明
CaptureDetails ステータスとCaptureオブジェクトの詳細が含まれます。

タイプ:CaptureDetails

サンプル

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

 
    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=Capture  
    &AmazonAuthorizationId=P01-1234567-1234567-0000001  
    &CaptureAmount.Amount=94.50  
    &CaptureAmount.CurrencyCode=USD  
    &CaptureReferenceId=test_capture_1  
    &SellerCaptureNote=Lorem%20ipsum  
    &SellerId=YOUR_SELLER_ID_HERE  
    &SignatureMethod=HmacSHA256  
    &SignatureVersion=2  
    &Timestamp=2012-11-05T19%3A01%3A11Z  
    &Version=2013-01-01  
    &Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

レスポンスのサンプル

 
    <CaptureResponse xmlns="https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01">  
      <CaptureResult>  
        <CaptureDetails>  
          <AmazonCaptureId>P01-1234567-1234567-0000002</AmazonCaptureId>  
          <CaptureReferenceId>test_capture_1</CaptureReferenceId>  
          <SellerCaptureNote>Lorem ipsum</SellerCaptureNote>  
          <CaptureAmount>  
            <CurrencyCode>USD</CurrencyCode>  
            <Amount>94.50</Amount>  
          </CaptureAmount>  
          <CaptureStatus>  
            <State>Completed</State>  
            <LastUpdateTimestamp>2012-11-03T19:10:16Z</LastUpdateTimestamp>  
          </CaptureStatus>  
          <CreationTimestamp>2012-11-03T19:10:16Z</CreationTimestamp>  
        </CaptureDetails>  
      </CaptureResult>  
      <ResponseMetadata>  
        <RequestId>b4ab4bc3-c9ea-44f0-9a3d-67cccef565c6</RequestId>  
      </ResponseMetadata>  
    </CaptureResponse>