python-payway 0.0.2__tar.gz → 0.0.4__tar.gz

python_payway-0.0.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Ben Napper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_payway-0.0.4/PKG-INFO

@@ -0,0 +1,244 @@
+Metadata-Version: 2.1
+Name: python-payway
+Version: 0.0.4
+Summary: Python client for working with Westpac's PayWay REST API
+Author-email: Ben Napper <reppan197@gmail.com>
+License: MIT
+Keywords: payway,westpac,api,client
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20.0
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.5.0; extra == "dev"
+Requires-Dist: ruff==0.6.6; extra == "dev"
+Requires-Dist: mypy>=0.971; extra == "dev"
+
+# PayWay REST API - Python
+
+- Store customers, their card and bank account in PayWay
+- Take payment using a stored credit card or bank account
+- Process and Capture a pre-authorisation
+- Lookup or poll transactions
+- Refund transactions
+- Void transactions
+- Update a customer's payment setup in PayWay
+
+## Install
+
+```bash
+pip install python-payway
+```
+
+## Take payment using a stored credit card
+
+Create a Client class with your PayWay API credentials
+
+```python
+from payway.client import Client
+
+client = Client(merchant_id='<your_payway_merchant_id>',
+                bank_account_id='<your_payway_bank_account_id>',
+                publishable_api_key='<your_payway_publishable_api_key>',
+                secret_api_key='<your_payway_secret_api_key>')
+```
+
+Create a PayWayCustomer class with your customer's details
+
+```python
+customer = PayWayCustomer(custom_id='c981a',
+                          customer_name='John Smith',
+                          email_address='johnsmith@example.com',
+                          send_email_receipts=False,  # not available in sandbox
+                          phone_number='0343232323',
+                          street='1 Test Street',
+                          street2='2 Test Street',
+                          city_name='Sydney',
+                          state='NSW',
+                          postal_code='2000')
+```
+
+Create a PayWayCard class with your customer's card details
+
+```python
+card = PayWayCard(card_number='',
+                  cvn='',
+                  card_holder_name='',
+                  expiry_date_month='',
+                  expiry_date_year='')
+```
+
+Create a token from your card and create a customer in PayWay
+
+```python
+token_response, errors = client.create_card_token(card)
+token = token_response.token        
+customer.token = token
+payway_customer, customer_errors = client.create_customer(customer)
+```
+
+Note the 'payway_customer' object contains the full customer response fields from PayWay.
+
+Create a Payment class with the payment details and process the transaction
+
+```python
+customer_number = payway_customer.customer_number
+payment = PayWayPayment(customer_number=customer_number,
+                        transaction_type='payment',
+                        amount='',
+                        currency='aud',
+                        order_number='',
+                        ip_address='')
+transaction, errors = client.process_payment(payment)
+```
+
+Check the `transaction` for the result
+
+```python
+if not errors and transaction.status == 'approved':
+    # process successful response
+```
+
+## Take payment using a credit card token only
+
+```python
+client = Client(merchant_id='',
+                bank_account_id='',
+                publishable_api_key='',
+                secret_api_key='')
+card = PayWayCard(card_number='',
+                  cvn='',
+                  card_holder_name='',
+                  expiry_date_month='',
+                  expiry_date_year='')
+token_response, errors = client.create_card_token(card)
+# your customer reference number or a stored PayWay customer number
+customer_number = ''    
+payment = PayWayPayment(customer_number=customer_number,
+                        transaction_type='payment',
+                        amount='',
+                        currency='aud',
+                        order_number='',
+                        ip_address='',
+                        token=token_response.token,
+                        merchant_id=client.merchant_id)
+transaction, errors = client.process_payment(payment)
+```
+
+## Handling errors
+
+Documented errors (such as 422 Unprocessable entity) are parsed into an PaymentError class that you can use in an customer error message.
+For more info, visit <https://www.payway.com.au/docs/rest.html#http-response-codes>
+
+```python
+if errors:
+    for error in errors: 
+        print(error.field_name)
+        print(error.message) 
+        print(error.field_name)
+    # or use a method
+    PaymentError().list_to_message(errors) 
+```
+
+## Direct Debit
+
+Direct debit transactions are possible by creating a token from a bank account:
+
+```python
+bank_account = BankAccount(account_name='Test', bsb='000-000', account_number=123456)
+token_response, errors = client.create_bank_account_token(bank_account)
+token = token_response.token
+```
+
+Store the token with a customer in PayWay using the same process as the card outlined above.
+
+Note: direct debit transactions take days to process so they must be polled regularly for the latest transaction status from the customer's bank.
+
+## Lookup transaction
+
+Poll a transaction using the `get_transaction` method.
+
+```python
+transaction, errors = client.get_transaction(transaction.transaction_id)
+```
+
+## Process and capture a pre-authorisation
+
+To process a credit card pre-authorisation using a credit card stored against a customer use `preAuth` as the `transaction_type` along with the customer's PayWay number, amount and currency.
+
+```python
+pre_auth_payment = PayWayPayment(customer_number='',
+                                 transaction_type='preAuth',
+                                 amount='',
+                                 currency='aud',
+                                 order_number='',
+                                 ip_address='')
+transaction, errors = client.process_payment(pre_auth_payment)
+```
+
+To capture the pre-authorisation supply a pre-authorisation transaction ID,  `capture` as the `transaction_type` along with an amount to capture.
+
+```python
+capture_payment = PayWayPayment(transaction_type='capture',
+                                parent_transaction_id='',
+                                amount='',
+                                order_number='',
+                                ip_address='')
+transaction, errors = client.process_payment(capture_payment)
+```
+
+## Refunds
+
+Refund a transaction by supplying a PayWay transaction ID and the refund amount.
+
+```python
+refund, errors = client.refund_transaction(
+    transaction_id=transaction.transaction_id,
+    amount=transaction.principal_amount,
+)
+```
+
+## Voiding a transaction
+
+Void a transaction by supplying a PayWay transaction ID.
+
+```python
+void_transaction, errors = client.void_transaction(transaction.transaction_id)
+```
+
+## Update Payment Setup
+
+Update a customer's payment setup with a new credit card or bank account in PayWay. Supply the new token and an existing PayWay customer number.
+
+```python
+payment_setup, errors = client.update_payment_setup(new_token, payway_customer.customer_number)
+```
+
+## Additional notes
+
+PayWay API documentation <https://www.payway.com.au/docs/rest.html>
+
+It is recommended to use PayWay's Trusted Frame <https://www.payway.com.au/docs/rest.html#trusted-frame>
+when creating a single use token of a card or bank account so your PCI-compliance scope is reduced.  
+
+## Fraud
+
+Please follow PayWay's advice about reducing your risk of fraudulent transactions. <https://www.payway.com.au/docs/card-testing.html#card-testing>
+
+## Running the project
+
+```bash
+uv python install 3.8.19
+uv venv
+source .venv/bin/activate
+uv sync --extra dev
+```
+
+## Testing
+
+```bash
+python -m unittest discover tests
+```

