Skip to main content
Version: Tryton 8.0 (LTS)

account_payment_braintree

Tryton 8.0 · Reference generated from the official source code

This page combines editorial guidance with evidence extracted from the selected official branch. Always test the flow with your own permissions and configuration.

Purpose​

The Account Payment Braintree Module allows receiving payments using Braintree. It uses the Drop-in UI in a checkout form to handle the payment method nonce_ for card and other supported payment methods.

The analysis found 8 Python files, 14 XML files, 11 views, 19 actions, 3 menus, and 1 reports.

Functional user guide

Who should use it​

This module is relevant to people responsible for account payment braintree processes, company configuration, and result review. Administrators should participate whenever dependencies, permissions, or sequences are introduced.

What you will be able to do​

After configuration, you will be able to identify the records added by account_payment_braintree, execute actions in the correct state, produce its reports, and understand the information shared with other modules.

Requirements and preparation​

Before activation, verify company, currency, users, and groups. Install and configure required dependencies first. When real data exists, rehearse activation and upgrades on a restored copy.

Activate dependencies first, review company configuration, and rehearse the complete workflow before production use.

Required dependencies​

  • account — must be installed and configured before testing this module.
  • account_payment — must be installed and configured before testing this module.
  • currency — must be installed and configured before testing this module.
  • ir — must be installed and configured before testing this module.
  • party — must be installed and configured before testing this module.

Optional integrations​

  • —
  • Activate the module and sign in again to load menus and permissions.
  • Review new company configuration options and defaults.
  • Assign groups to test users using least privilege.
  • Create small, verifiable master data before bulk imports.
  • Run one complete scenario from draft to final state and inspect related records.

Module objects and concepts​

  • account.payment: groups 10 model(s), including account.payment, account.payment.braintree.account, account.payment.braintree.checkout, account.payment.braintree.customer, account.payment.braintree.customer.identical. These records form the information users inspect or modify during the process.
  • ir.cron: groups 1 model(s), including ir.cron. These records form the information users inspect or modify during the process.
  • party.party: groups 2 model(s), including party.party, party.party.reception_direct_debit. These records form the information users inspect or modify during the process.
  • party.replace: groups 1 model(s), including party.replace. These records form the information users inspect or modify during the process.

Typical workflow​

  1. Select the correct company and date before creating a document.
  2. Complete master data before lines or details.
  3. Use form buttons for state changes; saving is not the same as validating or posting.
  4. Review warnings, totals, related documents, and traceability.
  5. Generate the report and compare it with the record before delivery.

Actions, states, and wizards​

  • approve — action or transition that starts approve. Check permissions, current state, and related records before running it.
  • braintree_checkout — action or transition that starts braintree checkout. Check permissions, current state, and related records before running it.
  • braintree_do_pull — action or transition that starts braintree do pull. Check permissions, current state, and related records before running it.
  • braintree_do_settle_payment — action or transition that starts braintree do settle payment. Check permissions, current state, and related records before running it.
  • braintree_update — action or transition that starts braintree update. Check permissions, current state, and related records before running it.
  • delete_payment_method — action or transition that starts delete payment method. Check permissions, current state, and related records before running it.
  • draft — action or transition that starts draft. Check permissions, current state, and related records before running it.
  • new_identifier — action or transition that starts new identifier. Check permissions, current state, and related records before running it.
  • submit — action or transition that starts submit. Check permissions, current state, and related records before running it.
  • approved — action or transition that starts approved. Check permissions, current state, and related records before running it.
  • failed — action or transition that starts failed. Check permissions, current state, and related records before running it.
  • processing — action or transition that starts processing. Check permissions, current state, and related records before running it.
  • submitted — action or transition that starts submitted. Check permissions, current state, and related records before running it.
  • succeeded — action or transition that starts succeeded. Check permissions, current state, and related records before running it.
  • account.payment.braintree.customer.payment_method.delete — wizard that collects data and performs account › payment › braintree › customer › payment method › delete. Check permissions, current state, and related records before running it.

Controls before production​

  • Define who creates, reviews, confirms, cancels, and reads.
  • Test closed periods, unauthorized users, and incomplete data.
  • Verify numbering, currency, rounding, and time zone where applicable.
  • Document error correction without direct database edits.
  • Include its tables and files in backup and restore procedures.

Troubleshooting​

  • If a menu is missing, verify activation, module-list update, groups, and a new login session.
  • If a field rejects a value, inspect its domain, company, state, and configured dependencies.
  • If a button is hidden or disabled, check permissions and valid transitions; never change state with SQL.
  • If results differ, reproduce a minimal case and compare related records before and after.
  • Keep the full traceback, version, active modules, and minimal data needed to diagnose an error.

Developer guide

Architecture and extension points​

The package contains 17 Python classes and declares or extends 14 models. It uses Boolean, Char, Function, Many2Many, Many2One, One2Many, Selection, Text. Developers should first determine whether a class creates a model or uses PoolMeta to extend one, preserve super() calls, and avoid duplicating dependency rules.

