Amazon Pay Python SDK
Switch branches/tags
Nothing to show
Clone or download

README.md

Synopsis

The official Amazon Pay Python SDK.

Requirements

Python >= 3.2
pyOpenSSL >= 0.11
Requests >= 2.6.0

Documentation

  • The Integration steps can be found here

Sample

  • View the sample integration demo here

Installation

$ git clone https://github.com/amzn/amazon-pay-sdk-python.git
$ cd amazon-pay-sdk-python
$ sudo python3 setup.py install

PyPI

$ sudo pip3 install amazon_pay

Test it.

$ python3
Python 3.4.0 (default, Apr 11 2014, 13:05:11) 
[GCC 4.8.2] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from amazon_pay.client import AmazonPayClient
>>> 

If you run into problems related to 'IncompleteRead' try the following.

$ sudo easy_install3 -U pip

Client Code Examples

This is only a subset of calls. All MWS Amazon Pay API calls are supported.

Instantiate the client. The required parameters are mws_access_key, mws_secret key, merchant_id, region, and currency_code. sandbox sets up if it is in Sandbox or Production mode. If you do not pass in the required parameters you must set the corresponding environment variable. See the client documentation for more information.

from amazon_pay.client import AmazonPayClient

client = AmazonPayClient(
        mws_access_key='YOUR_ACCESS_KEY',
        mws_secret_key='YOUR_SECRET_KEY',
        merchant_id='YOUR_MERCHANT_ID',
        region='na',
        currency_code='USD',
        sandbox=True)

GetOrderReferenceDetails

ret = client.get_order_reference_details(
    amazon_order_reference_id='AMAZON_ORDER_REFERENCE_ID',
    address_consent_token='ADDRESS_CONSENT_TOKEN')
print(ret.to_json()) # to_xml and to_dict are also valid

SetOrderReferenceDetails

ret = client.set_order_reference_details(
    amazon_order_reference_id='AMAZON_ORDER_REFERENCE_ID',
    order_total='1.00',
    seller_note='My seller note.',
    seller_order_id='MY_UNIQUE_ORDER_ID',
    store_name='My store name.',
    custom_information='My custom information.')
print(ret.to_json()) # to_xml and to_dict are also valid

ConfirmOrderReference

ret = client.confirm_order_reference(
    amazon_order_reference_id='AMAZON_ORDER_REFERENCE_ID')
print(ret.to_json()) # to_xml and to_dict are also valid

Authorize

ret = client.authorize(
    amazon_order_reference_id='AMAZON_ORDER_REFERENCE_ID',
    authorization_reference_id='MY_UNIQUE_AUTHORIZATION_ID',
    authorization_amount='1.00',
    seller_authorization_note='Authorization note.',
    transaction_timeout=10,
    capture_now=False)    
json_response = ret.to_json()

GetAuthorizationDetails

# authorization ID returned from 'Authorize' call.
authorization_id = json.loads(json_response)['AuthorizeResponse'][
    'AuthorizeResult']['AuthorizationDetails']['AmazonAuthorizationId']

ret = client.get_authorization_details(
    amazon_authorization_id=authorization_id)
print(ret.to_json()) # to_xml and to_dict are also valid

Capture

# authorization ID returned from 'Authorize' call.
ret = client.capture(
    amazon_authorization_id='MY_ATHORIZATION_ID',
    capture_reference_id='MY_UNIQUE_CAPTURE_ID',
    capture_amount='1.00',
    seller_capture_note='Capture note.')
print(ret.to_json()) # to_xml and to_dict are also valid

GetCaptureDetails

# capture ID returned from 'Capture' call.
ret = client.get_capture_details(
    amazon_capture_id='MY_CAPTURE_ID')
print(ret.to_json()) # to_xml and to_dict are also valid

Charge - This method combines all the above calls into one which allows you to set, confirm, authorize, and capture in a single call. If this is a billing agreement it will first check to see what state it's in to see if it needs to be set. If already set, it will authorize on the billing agreement.

ret = client.charge(
    amazon_order_reference_id='ORDER_REFERENCE_ID or BILLING_AGREEMENT_ID',
    charge_amount='10.00',
    charge_note='MY_CHARGE_NOTE',
    authorize_reference_id='MY_UNIQUE_AUTHORIZATION_ID')
    print(ret.to_json())

