ask_sdk_model.interfaces.amazonpay.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.v1.amazon_pay_error_response module

class ask_sdk_model.interfaces.amazonpay.v1.amazon_pay_error_response.AmazonPayErrorResponse(error_code=None, error_message=None)

Bases: object

Error response for SetupAmazonPay and ChargeAmazonPay calls.

Parameters:
  • error_code ((optional) str) – Error code indicating the succinct cause of error
  • error_message ((optional) str) – Description of the error.
attribute_map = {'error_code': 'errorCode', 'error_message': 'errorMessage'}
deserialized_types = {'error_code': 'str', 'error_message': '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.v1.charge_amazon_pay module

class ask_sdk_model.interfaces.amazonpay.v1.charge_amazon_pay.ChargeAmazonPay(consent_token=None, seller_id=None, billing_agreement_id=None, payment_action=None, authorize_attributes=None, seller_order_attributes=None, provider_attributes=None)

Bases: object

Charge Amazon Pay Request Object

Parameters:
attribute_map = {'authorize_attributes': 'authorizeAttributes', 'billing_agreement_id': 'billingAgreementId', 'consent_token': 'consentToken', 'payment_action': 'paymentAction', 'provider_attributes': 'providerAttributes', 'seller_id': 'sellerId', 'seller_order_attributes': 'sellerOrderAttributes'}
deserialized_types = {'authorize_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.authorize_attributes.AuthorizeAttributes', 'billing_agreement_id': 'str', 'consent_token': 'str', 'payment_action': 'ask_sdk_model.interfaces.amazonpay.model.v1.payment_action.PaymentAction', 'provider_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.provider_attributes.ProviderAttributes', 'seller_id': 'str', 'seller_order_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.seller_order_attributes.SellerOrderAttributes'}
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.v1.charge_amazon_pay_result module

class ask_sdk_model.interfaces.amazonpay.v1.charge_amazon_pay_result.ChargeAmazonPayResult(amazon_order_reference_id=None, authorization_details=None)

Bases: object

Charge Amazon Pay Result Object. It is sent as part of the reponse to ChargeAmazonPay request.

Parameters:
attribute_map = {'amazon_order_reference_id': 'amazonOrderReferenceId', 'authorization_details': 'authorizationDetails'}
deserialized_types = {'amazon_order_reference_id': 'str', 'authorization_details': 'ask_sdk_model.interfaces.amazonpay.model.v1.authorization_details.AuthorizationDetails'}
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.v1.setup_amazon_pay module

class ask_sdk_model.interfaces.amazonpay.v1.setup_amazon_pay.SetupAmazonPay(consent_token=None, seller_id=None, country_of_establishment=None, ledger_currency=None, checkout_language=None, billing_agreement_attributes=None, need_amazon_shipping_address=False, sandbox_mode=False, sandbox_customer_email_id=None)

Bases: object

Setup Amazon Pay Request Object

Parameters:
  • consent_token ((optional) str) – Authorization token that contains the permissions consented to by the user.
  • seller_id ((optional) str) – The seller ID (also known as merchant ID). If you are an Ecommerce Provider (Solution Provider), please specify the ID of the merchant, not your provider ID.
  • country_of_establishment ((optional) str) – The country in which the merchant has registered, as an Amazon Payments legal entity.
  • ledger_currency ((optional) str) – The currency of the merchant’s ledger account.
  • checkout_language ((optional) str) – The merchant's preferred language for checkout.
  • billing_agreement_attributes ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_attributes.BillingAgreementAttributes) –
  • need_amazon_shipping_address (bool) – To receive the default user shipping address in the response, set this parameter to true. Not required if a user shipping address is not required.
  • sandbox_mode (bool) – To test in Sandbox mode, set this parameter to true.
  • sandbox_customer_email_id ((optional) str) – Use this parameter to create a Sandbox payment object. In order to use this parameter, you first create a Sandbox user account in Seller Central. Then, pass the email address associated with that Sandbox user account.
attribute_map = {'billing_agreement_attributes': 'billingAgreementAttributes', 'checkout_language': 'checkoutLanguage', 'consent_token': 'consentToken', 'country_of_establishment': 'countryOfEstablishment', 'ledger_currency': 'ledgerCurrency', 'need_amazon_shipping_address': 'needAmazonShippingAddress', 'sandbox_customer_email_id': 'sandboxCustomerEmailId', 'sandbox_mode': 'sandboxMode', 'seller_id': 'sellerId'}
deserialized_types = {'billing_agreement_attributes': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_attributes.BillingAgreementAttributes', 'checkout_language': 'str', 'consent_token': 'str', 'country_of_establishment': 'str', 'ledger_currency': 'str', 'need_amazon_shipping_address': 'bool', 'sandbox_customer_email_id': 'str', 'sandbox_mode': 'bool', 'seller_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.v1.setup_amazon_pay_result module

class ask_sdk_model.interfaces.amazonpay.v1.setup_amazon_pay_result.SetupAmazonPayResult(billing_agreement_details=None)

Bases: object

Setup Amazon Pay Result Object. It is sent as part of the reponse to SetupAmazonPay request.

Parameters:billing_agreement_details ((optional) ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details.BillingAgreementDetails) –
attribute_map = {'billing_agreement_details': 'billingAgreementDetails'}
deserialized_types = {'billing_agreement_details': 'ask_sdk_model.interfaces.amazonpay.model.v1.billing_agreement_details.BillingAgreementDetails'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model