Adding-Modification-Functionality-For-Checkout-Api #144

eraserhead0705 · 2021-07-13T15:00:54Z

What problem you’re solving:
The Adyen Python Library lacks support for the full Checkout API actions.
Capture
Refund
Reversals
Cancel/Technical Cancel

Our Team at Tier needs this functionality implemented in the Python library in order to fully integrate with our backend system.

Your approach to fixing the problem:
Implemented the above functionality by building on the current service/client in the code base. I added a new parameter to send a path parameter to the Adyen Api.

Any tests you wrote:
Each new action has two tests written, one success and one that mocks an error.
Additionally a test that checks for race condition.

Merge from develop

New release 1.3.0

New release 1.4.0

Release 2.0.0

Release 2.1.0

Merge to master

Release 3.0.0

Release 3.1.0

Release 5.0.0

Release 5.1.0

* [PW-4392] Update README based on the new template (Adyen#140) * Update README based on the new template * Update the endpoints versions * Add the api versions in the description * Add the example with xapi key * Apply suggestions from code review Co-authored-by: Ángel Campos <angel.campos@adyen.com> * Update README.md Co-authored-by: Alessio Zampatti <alessio.zampatti@adyen.com> Co-authored-by: Ángel Campos <angel.campos@adyen.com> Co-authored-by: Alessio Zampatti <alessio.zampatti@adyen.com> * Adding cancels action * [PW-4392] Update README based on the new template (Adyen#140) * Update README based on the new template * Update the endpoints versions * Add the api versions in the description * Add the example with xapi key * Apply suggestions from code review Co-authored-by: Ángel Campos <angel.campos@adyen.com> * Update README.md Co-authored-by: Alessio Zampatti <alessio.zampatti@adyen.com> Co-authored-by: Ángel Campos <angel.campos@adyen.com> Co-authored-by: Alessio Zampatti <alessio.zampatti@adyen.com> * Adding cancels action * Adding modifications to checkout api Co-authored-by: Alexandros Moraitis <alexandros.moraitis@adyen.com> Co-authored-by: Ángel Campos <angel.campos@adyen.com> Co-authored-by: Alessio Zampatti <alessio.zampatti@adyen.com> Co-authored-by: Eric Laff <eric.laff@tier.app>

Co-authored-by: Eric Laff <eric.laff@tier.app>

…rary

eraserhead0705 · 2021-07-13T15:02:50Z

@acampos1916 Hey! This is a reopened PR per your instructions. I made the requested changes. Thanks again!

AlexandrosMor · 2021-08-20T09:02:39Z

Hello @eraserhead0705,
Thank you for the pull request. We see that there are old commits which is not good for the commit history. Would you mind to take care of it ?

Thank you in advance,
Alexandros
Adyen

Aleffio · 2021-08-20T09:01:34Z

test/CheckoutTest.py

+                                                              "paymentscancel-"
+                                                              "withoutreference-succes.json")
+
+        result = self.adyen.checkout.payments_cancels_without_reference(request=requests, path_param=psp_reference)


Suggested change

result = self.adyen.checkout.payments_cancels_without_reference(request=requests, path_param=psp_reference)

result = self.adyen.checkout.payments_refunds(request=requests, path_param=psp_reference)

Aleffio · 2021-08-20T09:03:44Z

Adyen/client.py

        if action == "paymentsResult":
            action = "payments/result"
+        if action == "paymentsCancelsWithoutReference":
+            action = "payments/cancels"


are you referring to this endpoint? https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/cancels
it should be just /cancels? without the payments prefix. Maybe we can call the action just cancels if this is the case.

Aleffio · 2021-08-20T09:06:11Z

test/CheckoutTest.py

+                                                              "paymentsresult-error-invalid-"
+                                                              "data-payload-422.json")
+
+        result = self.adyen.checkout.payments_cancels_without_reference(request=requests, path_param=reference_id)


Suggested change

result = self.adyen.checkout.payments_cancels_without_reference(request=requests, path_param=reference_id)

