Changes generated by b32716e8dc0be2381602a8faf94f5586b2197c32

This commit was automatically created from gocardless/gocardless-pro-python-template@b32716e
by the `push-files` action.

Workflow run: https://github.com/gocardless/gocardless-pro-python-template/actions/runs/20171862075

Author: gocardless-ci-robot[bot]

README.rst

@@ -574,6 +574,17 @@ Payments
     # Retry a payment
     client.payments.retry('PM123', params={...})
 
+Payment accounts
+''''''''''''''''''''''''''''''''''''''''''
+
+.. code:: python
+
+    # List payment accounts
+    client.payment_accounts.list(params={...})
+
+    # Iterate through all payment_accounts
+    client.payment_accounts.all(params={...})
+
 Payment account transactions
 ''''''''''''''''''''''''''''''''''''''''''
 

gocardless_pro/client.py

@@ -157,6 +157,10 @@ def payer_themes(self):
     def payments(self):
         return services.PaymentsService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)
 
+    @property
+    def payment_accounts(self):
+        return services.PaymentAccountsService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)
+
     @property
     def payment_account_transactions(self):
         return services.PaymentAccountTransactionsService(self._api_client, 3, 0.5, self._raise_on_idempotency_conflict)

gocardless_pro/resources/__init__.py

@@ -63,6 +63,8 @@
 
 from .payment import Payment
 
+from .payment_account import PaymentAccount
+
 from .payment_account_transaction import PaymentAccountTransaction
 
 from .payout import Payout

gocardless_pro/resources/payment_account.py

@@ -0,0 +1,79 @@
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+
+class PaymentAccount(object):
+    """A thin wrapper around a payment_account, providing easy access to its
+    attributes.
+
+    Example:
+      payment_account = client.payment_accounts.get()
+      payment_account.id
+    """
+
+    def __init__(self, attributes, api_response):
+        self.attributes = attributes
+        self.api_response = api_response
+
+    @property
+    def account_balance(self):
+        return self.attributes.get('account_balance')
+  
+
+    @property
+    def account_holder_name(self):
+        return self.attributes.get('account_holder_name')
+  
+
+    @property
+    def account_number_ending(self):
+        return self.attributes.get('account_number_ending')
+  
+
+    @property
+    def bank_name(self):
+        return self.attributes.get('bank_name')
+  
+
+    @property
+    def currency(self):
+        return self.attributes.get('currency')
+  
+
+    @property
+    def id(self):
+        return self.attributes.get('id')
+  
+
+    @property
+    def links(self):
+        return self.Links(self.attributes.get('links'))
+  
+
+
+  
+
+  
+
+  
+
+  
+
+  
+
+  
+
+  
+    class Links(object):
+        """Wrapper for the response's 'links' attribute."""
+
+        def __init__(self, attributes):
+            self.attributes = attributes
+    
+        @property
+        def creditor(self):
+            return self.attributes.get('creditor')
+    
+  
+

gocardless_pro/services/__init__.py

@@ -33,6 +33,7 @@
 from .payer_authorisations_service import PayerAuthorisationsService
 from .payer_themes_service import PayerThemesService
 from .payments_service import PaymentsService
+from .payment_accounts_service import PaymentAccountsService
 from .payment_account_transactions_service import PaymentAccountTransactionsService
 from .payouts_service import PayoutsService
 from .payout_items_service import PayoutItemsService

gocardless_pro/services/payment_accounts_service.py

@@ -0,0 +1,45 @@
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+
+from . import base_service
+from .. import resources
+from ..paginator import Paginator
+from .. import errors
+
+class PaymentAccountsService(base_service.BaseService):
+    """Service class that provides access to the payment_accounts
+    endpoints of the GoCardless Pro API.
+    """
+
+    RESOURCE_CLASS = resources.PaymentAccount
+    RESOURCE_NAME = 'payment_accounts'
+
+
+    def list(self,params=None, headers=None):
+        """List payment accounts.
+
+        Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
+        payment accounts.
+
+        Args:
+              params (dict, optional): Query string parameters.
+
+        Returns:
+              ListResponse of PaymentAccount instances
+        """
+        path = '/payment_accounts'
+        
+
+        response = self._perform_request('GET', path, params, headers,
+                                         retry_failures=True)
+        return self._resource_for(response)
+
+    def all(self,params=None):
+        if params is None:
+            params = {}
+        return Paginator(self, params, identity_params={
+          })
+    
+  

tests/client_test.py

@@ -107,6 +107,9 @@ def test_payer_themes_returns_service():
 def test_payments_returns_service():
     assert isinstance(client.payments, services.PaymentsService)
 
