vendor-zahra 1.1.1

No project description provided

Getting Started with Form3 Public API

Install the Package

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install vendor-zahra==1.1.1

You can also view the package at: https://pypi.python.org/pypi/vendor-zahra/1.1.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
http_client_instance	HttpClient	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
basic_credentials	BasicCredentials	The credential object for Basic Authentication
o_auth_2_credentials	OAuth2Credentials	The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

client = Form3publicapiClient(
    basic_credentials=BasicCredentials(
        username='Username',
        password='Password'
    ),
    o_auth_2_credentials=OAuth2Credentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret'
    ),
    environment=Environment.PRODUCTION
)

Authorization

This API uses the following authentication schemes.

• Basic (Basic Authentication)
• OAuth2 (OAuth 2 Client Credentials Grant)

List of APIs

• Scheme File API
• Transaction File API
• Metrics API
• Name Verification API
• O Auth Authorization
• Audit
• Reports
• Scheme Messages
• Subscriptions
• Oauth 2
• Accounts
• Account Identification
• Branches
• Branch Identification
• Payments
• Organisations
• Platformsecurityapi
• Roles
• ACE
• Users
• Claims
• Direct Debits
• Mandates
• Query Api
• Account Validation

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest