Package: berbix
Berbix Python SDKThis Berbix Python library provides simple interfaces to interact with the Berbix API.Installationpip install berbixUsageConstructing a clientimport berbix

client = berbix.Client(
  api_secret='your_api_secret_here')Create a transactiontransaction_tokens = client.create_transaction(
  customer_uid="interal_customer_uid", # ID for the user in internal database
  template_key="your_template_key", # Template key for this transaction
)Create tokens from refresh tokenrefresh_token = '' # fetched from database
transaction_tokens = Tokens.from_refresh(refresh_token)Fetch transaction datatransaction_data = client.fetch_transaction(transaction_tokens)ReferenceClientMethodsconstructor(options)Supported options:api_secret(required) - The API secret that can be found in your Berbix Dashboard.http_client- An optional override for the default HTTP client.create_transaction(options): TokensCreates a transaction within Berbix to initialize the client SDK. Typically after creating
a transaction, you will want to store the refresh token in your database associated with the
currently active user session.Supported options:email- Previously verified email address for a user.phone- Previously verified phone number for a user.customer_uid- An ID or identifier for the user in your system.template_key- The template key for this transaction.Deprecated:hosted_options- Optional configuration object for creating hosted transactions. Thehosted_optionsobject can optionally include the following fields:completion_email- Email address to which completion alerts will be sent for this transaction.redirect_url- URL to redirect the user to after they complete the transaction. If not specified, the URL specified in the Berbix dashboard will be used instead.create_hosted_transaction(options): HostedTransactionResponseCreates a hosted transaction within Berbix to initialize the client SDK. This works the same as create_transaction excepthosted_optionsis a valid parameter and that it returns an explicithosted_urlfor hosted transactions.Supported options:email- Previously verified email address for a user.phone- Previously verified phone number for a user.customer_uid- An ID or identifier for the user in your system.template_key- The template key for this transaction.hosted_options- Optional configuration object for creating hosted transactions. Thehosted_optionsobject can optionally include the following fields:completion_email- Email address to which completion alerts will be sent for this transaction.redirect_url- URL to redirect the user to after they complete the transaction. If not specified, the URL specified in the Berbix dashboard will be used instead.fetch_transaction(tokens: Tokens): objectFetches all of the information associated with the transaction. If the user has already completed the steps of the transaction, then this will include all of the elements of the transaction payload as described on theBerbix developer docs.refresh_tokens(tokens: Tokens): TokensThis is typically not needed to be called explicitly as it will be called by the higher-level
SDK methods, but can be used to get fresh client or access tokens.validate_signature(secret: string, body: string, header: string): booleanThis method validates that the content of the webhook has not been forged. This should be called for every endpoint that is configured to receive a webhook from Berbix.Parameters:secret- This is the secret associated with that webhook. NOTE: This is distinct from the API secret and can be found on the webhook configuration page of the dashboard.body- The full request body from the webhook. This should take the raw request body prior to parsing.header- The value in the 'X-Berbix-Signature' header.delete_transaction(tokens: Tokens): voidPermanently deletes all submitted data associated with the transaction corresponding to the tokens provided.update_transaction(tokens: Tokens, ...parameters): objectChanges a transaction's "action", for example upon review in your systems. Returns the updated transaction upon success.Parameters:action: string- A string describing the action taken on the transaction. Typically this will either be "accept" or "reject".note: string- A string containing an optional note explaining the action taken.override_transaction(tokens: Tokens, ...parameters): voidCompletes a previously created transaction, and overrides its return payload and flags to match the provided parameters.Parameters:response_payload: string- A string describing the payload type to return when fetching transaction metadata, e.g. "us-dl". Seeour testing guidefor possible options.flags: string[]- An optional list of flags to associate with the transaction (independent of the payload's contents), e.g. ["id_under_18", "id_under_21"]. Seeour flags documentationfor a list of flags.override_fields: { string: string }- An optional mapping from atransaction fieldto the desired override value, e.g.override_fields={"date_of_birth": "2000-12-09"}}TokensPropertiesaccess_token: stringThis is the short-lived bearer token that the backend SDK uses to identify requests associated with a given transaction. This is not typically needed when using the higher-level SDK methods.client_token: stringThis is the short-lived token that the frontend SDK uses to identify requests associated with a given transaction. After transaction creation, this will typically be sent to a frontend SDK.refresh_token: stringThis is the long-lived token that allows you to create new tokens after the short-lived tokens have expired. This is typically stored in the database associated with the given user session.transaction_id: numberThe internal Berbix ID number associated with the transaction.expiry: DateThe time at which the access and client tokens will expire.response: objectThe raw response object. This may include some non-token related fields.Deprecated:hosted_url: stringThis is a member of the response object. Represents the hosted transaction URL. This value will only be set when creating a transaction if thehosted_optionsfield is set.Static methodsfrom_refresh(refreshToken: string): TokensCreates a tokens object from a refresh token, which can be passed to higher-level SDK methods. The SDK will handle refreshing the tokens for accessing relevant data.HostedTransactionResponsePropertiestokens: TokensThis is the tokens object for future SDK calls.hosted_url: stringThis is a member of the response object. Represents the hosted transaction URL.PublishingTo release a new version of the SDK, first bump the version in `setup.py`.

python setup.py sdist bdist_wheel
twine upload dist/*