+def test_payment_accounts_returns_service():
+    assert isinstance(client.payment_accounts, services.PaymentAccountsService)
+
 def test_payment_account_transactions_returns_service():
     assert isinstance(client.payment_account_transactions, services.PaymentAccountTransactionsService)
 

tests/fixtures/billing_request_with_actions.json

@@ -5,6 +5,6 @@
     "method": "POST",
     "path_template": "/billing_requests/create_with_actions",
     "url_params": [],
-    "body": {"billing_request_with_actions":{"bank_authorisations":{"authorisation_type":"example authorisation_type 102","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2024-01-15T10:00:00.000Z","expires_at":"2024-01-15T10:00:00.000Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"qr_code_url":"https://pay.gocardless.com/obauth/BAU123/qr_code","redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"},"billing_requests":{"actions":[{"available_currencies":["GBP"],"bank_authorisation":{"adapter":"example adapter 101","authorisation_type":"example authorisation_type 101"},"collect_customer_details":{"default_country_code":"example default_country_code 101","incomplete_fields":{"customer":["example customer 101"],"customer_billing_detail":["example customer_billing_detail 101"]}},"completes_actions":["collect_bank_account"],"institution_guess_status":"pending","required":true,"requires_actions":["collect_bank_account"],"status":"pending","type":"collect_bank_account"}],"created_at":"2015-01-01T12:00:00.000Z","fallback_enabled":false,"fallback_occurred":false,"id":"BRQ123","instalment_schedule_request":{"app_fee":100,"currency":"USD","instalments_with_dates":[{"amount":250,"charge_date":"2020-11-03"}],"instalments_with_schedule":{"amounts":[1000],"interval":1,"interval_unit":"monthly","start_date":"2014-10-21"},"links":{"instalment_schedule":"example instalment_schedule 101"},"metadata":{},"name":"Invoice 4404","payment_reference":"GOLDPLAN","retry_if_possible":true,"total_amount":1000},"links":{"bank_authorisation":"example bank_authorisation 101","creditor":"CR123","customer":"CU123","customer_bank_account":"BA123","customer_billing_detail":"example customer_billing_detail 102","instalment_schedule_request":"ISR123","instalment_schedule_request_instalment_schedule":"IS123","mandate_request":"MRQ123","mandate_request_mandate":"MD123","organisation":"OR123","payment_provider":"PP123","payment_request":"PRQ123","payment_request_payment":"PM123","subscription_request":"SBR123","subscription_request_subscription":"SB123"},"mandate_request":{"authorisation_source":"telephone","consent_type":"example consent_type 101","constraints":{"end_date":"example end_date 101","max_amount_per_payment":101,"payment_method":"example payment_method 101","periodic_limits":[{"alignment":"creation_date","max_payments":101,"max_total_amount":101,"period":"week"}],"start_date":"example start_date 101"},"currency":"GBP","description":"Top-up Payment","funds_settlement":"direct","links":{"mandate":"example mandate 101"},"metadata":{},"payer_requested_dual_signature":false,"scheme":"bacs","sweeping":false,"verify":"recommended"},"metadata":{},"payment_request":{"amount":1000,"app_fee":100,"currency":"GBP","description":"Top-up Payment","funds_settlement":"managed","links":{"payment":"example payment 101"},"metadata":{},"reference":"some-custom-ref","scheme":"faster_payments"},"purpose_code":"utility","resources":{"customer":{"company_name":"Hamilton Trading Ltd.","created_at":"2014-01-01T12:00:00.000Z","email":"[email protected]","family_name":"Osborne","given_name":"Frank","id":"CU123","language":"en","metadata":{},"phone_number":"+64 4 817 9999"},"customer_bank_account":{"account_holder_name":"Billie Jean","account_number_ending":"1234","account_type":"savings","bank_account_token":"bat_f975ab3c-ecee-47a1-9590-5bb1d56fa113","bank_name":"BARCLAYS BANK PLC","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","currency":"EUR","enabled":true,"id":"BA123","links":{"customer":"example customer 102"},"metadata":{}},"customer_billing_detail":{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","danish_identity_number":"220550-6218","id":"CU123","ip_address":"127.0.0.1","postal_code":"NW1 6XE","region":"Greater London","schemes":["example schemes 101"],"swedish_identity_number":"556564-5404"}},"status":"pending","subscription_request":{"amount":1000,"app_fee":100,"count":5,"currency":"USD","day_of_month":28,"interval":1,"interval_unit":"monthly","links":{"subscription":"example subscription 101"},"metadata":{},"month":"january","name":"12 month subscription","payment_reference":"GOLDPLAN","retry_if_possible":false,"start_date":"2014-10-21"}}}}
+    "body": {"billing_request_with_actions":{"bank_authorisations":{"authorisation_type":"example authorisation_type 102","authorised_at":"2020-01-01T12:00:00.000Z","created_at":"2024-01-15T10:00:00.000Z","expires_at":"2024-01-15T10:00:00.000Z","id":"BAU123","last_visited_at":"2020-01-01T12:00:00.000Z","links":{"billing_request":"BRQ123","institution":"monzo"},"qr_code_url":"https://pay.gocardless.com/obauth/BAU123/qr_code","redirect_uri":"https://my-website.com/abc/callback","url":"https://pay.gocardless.com/obauth/BAU123"},"billing_requests":{"actions":[{"available_currencies":["GBP"],"bank_authorisation":{"adapter":"example adapter 101","authorisation_type":"example authorisation_type 101"},"collect_customer_details":{"default_country_code":"example default_country_code 101","incomplete_fields":{"customer":["example customer 102"],"customer_billing_detail":["example customer_billing_detail 102"]}},"completes_actions":["collect_bank_account"],"institution_guess_status":"pending","required":true,"requires_actions":["collect_bank_account"],"status":"pending","type":"collect_bank_account"}],"created_at":"2015-01-01T12:00:00.000Z","fallback_enabled":false,"fallback_occurred":false,"id":"BRQ123","instalment_schedule_request":{"app_fee":100,"currency":"USD","instalments_with_dates":[{"amount":250,"charge_date":"2020-11-03"}],"instalments_with_schedule":{"amounts":[1000],"interval":1,"interval_unit":"monthly","start_date":"2014-10-21"},"links":{"instalment_schedule":"example instalment_schedule 101"},"metadata":{},"name":"Invoice 4404","payment_reference":"GOLDPLAN","retry_if_possible":true,"total_amount":1000},"links":{"bank_authorisation":"example bank_authorisation 101","creditor":"CR123","customer":"CU123","customer_bank_account":"BA123","customer_billing_detail":"example customer_billing_detail 101","instalment_schedule_request":"ISR123","instalment_schedule_request_instalment_schedule":"IS123","mandate_request":"MRQ123","mandate_request_mandate":"MD123","organisation":"OR123","payment_provider":"PP123","payment_request":"PRQ123","payment_request_payment":"PM123","subscription_request":"SBR123","subscription_request_subscription":"SB123"},"mandate_request":{"authorisation_source":"telephone","consent_type":"example consent_type 101","constraints":{"end_date":"example end_date 101","max_amount_per_payment":101,"payment_method":"example payment_method 101","periodic_limits":[{"alignment":"creation_date","max_payments":101,"max_total_amount":101,"period":"week"}],"start_date":"example start_date 101"},"currency":"GBP","description":"Top-up Payment","funds_settlement":"direct","links":{"mandate":"example mandate 101"},"metadata":{},"payer_requested_dual_signature":false,"scheme":"bacs","sweeping":false,"verify":"recommended"},"metadata":{},"payment_request":{"amount":1000,"app_fee":100,"currency":"GBP","description":"Top-up Payment","funds_settlement":"managed","links":{"payment":"example payment 101"},"metadata":{},"reference":"some-custom-ref","scheme":"faster_payments"},"purpose_code":"utility","resources":{"customer":{"company_name":"Hamilton Trading Ltd.","created_at":"2014-01-01T12:00:00.000Z","email":"[email protected]","family_name":"Osborne","given_name":"Frank","id":"CU123","language":"en","metadata":{},"phone_number":"+64 4 817 9999"},"customer_bank_account":{"account_holder_name":"Billie Jean","account_number_ending":"1234","account_type":"savings","bank_account_token":"bat_f975ab3c-ecee-47a1-9590-5bb1d56fa113","bank_name":"BARCLAYS BANK PLC","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","currency":"EUR","enabled":true,"id":"BA123","links":{"customer":"example customer 101"},"metadata":{}},"customer_billing_detail":{"address_line1":"221B Baker Street","address_line2":"Marylebone","address_line3":"City of Westminster","city":"London","country_code":"GB","created_at":"2014-01-01T12:00:00.000Z","danish_identity_number":"220550-6218","id":"CU123","ip_address":"127.0.0.1","postal_code":"NW1 6XE","region":"Greater London","schemes":["example schemes 101"],"swedish_identity_number":"556564-5404"}},"status":"pending","subscription_request":{"amount":1000,"app_fee":100,"count":5,"currency":"USD","day_of_month":28,"interval":1,"interval_unit":"monthly","links":{"subscription":"example subscription 101"},"metadata":{},"month":"january","name":"12 month subscription","payment_reference":"GOLDPLAN","retry_if_possible":false,"start_date":"2014-10-21"}}}}
   }
 }