Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FW][IMP] payment, *: document technical details in README files #155870

Conversation

fw-bot
Copy link
Contributor

@fw-bot fw-bot commented Feb 29, 2024

Each payment acquirer has its own implementation specificities: some implement a 'payment with redirection' flow and others a 'direct payment flow'; sometimes the 'payment with redirection' flow is even implemented as a 'direct payment' flow through an iframe; one payment acquirer could support webhooks while another does not and relies on another mechanism to fetch payment status updates...

It can be tricky to guess where to look in the code to determine how a payment acquirer is implemented.

On top of that, the online payments ecosystem evolves at a fast pace due to competition, buyouts, and legislation enforcement. Acquirers are thus frequently migrated to new APIs that might differ in implementation from the previous API.

To help figure out the which, why, how, and when of payment API implementations, a README.md file is added to the main directory of all payment acquirer modules. They can be browsed in human-readable format on GitHub.

task-2374916

See also:

Forward-Port-Of: #155761
Forward-Port-Of: #153016

@robodoo
Copy link
Contributor

robodoo commented Feb 29, 2024

@fw-bot
Copy link
Contributor Author

fw-bot commented Feb 29, 2024

This PR targets saas-16.2 and is part of the forward-port chain. Further PRs will be created up to master.

More info at https://github.com/odoo/odoo/wiki/Mergebot#forward-port

@robodoo robodoo added the forwardport This PR was created by @fw-bot label Feb 29, 2024
@C3POdoo C3POdoo added the RD research & development, internal work label Feb 29, 2024
@AntoineVDV AntoineVDV force-pushed the saas-16.2-15.0-payment-readme-anv-P51Y-fw branch from 52d00a6 to 9b79f0b Compare February 29, 2024 13:04
@fw-bot
Copy link
Contributor Author

fw-bot commented Feb 29, 2024

@AntoineVDV this PR was modified / updated and has become a normal PR. It should be merged the normal way (via @robodoo)

Each payment acquirer has its own implementation specificities: some
implement a 'payment with redirection' flow and others a 'direct payment
flow'; sometimes the 'payment with redirection' flow is even implemented
as a 'direct payment' flow through an iframe; one payment acquirer could
support webhooks while another does not and relies on another mechanism
to fetch payment status updates...

It can be tricky to guess where to look in the code to determine how a
payment acquirer is implemented.

On top of that, the online payments ecosystem evolves at a fast pace due
to competition, buyouts, and legislation enforcement. Acquirers are thus
frequently migrated to new APIs that might differ in implementation from
the previous API.

To help figure out the *which*, *why*, *how*, and *when* of payment API
implementations, a README.md file is added to the main directory of all
payment acquirer modules. They can be browsed in human-readable format
on GitHub.

task-2374916

X-original-commit: 21fd81f
@AntoineVDV AntoineVDV force-pushed the saas-16.2-15.0-payment-readme-anv-P51Y-fw branch from 9b79f0b to fc5abc8 Compare February 29, 2024 13:23
Copy link
Contributor

@vchu-odoo vchu-odoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!
LGTM

@AntoineVDV
Copy link
Contributor

@robodoo r+

robodoo pushed a commit that referenced this pull request Feb 29, 2024
Each payment acquirer has its own implementation specificities: some
implement a 'payment with redirection' flow and others a 'direct payment
flow'; sometimes the 'payment with redirection' flow is even implemented
as a 'direct payment' flow through an iframe; one payment acquirer could
support webhooks while another does not and relies on another mechanism
to fetch payment status updates...

It can be tricky to guess where to look in the code to determine how a
payment acquirer is implemented.

On top of that, the online payments ecosystem evolves at a fast pace due
to competition, buyouts, and legislation enforcement. Acquirers are thus
frequently migrated to new APIs that might differ in implementation from
the previous API.

To help figure out the *which*, *why*, *how*, and *when* of payment API
implementations, a README.md file is added to the main directory of all
payment acquirer modules. They can be browsed in human-readable format
on GitHub.

task-2374916

closes #155870

X-original-commit: 21fd81f
Related: odoo/enterprise#57803
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
@robodoo robodoo closed this Feb 29, 2024
@fw-bot
Copy link
Contributor Author

fw-bot commented Mar 1, 2024

@AntoineVDV child PR #155942 was modified / updated and has become a normal PR. This PR (and any of its parents) will need to be merged independently as approvals won't cross.

@fw-bot fw-bot deleted the saas-16.2-15.0-payment-readme-anv-P51Y-fw branch March 14, 2024 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
forwardport This PR was created by @fw-bot RD research & development, internal work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants