ask_sdk_model.interfaces.amazonpay.model.v1 package¶

Submodules¶

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_sdk_model.interfaces.amazonpay.model.v1.authorization_details module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.authorization_details.AuthorizationDetails(amazon_authorization_id=None, authorization_reference_id=None, seller_authorization_note=None, authorization_amount=None, captured_amount=None, authorization_fee=None, id_list=None, creation_timestamp=None, expiration_timestamp=None, authorization_status=None, soft_decline=None, capture_now=None, soft_descriptor=None)¶

Bases: object

This object encapsulates details about an Authorization object including the status, amount captured and fee charged.

Parameters:

amazon_authorization_id ((optional) str) – This is AmazonPay generated identifier for this authorization transaction.
authorization_reference_id ((optional) str) – This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
seller_authorization_note ((optional) str) – A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
authorization_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –
captured_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –
authorization_fee ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –
id_list ((optional) list[str]) – list of AmazonCaptureId identifiers that have been requested on this Authorization object.
creation_timestamp ((optional) datetime) – This is the time at which the authorization was created.
expiration_timestamp ((optional) datetime) – This is the time at which the authorization expires.
authorization_status ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status.AuthorizationStatus) –
soft_decline ((optional) bool) – This indicates whether an authorization resulted in a soft decline.
capture_now ((optional) bool) – This indicates whether a direct capture against the payment contract was specified.
soft_descriptor ((optional) str) – This is the description to be shown on the buyer's payment instrument statement if AuthorizeAndCapture was chosen.

attribute_map = {'amazon_authorization_id': 'amazonAuthorizationId', 'authorization_amount': 'authorizationAmount', 'authorization_fee': 'authorizationFee', 'authorization_reference_id': 'authorizationReferenceId', 'authorization_status': 'authorizationStatus', 'capture_now': 'captureNow', 'captured_amount': 'capturedAmount', 'creation_timestamp': 'creationTimestamp', 'expiration_timestamp': 'expirationTimestamp', 'id_list': 'idList', 'seller_authorization_note': 'sellerAuthorizationNote', 'soft_decline': 'softDecline', 'soft_descriptor': 'softDescriptor'}¶

deserialized_types = {'amazon_authorization_id': 'str', 'authorization_amount': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'authorization_fee': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'authorization_reference_id': 'str', 'authorization_status': 'ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status.AuthorizationStatus', 'capture_now': 'bool', 'captured_amount': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'creation_timestamp': 'datetime', 'expiration_timestamp': 'datetime', 'id_list': 'list[str]', 'seller_authorization_note': 'str', 'soft_decline': 'bool', 'soft_descriptor': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.authorization_status.AuthorizationStatus(state=None, reason_code=None, reason_description=None, last_update_timestamp=None)¶

Bases: object

Indicates the current status of an Authorization object, a Capture object, or a Refund object.

Parameters:

state ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.state.State) –
reason_code ((optional) str) – The reason that the Authorization object, Capture object, or Refund object is in the current state. For more information, see - https://pay.amazon.com/us/developer/documentation/apireference/201752950
reason_description ((optional) str) – Reason desciption corresponding to the reason code
last_update_timestamp ((optional) datetime) – A timestamp that indicates the time when the authorization, capture, or refund state was last updated. In ISO 8601 format

attribute_map = {'last_update_timestamp': 'lastUpdateTimestamp', 'reason_code': 'reasonCode', 'reason_description': 'reasonDescription', 'state': 'state'}¶

