用語集

次の表はAmazon Pay APIの用語集です。

用語 説明
Billing Agreement Billing Agreementオブジェクトは、購入者が選択した支払方法、配送先住所、自動支払のAuthorizationを管理します。Billing Agreementは、決まっていない存在期間と購入数を持つことができます。
Order Reference Order Referenceオブジェクトは、購入者によって生成されたそれぞれの購入の情報です。それは購入者が購入に支払に許可した支払方法、配送先住所、金額を管理します。自動支払では、Order ReferenceはBilling Agreementに保存されている配送先と支払情報から生成されます。Order Referenceは180日有効であり、１回購入のみに許可されます。１つのOrder Referenceは10回までのAuthorizationを持つことができます。
Authorization Authorizationオブジェクトは、資金の有効性を管理し、Order Referenceに保存されている将来の支払方法に対して資金を確保します。
Capture Captureオブジェクトは、購入者の支払方法から事前に確保されたAuthorizationの資金を販売事業者のアカウントに移動します。
Refund Refundオブジェクトは、以前に販売事業者のアカウントにCaptureされた資金を購入者の支払方法に移動します。
Transaction Transactionは、Order Referenceに対して発生する全ての支払イベントで使われる一般的な用語です。これには、Authorization、Capture、Refund、マーケットプレイス保証、チャージバック、その他の様々なものが含まれます。

エンドポイント

全てのAmazon PayサービスのAPI呼び出しは、次のエンドポイントに送信しなければなりません。

  • 本番環境 ：https://mws.amazonservices.jp/OffAmazonPayments/2013-01-01/
  • SANDBOX ：https://mws.amazonservices.jp/OffAmazonPayments_Sandbox/2013-01-01/

処理方法

Amazon Pay APIは次の処理方法があります。

処理方法 説明
CreateOrderReferenceForId 与えられたオブジェクトのOrder Referenceを生成します。現在はBilling Agreementからのみ利用可能です。
GetBillingAgreementDetails Billing Agreementオブジェクトの詳細と現在の状態を返します。
SetBillingAgreementDetails Billing Agreementの説明とその他の販売事業者の情報などの詳細をBilling Agreementにセットします。
ConfirmBillingAgreement 制約が無く、全ての必須情報がセットされたBilling Agreementを承認します。
ValidateBillingAgreement Billing Agreementオブジェクトのステータスと関連された支払方法を確認します。
AuthorizeOnBillingAgreement Billing Agreementに保存された支払方法に対して指定の金額を確保します。
CloseBillingAgreement 購入者のBilling Agreementを終了させるために承認し、このBilling Agreementから新しいOrder Referenceまたはオーソリを生成できないようにします。
SetOrderReferenceDetails 注文金額や説明などの注文の詳細をOrder Referenceにセットします。
GetOrderReferenceDetails Order Referenceオブジェクトの詳細と現在の状態を返します。
ConfirmOrderReference 制約が無く、全ての必須情報がセットされたOrder Referenceを承認します。
CancelOrderReference 以前に承認されたOrder Referenceをキャンセルします。
CloseOrderReference Order Referenceが完了したことを承認し、このOrder Referenceから新しいオーソリを生成できないようにします。
Authorize Order Referenceに保存されている支払方法に対して指定した資金を確保します。
GetAuthorizationDetails 詳細なオーソリステータスとオーソリで売上請求された合計金額を返します。
Capture オーソリされた支払方法から資金を売上請求します。
GetCaptureDetails 詳細な売上請求ステータスと売上請求で返金された合計金額を返します。
CloseAuhorization オーソリをCloseします。
Refund 以前に売上請求された資金を返金します。
GetRefundDetails 返金の詳細なステータスを返します。
GetServiceStatus Amazon PayのAPIの利用状況を返します。