Registered or extended models​

  • account.payment
  • account.payment.braintree.account
  • account.payment.braintree.checkout
  • account.payment.braintree.customer
  • account.payment.braintree.customer.identical
  • account.payment.braintree.customer.payment_method.delete
  • account.payment.braintree.customer.payment_method.delete.ask
  • account.payment.braintree.refund
  • account.payment.group
  • account.payment.journal
  • ir.cron
  • party.party
  • party.party.reception_direct_debit
  • party.replace

Field types used​

  • Boolean
  • Char
  • Function
  • Many2Many
  • Many2One
  • One2Many
  • Selection
  • Text

Detected classes and public methods​

Classes: BraintreeAccountWarning, BraintreeCustomerMethodMixin, CheckoutMixin, Cron, Party, PartyReceptionDirectDebit, Payment, PaymentBraintreeAccount, PaymentBraintreeCheckoutPage, PaymentBraintreeCustomer, PaymentBraintreeCustomerIdentical, PaymentBraintreeCustomerPaymentMethodDelete, PaymentBraintreeCustomerPaymentMethodDeleteAsk, PaymentBraintreeRefund, PaymentGroup, PaymentJournal, Replace

Methods: approve(), braintree_checkout(), braintree_checkout_url(), braintree_create(), braintree_delete(), braintree_do_pull(), braintree_do_settle_payment(), braintree_pull(), braintree_refund(), braintree_set_nonce(), braintree_settle_payment_(), braintree_transact(), braintree_update(), check_braintree_journal(), check_modification(), configuration(), copy(), default_ask(), default_braintree_payment_settled(), default_braintree_settle_payment(), default_environment(), default_sandbox_settle_transaction(), default_state(), delete(), delete_payment_method(), delete_payment_method_(), draft(), fail(), fields_to_replace(), find(), gateway(), get_braintree_customer_method(), get_braintree_customer_methods(), get_braintree_settlement_needed(), get_payment_methods(), get_rec_name(), new_identifier(), on_change_braintree_customer_method_selection(), on_change_party(), on_change_with_braintree_account(), on_change_with_company(), on_change_with_currency(), on_change_with_webhook_endpoint(), on_write(), payment_methods(), process(), process_braintree(), set_braintree_customer_method(), submit(), succeed(), table_query(), transition_delete_(), validate_fields(), view_attributes(), webhook(), webhook_dispute(), webhook_transaction()

Code map​

Detected 8 Python files, 14 XML files, and 0 explicit access files. XML connects models to views, menus, actions, and reports; access CSV files establish initial permissions.

  • __init__.py
  • account.py
  • account.xml
  • common.py
  • doc/conf.py
  • exceptions.py
  • ir.py
  • message.xml
  • party.py
  • party.xml
  • routes.py
  • view/account_form.xml
  • view/account_list.xml
  • view/customer_form.xml
  • view/customer_list.xml
  • view/customer_payment_method_delete_ask_form.xml
  • view/party_reception_direct_debit_form.xml
  • view/payment_form.xml
  • view/payment_journal_form.xml
  • view/payment_list.xml
  • view/refund_form.xml
  • view/refund_list.xml

Test plan​

  • Activation on an empty database and upgrade from the previous revision.
  • Create, update, copy, and delete according to state and access rights.
  • Every button, transition, and wizard with valid and invalid scenarios.
  • Applicable multi-company rules, translations, time zones, and currencies.
  • Combined installation with required and optional dependencies.
  • Backup and restore of records, attachments, and generated reports.

Compatibility and upgrades​

Keep server and modules on series 8.0. Before upgrading, compare tryton.cfg, __register__ migrations, state changes, XML IDs, and permissions. A successful build does not replace a rehearsed migration or functional data reconciliation.

Official documentation evidence​

Topics found: Configuration · payment_methods_cache · Design · Payment · Braintree Payment Refund · Payment Journal · Braintree Account · Braintree Customer · Braintree Checkout · Account Payment Braintree Module · API Reference · Braintree Webhook · Setup · Configure Braintree credentials

    • doc/configuration.rst: The Account Payment Braintree Module uses values from settings in the [account_payment_braintree] section of the
    • doc/design.rst: The Account Payment Braintree Module introduces and extends the following concepts:
    • doc/index.rst: The Account Payment Braintree Module allows receiving payments using Braintree. It uses the Drop-in UI in a checkout form to handle the payment method nonce_ for card and other supported payment methods.
    • doc/reference.rst: The Account Payment Braintree Module defines a route to checkout a Payment <model-account.payment> or a Braintree Customer <model-account.payment.braintree.customer>:
    • doc/setup.rst: First you must register with Braintree <https://www.braintreegateway.com/login>_ and get the API credentials <https://developer.paypal.com/braintree/articles/control-panel/important-gateway-credentials>_.

View source code