result = self.adyen.checkout.payments_refunds(request=requests, path_param=reference_id)

Aleffio · 2021-08-20T09:07:56Z

test/CheckoutTest.py

+        self.assertEqual("Invalid payload provided", result.message['message'])
+        self.assertEqual("validation", result.message['errorType'])
+
+    def test_payments_refunds_raises_vaulue_error(self):


Suggested change

def test_payments_refunds_raises_vaulue_error(self):

def test_payments_refunds_raises_value_error(self):

Aleffio · 2021-08-20T09:08:29Z

test/CheckoutTest.py

+                                                              "paymentscancel-"
+                                                              "withoutreference-succes.json")
+        with self.assertRaises(ValueError) as exc:
+            self.adyen.checkout.payments_cancels_with_reference(request=requests, path_param="")


Suggested change

self.adyen.checkout.payments_cancels_with_reference(request=requests, path_param="")

self.adyen.checkout.payments_refunds(request=requests, path_param="")

Aleffio · 2021-08-20T09:11:40Z

Adyen/services.py

+            raise ValueError(
+                'must contain a pspReference in the path_param, path_param cannot be empty'
+            )
+        action = "paymentsCapture"


can you please add this action in the client.py code? I think it's not there yet

Aleffio · 2021-08-20T09:12:14Z

Adyen/services.py

        action = "paymentsResult"
        return self.client.call_checkout_api(request, action, **kwargs)

+    def payment_captures(self, path_param, request=None, idempotency_key=None, **kwargs):


Suggested change

def payment_captures(self, path_param, request=None, idempotency_key=None, **kwargs):

def payments_captures(self, path_param, request=None, idempotency_key=None, **kwargs):

eraserhead0705 · 2021-08-20T09:30:12Z

Hello @eraserhead0705,
Thank you for the pull request. We see that there are old commits which is not good for the commit history. Would you mind to take care of it ?

Thank you in advance,
Alexandros
Adyen

Yes sureI can clean it up.

acampos1916 · 2021-08-31T06:33:20Z

Thanks @eraserhead0705 let us know it goes, we can check the PR again as soon as these comments are addressed.

whyscream · 2021-09-10T14:22:12Z

Adyen/services.py

+                'must contain a pspReference in the path_param, path_param cannot be empty'
+            )
+        action = "paymentsReversals"
+        return self.client.call_checkout_api(request, action, path_param, idempotency_key, **kwargs)


This does not work: call_checkout_api expects idempotency_key and path_param in a different order.

Same comment probably also applies to all other uses of call_checkout_api in this PR.

I see :) Thanks for the comment!

yesthesoup · 2022-03-01T19:30:13Z

hi all, my team would like to use this as well - what is blocking this PR? maybe we could help contribute

acampos1916 · 2022-03-02T12:44:23Z

Hello @yesthesoup, your help would be greatly appreciated. I see that @eraserhead0705 hasn’t been able to work on the suggestions from above, are you able to commit to this branch?

eraserhead0705 · 2022-03-09T11:03:36Z

Hey @acampos1916 I have the fixes on my local branch. I will try and get them pushed this week.

Figuring out also if it makes sense to update this PR or just open a fresh one.

acampos1916 · 2022-03-09T13:46:17Z

Thanks @eraserhead0705, if it’s easier to open a new one feel free to do so.

eraserhead0705 · 2022-03-09T15:39:54Z

Thanks @eraserhead0705, if it’s easier to open a new one feel free to do so.

Gonna open a new one then, in the end I think its cleaner. I will reverence it here when I do 👍

eraserhead0705 · 2022-03-10T08:43:10Z

@acampos1916 I opened a New PR, #158 for these changes.

eraserhead0705 · 2022-06-13T14:29:29Z

@acampos1916 Can I close this PR?

acampos1916 · 2022-06-13T14:35:37Z

Thanks @eraserhead0705, I can close it

Aleffio and others added 17 commits October 23, 2017 16:46