deserialized_types = {'last_update_timestamp': 'datetime', 'reason_code': 'str', 'reason_description': 'str', 'state': 'ask_sdk_model.interfaces.amazonpay.model.v1.state.State'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.authorize_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.authorize_attributes.AuthorizeAttributes(authorization_reference_id=None, authorization_amount=None, transaction_timeout=None, seller_authorization_note=None, soft_descriptor=None)¶

Bases: object

This is an object to set the attributes specified in the AuthorizeAttributes table. See the “AuthorizationDetails” section of the Amazon Pay API reference guide for details about this object.

Parameters:

authorization_reference_id ((optional) str) – This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
authorization_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –
transaction_timeout ((optional) int) – The maximum number of minutes allocated for the Authorize operation call to be processed. After this the authorization is automatically declined and you cannot capture funds against the authorization. The default value for Alexa transactions is 0. In order to speed up checkout time for voice users we recommend to not change this value.
seller_authorization_note ((optional) str) – A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
soft_descriptor ((optional) str) – The description to be shown on the user's payment instrument statement if AuthorizeAndCapture is chosen. Format of soft descriptor sent to the payment processor is "AMZ* <soft descriptor specified here>". Default is "AMZ*<SELLER_NAME> amzn.com/ pmts WA". Maximum length can be 16 characters.

attribute_map = {'authorization_amount': 'authorizationAmount', 'authorization_reference_id': 'authorizationReferenceId', 'seller_authorization_note': 'sellerAuthorizationNote', 'soft_descriptor': 'softDescriptor', 'transaction_timeout': 'transactionTimeout'}¶

deserialized_types = {'authorization_amount': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'authorization_reference_id': 'str', 'seller_authorization_note': 'str', 'soft_descriptor': 'str', 'transaction_timeout': 'int'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_attributes.BillingAgreementAttributes(platform_id=None, seller_note=None, seller_billing_agreement_attributes=None, billing_agreement_type=None, subscription_amount=None)¶

Bases: object

The merchant can choose to set the attributes specified in the BillingAgreementAttributes.

Parameters:

platform_id ((optional) str) – Represents the SellerId of the Solution Provider that developed the eCommerce platform. This value is only used by Solution Providers, for whom it is required. It should not be provided by merchants creating their own custom integration. Do not specify the SellerId of the merchant for this request parameter. If you are a merchant, do not enter a PlatformId.
seller_note ((optional) str) – Represents a description of the billing agreement that is displayed in emails to the buyer.
seller_billing_agreement_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.seller_billing_agreement_attributes.SellerBillingAgreementAttributes) –
billing_agreement_type ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_type.BillingAgreementType) –
subscription_amount ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –

attribute_map = {'billing_agreement_type': 'billingAgreementType', 'platform_id': 'platformId', 'seller_billing_agreement_attributes': 'sellerBillingAgreementAttributes', 'seller_note': 'sellerNote', 'subscription_amount': 'subscriptionAmount'}¶

deserialized_types = {'billing_agreement_type': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_type.BillingAgreementType', 'platform_id': 'str', 'seller_billing_agreement_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.seller_billing_agreement_attributes.SellerBillingAgreementAttributes', 'seller_note': 'str', 'subscription_amount': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details.BillingAgreementDetails(billing_agreement_id=None, creation_timestamp=None, destination=None, checkout_language=None, release_environment=None, billing_agreement_status=None)¶

Bases: object

The result attributes from successful SetupAmazonPay call.

Parameters:

billing_agreement_id ((optional) str) – Billing agreement id which can be used for one time and recurring purchases
creation_timestamp ((optional) datetime) – Time at which billing agreement details created.
destination ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination) – The default shipping address of the buyer. Returned if needAmazonShippingAddress is set to true.
checkout_language ((optional) str) – Merchant's preferred language of checkout.
release_environment ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.release_environment.ReleaseEnvironment) –
billing_agreement_status ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus) –

attribute_map = {'billing_agreement_id': 'billingAgreementId', 'billing_agreement_status': 'billingAgreementStatus', 'checkout_language': 'checkoutLanguage', 'creation_timestamp': 'creationTimestamp', 'destination': 'destination', 'release_environment': 'releaseEnvironment'}¶

