Terminology

The following table defines terminology for the Amazon Pay API section:

Term

Description

Billing Agreement

A Billing Agreement object tracks the buyer's preferred payment method, preferred shipping address, and authorization for automatic payments. A billing agreement can have an indefinite lifetime and support an indefinite number of purchases.

Order Reference

An Order Reference object is a record of each purchase made by the buyer. It tracks the payment method, shipping address, and the amount that the buyer agreed to pay for that purchase. For each automatic payment, an order reference is created from the shipping and payment information stored in the billing agreement. An order reference is valid for 180 days and applies to only one purchase. You may have up to 10 authorizations on an order reference.

Authorization

An Authorization object tracks the availability of funds and secures them for future payment against the payment instruments stored in the order reference.

Capture

A Capture object tracks the movement of funds previously secured by authorization from the buyer's payment instruments to the merchant's account.

Refund

A Refund object tracks the movement of previously captured funds from the merchant's account to the buyer's payment instruments.

Transaction

A transaction is a generic term that is used for all of the types of payment events against an order reference. This includes authorizations, captures, refunds, A-to-z Claims, chargebacks, fees, and other miscellaneous transactions.

Endpoints

All API calls to the Amazon Pay API section service should be submitted to the following endpoints:

  • Germany (DE) and United Kingdom (UK):
    • Production: https://mws-eu.amazonservices.com/OffAmazonPayments/2013-01-01/
    • Sandbox: https://mws-eu.amazonservices.com/OffAmazonPayments_Sandbox/2013-01-01/
  • United States (US):
    • Production: https://mws.amazonservices.com/OffAmazonPayments/2013-01-01/
    • Sandbox: https://mws.amazonservices.com/OffAmazonPayments_Sandbox/2013-01-01/

Operations

The Amazon Pay API section contains the following operations:

Operation

Description

CreateOrderReferenceForId

Creates an order reference for the given object.

GetBillingAgreementDetails

Returns details about the Billing Agreement object and its current state.

SetBillingAgreementDetails

Sets billing agreement details such as a description of the agreement and other information about the merchant.

ConfirmBillingAgreement

Confirms that the billing agreement is free of constraints and all required information has been set on the billing agreement.

ValidateBillingAgreement

Validates the status of the Billing Agreement object and the payment method associated with it.

AuthorizeOnBillingAgreement

Reserves a specified amount against the payment methods stored in the billing agreement.

CloseBillingAgreement

Confirms that you want to terminate the billing agreement with the buyer and that you do not expect to create any new order references or authorizations on this billing agreement.

SetOrderReferenceDetails

Sets order reference details such as the order total and a description for the order.

GetOrderReferenceDetails

Returns details about the Order Reference object and its current state.

ConfirmOrderReference

Confirms that the order reference is free of constraints and all required information has been set on the order reference.

CancelOrderReference

Cancels a previously confirmed order reference

CloseOrderReference

Confirms that an order reference has been fulfilled (fully or partially) and that you do not expect to create any new authorizations on this order reference.

Authorize

Reserves a specified amount against the payment methods stored in the order reference.

GetAuthorizationDetails

Returns the status of a particular authorization and the total amount captured on the authorization.

Capture

Captures funds from an authorized payment instrument.

GetCaptureDetails

Returns the status of a particular capture and the total amount refunded on the capture.

CloseAuthorization

Closes an authorization.

Refund

Refunds a previously captured amount.

GetRefundDetails

Returns the status of a particular refund.

GetServiceStatus

Returns the operational status of the Amazon Pay API section.


Copyright © 2009-2018 Amazon.com, Inc. or its affiliates. Amazon and Amazon.com are registered trademarks of Amazon.com, Inc. or its affiliates. All other trademarks are the property of their respective owners.