Merge pull request Adyen#38 from Adyen/develop

993d1b8

Merge from develop

Merge pull request Adyen#51 from Adyen/develop

28eb420

New release 1.3.0

Merge pull request Adyen#57 from Adyen/develop

2530b4d

New release 1.4.0

Merge pull request Adyen#63 from Adyen/develop

9bf9188

Release 2.0.0

Merge pull request Adyen#76 from Adyen/develop

ce3dff7

Release 2.1.0

Merge pull request Adyen#95 from Adyen/develop

d89344c

Merge to master

Merge pull request Adyen#107 from Adyen/develop

04ffb98

Merge pull request Adyen#111 from Adyen/develop

219817e

Release 3.0.0

Merge pull request Adyen#122 from Adyen/develop

cd10fc8

Release 3.1.0

Release v4.0.0

7eb7196

Merge pull request Adyen#136 from Adyen/develop

5532943

Release 5.0.0

Merge pull request Adyen#139 from Adyen/develop

be78ec7

Release 5.1.0

Adjusting Exception Handling for path-params (#2)

0634330

Co-authored-by: Eric Laff <eric.laff@tier.app>

Fixing comments and readme per PR comments (#3)

15e08f2

Co-authored-by: Eric Laff <eric.laff@tier.app>

Update readme

c87c504

Merge branch 'master' of github.com:TierMobility/adyen-python-api-lib…

800b613

…rary

eraserhead0705 requested review from Aleffio, AlexandrosMor, acampos1916, cyattilakiss, martinsrenato and rikterbeek as code owners July 13, 2021 15:00

Merge branch 'develop' into master

0140d4f

eraserhead0705 changed the title ~~Adding-Modification-Functionality-Checkout-To-Api~~ Adding-Modification-Functionality-For-Checkout-Api Jul 22, 2021

Aleffio reviewed Aug 20, 2021

View reviewed changes

whyscream reviewed Sep 10, 2021

View reviewed changes

cyattilakiss approved these changes Sep 15, 2021

View reviewed changes

acampos1916 mentioned this pull request Mar 10, 2022

Add Modifications to Python Library For Checkout Api #158

Merged

acampos1916 closed this Jun 13, 2022

eraserhead0705 deleted the master branch August 19, 2022 14:25

	result = self.adyen.checkout.payments_cancels_without_reference(request=requests, path_param=psp_reference)
	result = self.adyen.checkout.payments_refunds(request=requests, path_param=psp_reference)

	def test_payments_refunds_raises_vaulue_error(self):
	def test_payments_refunds_raises_value_error(self):

	self.adyen.checkout.payments_cancels_with_reference(request=requests, path_param="")
	self.adyen.checkout.payments_refunds(request=requests, path_param="")

	def payment_captures(self, path_param, request=None, idempotency_key=None, **kwargs):
	def payments_captures(self, path_param, request=None, idempotency_key=None, **kwargs):

Adding-Modification-Functionality-For-Checkout-Api #144

Adding-Modification-Functionality-For-Checkout-Api #144

Uh oh!

Conversation

eraserhead0705 commented Jul 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eraserhead0705 commented Jul 13, 2021

Uh oh!

AlexandrosMor commented Aug 20, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eraserhead0705 commented Aug 20, 2021

Uh oh!

acampos1916 commented Aug 31, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yesthesoup commented Mar 1, 2022

Uh oh!

acampos1916 commented Mar 2, 2022

Uh oh!

eraserhead0705 commented Mar 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

acampos1916 commented Mar 9, 2022

Uh oh!

eraserhead0705 commented Mar 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eraserhead0705 commented Mar 10, 2022

Uh oh!

eraserhead0705 commented Jun 13, 2022

Uh oh!

acampos1916 commented Jun 13, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

eraserhead0705 commented Jul 13, 2021 •

edited

Loading

eraserhead0705 commented Mar 9, 2022 •

edited

Loading

eraserhead0705 commented Mar 9, 2022 •

edited

Loading