deserialized_types = {'billing_agreement_id': 'str', 'billing_agreement_status': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus', 'checkout_language': 'str', 'creation_timestamp': 'datetime', 'destination': 'ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination', 'release_environment': 'ask_sdk_model.interfaces.amazonpay.model.v1.release_environment.ReleaseEnvironment'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_status.BillingAgreementStatus¶

Bases: enum.Enum

Indicates the current status of the billing agreement. For more information about the State and ReasonCode response elements, see Billing agreement states and reason codes - https://pay.amazon.com/us/developer/documentation/apireference/201752870

Allowed enum values: [CANCELED, CLOSED, DRAFT, OPEN, SUSPENDED]

CANCELED = 'CANCELED'¶

CLOSED = 'CLOSED'¶

DRAFT = 'DRAFT'¶

OPEN = 'OPEN'¶

SUSPENDED = 'SUSPENDED'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_type module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_type.BillingAgreementType¶

Bases: enum.Enum

This is used to specify applicable billing agreement type. * CustomerInitiatedTransaction – customer is present at the time of processing payment for the order. * MerchantInitiatedTransaction – customer is not present at the time of processing payment for the order.

Allowed enum values: [CustomerInitiatedTransaction, MerchantInitiatedTransaction]

CustomerInitiatedTransaction = 'CustomerInitiatedTransaction'¶

MerchantInitiatedTransaction = 'MerchantInitiatedTransaction'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.destination module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.destination.Destination(name=None, company_name=None, address_line1=None, address_line2=None, address_line3=None, city=None, district_or_county=None, state_or_region=None, postal_code=None, country_code=None, phone=None)¶

Bases: object

Destination object containing the details of an Address.

Parameters:

name ((optional) str) – The name or business name
company_name ((optional) str) – The company name
address_line1 ((optional) str) – The first line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
address_line2 ((optional) str) – The second line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
address_line3 ((optional) str) – The third line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
city ((optional) str) – The city
district_or_county ((optional) str) – The district or County
state_or_region ((optional) str) – The state or region. This element is free text and can be either a 2-character code, fully spelled out, or abbreviated. Required. Note :- This response element is returned only in the U.S.
postal_code ((optional) str) – The postal code.
country_code ((optional) str) – The country code, in ISO 3166 format
phone ((optional) str) – The phone number

attribute_map = {'address_line1': 'addressLine1', 'address_line2': 'addressLine2', 'address_line3': 'addressLine3', 'city': 'city', 'company_name': 'companyName', 'country_code': 'countryCode', 'district_or_county': 'districtOrCounty', 'name': 'name', 'phone': 'phone', 'postal_code': 'postalCode', 'state_or_region': 'stateOrRegion'}¶

deserialized_types = {'address_line1': 'str', 'address_line2': 'str', 'address_line3': 'str', 'city': 'str', 'company_name': 'str', 'country_code': 'str', 'district_or_county': 'str', 'name': 'str', 'phone': 'str', 'postal_code': 'str', 'state_or_region': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.payment_action module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.payment_action.PaymentAction¶

Bases: enum.Enum

This is used to specify applicable payment action. * Authorize – you want to confirm the order and authorize a certain amount, but you do not want to capture at this time. * AuthorizeAndCapture – you want to confirm the order, authorize for the given amount, and capture the funds.

Allowed enum values: [Authorize, AuthorizeAndCapture]

Authorize = 'Authorize'¶

AuthorizeAndCapture = 'AuthorizeAndCapture'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.price module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.price.Price(amount=None, currency_code=None)¶

Bases: object

This object specifies amount and currency authorized/captured.

Parameters:	amount ((optional) str) – Amount authorized/captured. currency_code ((optional) str) – Currency code for the amount.

attribute_map = {'amount': 'amount', 'currency_code': 'currencyCode'}¶

deserialized_types = {'amount': 'str', 'currency_code': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.provider_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.provider_attributes.ProviderAttributes(provider_id=None, provider_credit_list=None)¶

Bases: object

This is required only for Ecommerce provider (Solution provider) use cases.

Parameters:	provider_id ((optional) str) – Solution provider ID. provider_credit_list ((optional) list[ask_sdk_model.interfaces.amazonpay.model.v1.provider_credit.ProviderCredit]) – List of provider credit.

attribute_map = {'provider_credit_list': 'providerCreditList', 'provider_id': 'providerId'}¶

deserialized_types = {'provider_credit_list': 'list[ask_sdk_model.interfaces.amazonpay.model.v1.provider_credit.ProviderCredit]', 'provider_id': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.provider_credit module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.provider_credit.ProviderCredit(provider_id=None, credit=None)¶

Bases: object

Parameters:	provider_id ((optional) str) – This is required only for Ecommerce provider (Solution provider) use cases. credit ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.price.Price) –

attribute_map = {'credit': 'credit', 'provider_id': 'providerId'}¶

deserialized_types = {'credit': 'ask_sdk_model.interfaces.amazonpay.model.v1.price.Price', 'provider_id': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.release_environment module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.release_environment.ReleaseEnvironment¶

Bases: enum.Enum

Indicates if the order is for a Live (Production) or Sandbox environment.

Allowed enum values: [LIVE, SANDBOX]

LIVE = 'LIVE'¶

SANDBOX = 'SANDBOX'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.seller_billing_agreement_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.seller_billing_agreement_attributes.SellerBillingAgreementAttributes(seller_billing_agreement_id=None, store_name=None, custom_information=None)¶

Bases: object

Provides more context about the billing agreement that is represented by this Billing Agreement object.

Parameters:

seller_billing_agreement_id ((optional) str) – The merchant-specified identifier of this billing agreement. At least one request parameter must be specified. Amazon recommends that you use only the following characters:- lowercase a-z, uppercase A-Z, numbers 0-9, dash (-), underscore (_).
store_name ((optional) str) – The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings > Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
custom_information ((optional) str) – Any additional information that you wish to include with this billing agreement. At least one request parameter must be specified.

attribute_map = {'custom_information': 'customInformation', 'seller_billing_agreement_id': 'sellerBillingAgreementId', 'store_name': 'storeName'}¶

deserialized_types = {'custom_information': 'str', 'seller_billing_agreement_id': 'str', 'store_name': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.seller_order_attributes module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.seller_order_attributes.SellerOrderAttributes(seller_order_id=None, store_name=None, custom_information=None, seller_note=None)¶

Bases: object

This object includes elements shown to buyers in emails and in their transaction history. See the “SellerOrderAttributes” section of the Amazon Pay API reference guide for details about this object.

Parameters:

seller_order_id ((optional) str) – The merchant-specified identifier of this order. This is shown to the buyer in their emails and transaction history on the Amazon Pay website.
store_name ((optional) str) – The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings > Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
custom_information ((optional) str) – Any additional information that you want to include with this order reference.
seller_note ((optional) str) – This represents a description of the order that is displayed in emails to the buyer.

attribute_map = {'custom_information': 'customInformation', 'seller_note': 'sellerNote', 'seller_order_id': 'sellerOrderId', 'store_name': 'storeName'}¶

deserialized_types = {'custom_information': 'str', 'seller_note': 'str', 'seller_order_id': 'str', 'store_name': 'str'}¶

supports_multiple_types = False¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model

ask_sdk_model.interfaces.amazonpay.model.v1.state module¶

class ask_sdk_model.interfaces.amazonpay.model.v1.state.State¶

Bases: enum.Enum

Indicates the state that the Authorization object, Capture object, or Refund object is in. For more information see - https://pay.amazon.com/us/developer/documentation/apireference/201752950

Allowed enum values: [Pending, Open, Declined, Closed, Completed]

Closed = 'Closed'¶

Completed = 'Completed'¶

Declined = 'Declined'¶

Open = 'Open'¶

Pending = 'Pending'¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model