{python-payway-0.0.2 → python_payway-0.0.4}/README.md

@@ -1,4 +1,4 @@
-# `PayWay REST API - Python`
+# PayWay REST API - Python
 
 - Store customers, their card and bank account in PayWay
 - Take payment using a stored credit card or bank account
@@ -8,29 +8,28 @@
 - Void transactions
 - Update a customer's payment setup in PayWay
 
-# `Install`
+## Install
 
-```
+```bash
 pip install python-payway
 ```
 
-# `Take payment using a stored credit card`
+## Take payment using a stored credit card
 
 Create a Client class with your PayWay API credentials
 
-```
-from payway.model import *
-from payway.client import *
+```python
+from payway.client import Client
 
-client = Client(merchant_id='',
-                bank_account_id='',
-                publishable_api_key='',
-                secret_api_key='')
+client = Client(merchant_id='<your_payway_merchant_id>',
+                bank_account_id='<your_payway_bank_account_id>',
+                publishable_api_key='<your_payway_publishable_api_key>',
+                secret_api_key='<your_payway_secret_api_key>')
 ```
-                 
+
 Create a PayWayCustomer class with your customer's details
 
-```
+```python
 customer = PayWayCustomer(custom_id='c981a',
                           customer_name='John Smith',
                           email_address='johnsmith@example.com',
@@ -42,10 +41,10 @@ customer = PayWayCustomer(custom_id='c981a',
                           state='NSW',
                           postal_code='2000')
 ```
-        
+
 Create a PayWayCard class with your customer's card details
 
-```
+```python
 card = PayWayCard(card_number='',
                   cvn='',
                   card_holder_name='',
@@ -55,7 +54,7 @@ card = PayWayCard(card_number='',
 
 Create a token from your card and create a customer in PayWay
 
-```
+```python
 token_response, errors = client.create_card_token(card)
 token = token_response.token        
 customer.token = token
@@ -63,10 +62,10 @@ payway_customer, customer_errors = client.create_customer(customer)
 ```
 
 Note the 'payway_customer' object contains the full customer response fields from PayWay.
-        
+
 Create a Payment class with the payment details and process the transaction
 
-```
+```python
 customer_number = payway_customer.customer_number
 payment = PayWayPayment(customer_number=customer_number,
                         transaction_type='payment',
@@ -75,18 +74,18 @@ payment = PayWayPayment(customer_number=customer_number,
                         order_number='',
                         ip_address='')
 transaction, errors = client.process_payment(payment)
-```    
-                                 
+```
+
 Check the `transaction` for the result
 
-```
+```python
 if not errors and transaction.status == 'approved':
     # process successful response
 ```
 
-# `Take payment using a credit card token only`
+## Take payment using a credit card token only
 
-```
+```python
 client = Client(merchant_id='',
                 bank_account_id='',
                 publishable_api_key='',
@@ -110,12 +109,12 @@ payment = PayWayPayment(customer_number=customer_number,
 transaction, errors = client.process_payment(payment)
 ```
 
-# `Handling errors`
+## Handling errors
 
 Documented errors (such as 422 Unprocessable entity) are parsed into an PaymentError class that you can use in an customer error message.
-https://www.payway.com.au/docs/rest.html#http-response-codes
+For more info, visit <https://www.payway.com.au/docs/rest.html#http-response-codes>
 
-```
+```python
 if errors:
     for error in errors: 
         print(error.field_name)
@@ -123,12 +122,13 @@ if errors:
         print(error.field_name)
     # or use a method
     PaymentError().list_to_message(errors) 
-```     
+```
+
+## Direct Debit
 
-# `Direct Debit`
 Direct debit transactions are possible by creating a token from a bank account:
 
-```
+```python
 bank_account = BankAccount(account_name='Test', bsb='000-000', account_number=123456)
 token_response, errors = client.create_bank_account_token(bank_account)
 token = token_response.token
@@ -138,19 +138,19 @@ Store the token with a customer in PayWay using the same process as the card out
 
 Note: direct debit transactions take days to process so they must be polled regularly for the latest transaction status from the customer's bank.
 
-# `Lookup transaction`
+## Lookup transaction
 
 Poll a transaction using the `get_transaction` method.
 
-```
+```python
 transaction, errors = client.get_transaction(transaction.transaction_id)
-``` 
+```
 
-# `Process and capture a pre-authorisation`
+## Process and capture a pre-authorisation
 
 To process a credit card pre-authorisation using a credit card stored against a customer use `preAuth` as the `transaction_type` along with the customer's PayWay number, amount and currency.
 
-```
+```python
 pre_auth_payment = PayWayPayment(customer_number='',
                                  transaction_type='preAuth',
                                  amount='',
@@ -162,7 +162,7 @@ transaction, errors = client.process_payment(pre_auth_payment)
 
 To capture the pre-authorisation supply a pre-authorisation transaction ID,  `capture` as the `transaction_type` along with an amount to capture.
 
-```
+```python
 capture_payment = PayWayPayment(transaction_type='capture',
                                 parent_transaction_id='',
                                 amount='',
@@ -171,50 +171,55 @@ capture_payment = PayWayPayment(transaction_type='capture',
 transaction, errors = client.process_payment(capture_payment)
 ```
 
-# `Refunds`
+## Refunds
 
 Refund a transaction by supplying a PayWay transaction ID and the refund amount.
 
-```
+```python
 refund, errors = client.refund_transaction(
     transaction_id=transaction.transaction_id,
     amount=transaction.principal_amount,
 )
 ```
 
-# `Voiding a transaction`
+## Voiding a transaction
 
 Void a transaction by supplying a PayWay transaction ID.
 
-```
+```python
 void_transaction, errors = client.void_transaction(transaction.transaction_id)
 ```
 
-# `Update Payment Setup`
+## Update Payment Setup
 
 Update a customer's payment setup with a new credit card or bank account in PayWay. Supply the new token and an existing PayWay customer number.
 
-```
+```python
 payment_setup, errors = client.update_payment_setup(new_token, payway_customer.customer_number)
 ```
 
-# `Additional notes`                             
-PayWay API documentation
-https://www.payway.com.au/docs/rest.html
+## Additional notes
+
+PayWay API documentation <https://www.payway.com.au/docs/rest.html>
 
-It is recommended to use PayWay's Trusted Frame https://www.payway.com.au/docs/rest.html#trusted-frame
+It is recommended to use PayWay's Trusted Frame <https://www.payway.com.au/docs/rest.html#trusted-frame>
 when creating a single use token of a card or bank account so your PCI-compliance scope is reduced.  
 
-# `Fraud`
+## Fraud
 
-Please follow PayWay's advice about reducing your risk of fraudulent transactions.
-https://www.payway.com.au/docs/card-testing.html#card-testing
+Please follow PayWay's advice about reducing your risk of fraudulent transactions. <https://www.payway.com.au/docs/card-testing.html#card-testing>
 
-# `Testing`
+## Running the project
 
-1. Sign up for a PayWay sandbox account: https://www.payway.com.au/sandbox
-2. Test the integration by adding your PayWay REST API keys to your local environment. These keys are in Account Settings > `REST API Keys`. Copy your `Publishable` and `Secret` API keys.
-3. `export PAYWAY_PUBLISHABLE_API_KEY="your PayWay Publishable API Key"`
-4. `export PAYWAY_SECRET_API_KEY="your PayWay Secret API Key"`
-5. Run the tests to ensure the integration is working. 
-`python -m unittest discover tests`
+```bash
+uv python install 3.8.19
+uv venv
+source .venv/bin/activate
+uv sync --extra dev
+```
+
+## Testing
+
+```bash
+python -m unittest discover tests
+```