Skip to main content

Beta License: AGPL-3 shopinvader/odoo-shopinvader-payment

Base module for Shopinvader payment services. It defines the provider-independent routers.

Table of contents

Usage

This addon is the core of the new Shopinvader API Payment addons suite. It defines basic services, which will be extended in two axes.

  • The first axe concerns the payable object. Here the methods should work with any abstract payable object (sale order, account invoice, …) but specific logic must be implemented in related addons (see shopinvader_api_payment_cart to pay sale orders for eg.)

  • The second axe concerns the payment provider. The idea is to develop one addon for each payment provider. Some of them are already available, see shopinvader_api_payment_sips, shopinvader_api_payment_stripe, shopinvader_api_payment_custom. In these addons we add the necessary logic to redirect to the payment provider payment website, the return url …

All payment routes are public. We must thus encode all sensitive info. The Payable object achieves this. In each service we ensure that the payable wasn’t tampered.

Concrete Usage

The idea to use this suite of addons is the following. Assume you have a valid payable (see addons of the first axe on how to get them, for eg. shopinvader_api_payment_cart on how to get the payable of the current cart).

1. Get all providers that are allowed to pay your payable object. You just need to call the GET route /payment/methods with your payable for this.

2. Once you chose the payment method you want to use, create the payment transaction calling the POST route /payment/transactions with your payable + some additional input info (the chosen provider, the frontend redirect url…). See the associated TransactionCreate Pydantic schema.

3. The following (and last) step depends on the chosen provider. See more info into the dedicated Shopinvader API payment addon. However, the idea is often the same: a redirect_form_html is returned and you should submit this HTML form to call the provider services.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • ACSONE SA/NV

  • Shopinvader

Contributors

Maintainers

This module is part of the shopinvader/odoo-shopinvader-payment project on GitHub.

You are welcome to contribute.

Metadata

Release files for odoo-addon-shopinvader-api-payment 16.0.1.1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo-addon-shopinvader-api-payment 16.0.1.1.0.1
File Interpreter ABI Platform
odoo_addon_shopinvader_api_payment-16.0.1.1.0.1-py3-none-any.whl Python 3 none any Details

Release files / odoo_addon_shopinvader_api_payment-16.0.1.1.0.1-py3-none-any.whl

Download URL odoo_addon_shopinvader_api_payment-16.0.1.1.0.1-py3-none-any.whl
Size 25.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dcdeb91946a0859c3a0b0c8987df4f0cd12d9ee25bb2bd4b3ce5d72980d30866
BLAKE2b-256 checksum
How to use checksums
4eb0d458c95c689303931af630debfe622f032f73d026dbbcdb1981fffdab4df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

16.0.1.1.0.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page