Logging has been enabled, if you want to have logging output there are 3 ways it can be used. If you have logging settings you are currently using and you don't want them to change you can set log_enabled=True and logging output will follow your defined logging. If you are not familiar with how to setup logging settings we have pre-defined settings for you to use. In addition to setting log_enabled to true, if you want the logging output to a file set log_file_name to the name and location you want logging output to. If no value is provided logging will be sent to the console. The log_levels that can be set are "CRITICAL"; "ERROR"; "WARNING"; "INFO"; "DEBUG"; "NOTSET". In the SDK, only DEBUG is used. log_file_name and log_level are set to None by default. log_enabled is set to False.

Below is an example of how you can enable logging and output to a file. For additional settings for client please see the client example above.

from amazon_pay.client import AmazonPayClient

client = AmazonPayClient(
        mws_access_key=session['mws_access_key'],
        mws_secret_key=session['mws_secret_key'],
        merchant_id=session['merchant_id'],
        sandbox=True,
        region='na',
        currency_code='USD',
        log_enabled=True,
        log_file_name="log.txt",
        log_level="DEBUG")

Example Responses

GetOrderReferenceDetails (JSON)

{
  "GetOrderReferenceDetailsResponse": {
    "ResponseMetadata": {
      "RequestId": "2dfh56f693-0asf-4121-430a-db59e3ec571d"
    },
    "GetOrderReferenceDetailsResult": {
      "OrderReferenceDetails": {
        "CreationTimestamp": "2015-03-05T17:56:11.317Z",
        "AmazonOrderReferenceId": "S01-0000000-0000000",
        "OrderTotal": {
          "CurrencyCode": "USD",
          "Amount": "100.00"
        },
        "SellerNote": "My seller note.",
        "SellerOrderAttributes": {
          "CustomInformation": "My custom information.",
          "SellerOrderId": "14553",
          "StoreName": "My store name."
        },
        "ReleaseEnvironment": "Sandbox",
        "Buyer": {
          "Email": "bob@example.com",
          "Name": "Bob"
        },
        "Destination": {
          "DestinationType": "Physical",
          "PhysicalDestination": {
            "PostalCode": "60602",
            "Phone": "800-000-0000",
            "Name": "Susie Smith",
            "StateOrRegion": "IL",
            "AddressLine2": "Suite 2500",
            "AddressLine1": "10 Ditka Ave",
            "CountryCode": "US",
            "City": "Chicago"
          }
        },
        "OrderReferenceStatus": {
          "LastUpdateTimestamp": "2015-03-05T17:57:16.233Z",
          "State": "Open"
        },
        "ExpirationTimestamp": "2015-09-01T17:56:11.317Z",
        "IdList": {
          "member": [
            "S01-0000000-0000000-A000000",
            "S01-0000000-0000000-A999999"
          ]
        }
      }
    }
  }
}

GetOrderReferenceDetails (XML)

<GetOrderReferenceDetailsResponse xmlns="http://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01">
  <GetOrderReferenceDetailsResult>
    <OrderReferenceDetails>
      <AmazonOrderReferenceId>S01-5835994-2647190</AmazonOrderReferenceId>
      <ExpirationTimestamp>2015-09-01T17:56:11.317Z</ExpirationTimestamp>
      <SellerNote>My seller note.</SellerNote>
      <OrderTotal>
        <Amount>100.00</Amount>
        <CurrencyCode>USD</CurrencyCode>
      </OrderTotal>
      <IdList>
        <member>S01-0000000-0000000-A000000</member>
        <member>S01-0000000-0000000-A999999</member>

      </IdList>
      <OrderReferenceStatus>
        <LastUpdateTimestamp>2015-03-05T17:57:16.233Z</LastUpdateTimestamp>
        <State>Open</State>
      </OrderReferenceStatus>
      <Destination>
        <DestinationType>Physical</DestinationType>
        <PhysicalDestination>
          <Phone>800-000-0000</Phone>
          <PostalCode>60602</PostalCode>
          <Name>Susie Smith</Name>
          <CountryCode>US</CountryCode>
          <StateOrRegion>IL</StateOrRegion>
          <AddressLine2>Suite 2500</AddressLine2>
          <AddressLine1>10 Ditka Ave</AddressLine1>
          <City>Chicago</City>
        </PhysicalDestination>
      </Destination>
      <ReleaseEnvironment>Sandbox</ReleaseEnvironment>
      <Buyer>
        <Email>bob@example.com</Email>
        <Name>Bob</Name>
      </Buyer>
      <SellerOrderAttributes>
        <CustomInformation>My custom information.</CustomInformation>
        <StoreName>My store name.</StoreName>
        <SellerOrderId>14553</SellerOrderId>
      </SellerOrderAttributes>
      <CreationTimestamp>2015-03-05T17:56:11.317Z</CreationTimestamp>
    </OrderReferenceDetails>
  </GetOrderReferenceDetailsResult>
  <ResponseMetadata>
    <RequestId>6c2a39ce-afb3-492e-8e67-4945a9a63f0e</RequestId>
  </ResponseMetadata>
</GetOrderReferenceDetailsResponse>

IPN Handler Code Example

Flask

from flask import request

@app.route('/ipn_handler', methods=['GET', 'POST'])
def ipn_handler():
    from pay_with_amazon.ipn_handler import IpnHandler
    
    ret = IpnHandler(request.data, request.headers)
    if ret.authenticate():
        return(ret.to_json())
    else:
        return(ret.error)

Response

{
  "OrderReferenceNotification": {
    "OrderReference": {
      "OrderTotal": {
        "CurrencyCode": "USD",
        "Amount": "0.0"
      },
      "CreationTimestamp": "2013-01-01T01:01:01.001Z",
      "OrderReferenceStatus": {
        "State": "Closed",
        "ReasonCode": "AmazonClosed",
        "LastUpdateTimestamp": "2013-01-01T01:01:01.001Z"
      },
      "SellerOrderAttributes": null,
      "AmazonOrderReferenceId": "P01-0000000-0000000-A000000",
      "ExpirationTimestamp": "2013-01-01T01:01:01.001Z"
    }
  }
}

Search for Orders

ListOrderReference

# This method returns a list of all orders made with the custom ID tag attached
# on each order usually the SellerOrderId.
# For query, you'll want to enter in the tag you wish to search. 
# For query_type, currently only SellerOrderId is accepted at this time.
# However, more query types will become available in the future.
ret = client.list_order_reference(
    query_id="MY_QUERY_ID",
    query_type="MY_QUERY_TYPE")
print(ret.to_json())

Response

{
    "ListOrderReferenceResponse": {
        "ListOrderReferenceResult": {
            "OrderReferenceList": {
                "OrderReference": {
                    "ReleaseEnvironment": "Sandbox",
                    "OrderReferenceStatus": {
                        "LastUpdateTimestamp": "2017-08-10T21:25:38.628Z",
                        "State": "Open"
                    },
                    "AmazonOrderReferenceId": "S01-0000000-0000000",
                    "CreationTimestamp": "2017-08-10T21:25:10.592Z",
                    "SellerOrderAttributes": {
                        "StoreName": "Test Store Name",
                        "CustomInformation": "Example Customer Info",
                        "OrderItemCategories": {
                            "OrderItemCategory": "Antiques"
                        },
                        "SellerOrderId": "QUERY_ID"
                    },
                    "OrderTotal": {
                        "CurrencyCode": "USD",
                        "Amount": "12.00"
                    }
                }
            }
        },
        "ResponseMetadata": {
            "RequestId": "fbd130c0-fc7e-46ca-8d97-248f89c16a1e"
        }
    }
}

ListOrderReferenceByNextToken

# This method returns a list of the continued orders from the previous call
# using a NextPageToken value to render the next page of data if a page_size
# was used to split the list of orders into multiple pages.
reply = client.list_order_reference_by_next_token(
    next_page_token="NEXT_PAGE_TOKEN") 
print(ret.to_json())

Show the Entire Payment History of an Order

GetPaymentDetails

# This method returns the entire payment history of an order in an easy to 
# parse format of a list of objects .

reply = client.get_payment_details(amazon_order_reference_id='AMAZON_ORDER_REFERENCE_ID')

Response

[<amazon_pay.payment_response.PaymentResponse object at 0x000000000>, 
<amazon_pay.payment_response.PaymentResponse object at 0x000000000>, 
<amazon_pay.payment_response.PaymentResponse object at 0x000000000>]

You can convert this data using our to_dict(), to_json(), or to_xml() and then parse through the response of each item. The example below shows the basic way to parse through these objects. The example below when paired with the above information will return the corresponding hex object as well as all of the information inside of it. This is to show what is stored, and how you can read through the data.

    for i in range(len(reply)):
        query = json.loads(reply[i].to_json())
        if 'GetOrderReferenceDetailsResponse' in query:
            print(reply[i])
            print(query['GetOrderReferenceDetailsResponse'])
        elif 'GetAuthorizationDetailsResponse' in query:
            print(reply[i])
            print(query['GetAuthorizationDetailsResponse'])
        elif 'GetCaptureDetailsResponse' in query:
            print(reply[i])
            print(query['GetCaptureDetailsResponse'])
        elif 'GetRefundDetailsResponse' in query:
            print(reply[i])
            print(query['GetRefundDetailsResponse'])
        else:
            print("Error")

API Reference

Official Amazon Pay API Reference