Page MenuHomePhabricator
Create Task
Maniphest T318756

Implement PayPal EC DoExpressCheckoutPayment in SmashPig
Closed, ResolvedPublic4 Estimated Story Points
Actions

Description

Method on payment provider: approvePayment

Doc link: https://developer.paypal.com/api/nvp-soap/do-express-checkout-payment-nvp/

Params to send in our implementation: (TODO finish mapping where all the values come from)
'USER', (from account params)
'PWD', (from account params)
'VERSION' => 204,
'METHOD' => 'DoExpressCheckoutPayment',
'TOKEN' => $params['payment_token'],
'PAYERID' => $params['processor_contact_id'],
'PAYMENTREQUEST_0_AMT',
'PAYMENTREQUEST_0_CURRENCYCODE',
'PAYMENTREQUEST_0_CUSTOM',
'PAYMENTREQUEST_0_DESC' => $params['description'],
'PAYMENTREQUEST_0_INVNUM',
'PAYMENTREQUEST_0_ITEMAMT', // FIXME: Not clear why this is required.
'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
'PAYMENTREQUEST_0_PAYMENTREASON' => 'None',

Error mapping:
PAYMENTINFO_0_ERRORCODE element of response should have value 0 for success
value 10412 should map to ErrorCode::DUPLICATE_ORDER_ID

Details

SubjectRepoBranchLines +/-
Add Paypal EC PaymentProvider Testswikimedia/fundraising/SmashPigmaster+108 -2
Update PayPal EC approvePayment/doExpressCheckoutPayment status mapping.wikimedia/fundraising/SmashPigmaster+110 -6
Add test for Paypal Express APIwikimedia/fundraising/SmashPigmaster+77 -0
Implement PayPal EC DoExpressCheckoutPayment API callwikimedia/fundraising/SmashPigmaster+189 -7
Customize query in gerrit

Related Objects
Search...

Event Timeline

Ejegg created this task.Sep 27 2022, 9:44 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 27 2022, 9:44 PM
Ejegg added a parent task: T317245: Move PayPal EC API calls to SmashPig.Sep 27 2022, 9:46 PM
XenoRyet moved this task from Triage to Sprint +1 on the Fundraising-Backlog board.Oct 3 2022, 7:56 PM
Dwisehaupt set the point value for this task to 4.Oct 7 2022, 4:21 PM
XenoRyet moved this task from Sprint +1 to Current Sprint on the Fundraising-Backlog board.Oct 11 2022, 8:02 PM
XenoRyet added a project: Fundraising Sprint Solid State Spaghetti.Oct 11 2022, 8:14 PM
jgleeson moved this task from Backlog to Being Reviewed on the Fundraising Sprint Solid State Spaghetti board.Oct 13 2022, 4:00 PM
jgleeson moved this task from Being Reviewed to Doing on the Fundraising Sprint Solid State Spaghetti board.
jgleeson claimed this task.Oct 13 2022, 4:17 PM
jgleeson added a comment.Oct 18 2022, 6:55 PM

Gonna move this out of sprint for now and pick up T318759: Implement PayPal EC SetExpressCheckout in SmashPig which I think is the one we want next

jgleeson removed a project: Fundraising Sprint Solid State Spaghetti.Oct 18 2022, 6:55 PM
jgleeson added a project: Fundraising Sprint Solid State Spaghetti.Oct 18 2022, 7:45 PM
gerritbot added a comment.Oct 20 2022, 7:31 PM

Change 845045 had a related patch set uploaded (by Jgleeson; author: Jgleeson):

[wikimedia/fundraising/SmashPig@master] WIP: Implement PayPal EC DoExpressCheckoutPayment API call

https://gerrit.wikimedia.org/r/845045

gerritbot added a project: Patch-For-Review.Oct 20 2022, 7:31 PM
jgleeson moved this task from Doing to Ready for Review on the Fundraising Sprint Solid State Spaghetti board.Oct 22 2022, 10:38 AM
AndyRussG moved this task from Ready for Review to Done on the Fundraising Sprint Solid State Spaghetti board.Oct 24 2022, 2:55 PM
AndyRussG moved this task from Done to Being Reviewed on the Fundraising Sprint Solid State Spaghetti board.
XenoRyet added a project: Fundraising Sprint Turtles that are robotic that destroy the whole world with their foot theory.Oct 25 2022, 8:16 PM
AndyRussG moved this task from Backlog to Being Reviewed on the Fundraising Sprint Turtles that are robotic that destroy the whole world with their foot theory board.Oct 26 2022, 3:34 PM
jgleeson moved this task from Being Reviewed to Doing on the Fundraising Sprint Turtles that are robotic that destroy the whole world with their foot theory board.Oct 31 2022, 7:44 PM
jgleeson added a comment.EditedNov 3 2022, 2:59 PM

Test instructions

There are a few ways to test this patch and get the necessary values needed to call the GetExpressCheckoutDetails API method. Here's the quickest way:

1, Open up DonationInterface/paypal_ec_gateway/paypal_express.adapter.php and jump to line 618. You should see code that looks like the following:

$this->addRequestData( $requestData );
$resultData = $this->do_transaction( 'GetExpressCheckoutDetails' );

Change this to

$this->addRequestData( $requestData );
/** DEBUG CODE. DELETE AFTER USE  */
var_dump($requestValues);exit;
/** END OF DEBUG CODE */
$resultData = $this->do_transaction( 'GetExpressCheckoutDetails' );

We just add the line var_dump($requestValues);exit; in between the existing code lines.

2, Put through a normal Paypal donation locally (note: remember the amount for later)

3, You should now see a prematurely exited array dump with a bunch of request values, these are the values needed to call the DoExpressCheckoutPayment API method

For example, after adding the debug code and trying out a donation, I see the following:

array (size=5)
  'title' => string 'Special:PaypalExpressGatewayResult' (length=34)
  'order_id' => string '15182.1' (length=7)
  'wmf_token' => string '916c2bef399600e5bbccc3faf3451509+\' (length=34)
  'token' => string 'EC-3HX397483P386493S' (length=20)
  'PayerID' => string 'FLJLQ2GV38E4Y' (length=13)

If you see this, great, you can now use the values above to run the newly added DoExpressCheckoutPayment maintenance script

4, Checkout this patch on smashpig

5, Connect in to the container using docker-compose exec smashpig bash

6, Run cd /srv/smashpig/

7, Now it's time to call the new maintenance script using the values you captured from your previous donation attempt.

8, Run php PaymentProviders/PayPal/Maintenance/DoExpressCheckoutPayment.php $token $PayerID $order_id $amount replacing the variables with the request values you got from the debug output. Note: the amount isn't included in the request values, you need to remember that. All the other required params should be there.

You should end up with parameters that look something like this php PaymentProviders/PayPal/Maintenance/DoExpressCheckoutPayment.php EC-3HX397483P386493S FLJLQ2GV38E4Y 15182.1 25.00

9, Run that final command using the required parameters, and if all goes well, you should see something like:

2022-11-03T14:40:14+00:00 [DEBUG  ] {SmashPig-DoExpressCheckoutPayment::SPCID-0691958305} Successful request
2022-11-03T14:40:14+00:00 [DEBUG  ] {SmashPig-DoExpressCheckoutPayment::SPCID-0691958305} Response from API call: {"body":"TOKEN=EC%2d3HX397483P386493S&SUCCESSPAGEREDIRECTREQUESTED=false&TIMESTAMP=2022%2d11%2d03T14%3a40%3a14Z&CORRELATIONID=ef4e37e87b6d7&ACK=Success&VERSION=204&BUILD=57853092&INSURANCEOPTIONSELECTED=false&SHIPPINGOPTIONISDEFAULT=false&PAYMENTINFO_0_TRANSACTIONID=6BP189448J588054R&PAYMENTINFO_0_TRANSACTIONTYPE=expresscheckout&PAYMENTINFO_0_PAYMENTTYPE=instant&PAYMENTINFO_0_ORDERTIME=2022%2d11%2d03T14%3a40%3a12Z&PAYMENTINFO_0_AMT=25%2e00&PAYMENTINFO_0_FEEAMT=1%2e36&PAYMENTINFO_0_TAXAMT=0%2e00&PAYMENTINFO_0_CURRENCYCODE=USD&PAYMENTINFO_0_PAYMENTSTATUS=Completed&PAYMENTINFO_0_PENDINGREASON=None&PAYMENTINFO_0_REASONCODE=None&PAYMENTINFO_0_PROTECTIONELIGIBILITY=Eligible&PAYMENTINFO_0_PROTECTIONELIGIBILITYTYPE=ItemNotReceivedEligible%2cUnauthorizedPaymentEligible&PAYMENTINFO_0_SELLERPAYPALACCOUNTID=fr%2dtech%2dfacilitator%40wikimedia%2eorg&PAYMENTINFO_0_SECUREMERCHANTACCOUNTID=XBAQ9CSARUZ7J&PAYMENTINFO_0_ERRORCODE=0&PAYMENTINFO_0_ACK=Success","headers":{"Content-Type":"text\/plain; charset=utf-8","Content-Length":"943","Connection":"keep-alive","Server":"nginx\/1.14.0 (Ubuntu)","Date":"Thu, 03 Nov 2022 14:40:14 GMT","Cache-Control":"max-age=0, no-cache, no-store, must-revalidate","Paypal-Debug-Id":"ef4e37e87b6d7","X-Paypal-Operation-Name":"DoExpressCheckoutPayment","Strict-Transport-Security":"max-age=31536000; includeSubDomains"},"status":200}
SmashPig\PaymentProviders\Responses\ApprovePaymentResponse Object
(
    [errors:protected] => Array
        (
        )

    [validationErrors:protected] => Array
        (
        )

    [rawResponse:protected] => Array
        (
            [TOKEN] => EC-3HX397483P386493S
            [SUCCESSPAGEREDIRECTREQUESTED] => false
            [TIMESTAMP] => 2022-11-03T14:40:14Z
            [CORRELATIONID] => ef4e37e87b6d7
            [ACK] => Success
            [VERSION] => 204
            [BUILD] => 57853092
            [INSURANCEOPTIONSELECTED] => false
            [SHIPPINGOPTIONISDEFAULT] => false
            [PAYMENTINFO_0_TRANSACTIONID] => 6BP189448J588054R
            [PAYMENTINFO_0_TRANSACTIONTYPE] => expresscheckout
            [PAYMENTINFO_0_PAYMENTTYPE] => instant
            [PAYMENTINFO_0_ORDERTIME] => 2022-11-03T14:40:12Z
            [PAYMENTINFO_0_AMT] => 25.00
            [PAYMENTINFO_0_FEEAMT] => 1.36
            [PAYMENTINFO_0_TAXAMT] => 0.00
            [PAYMENTINFO_0_CURRENCYCODE] => USD
            [PAYMENTINFO_0_PAYMENTSTATUS] => Completed
            [PAYMENTINFO_0_PENDINGREASON] => None
            [PAYMENTINFO_0_REASONCODE] => None
            [PAYMENTINFO_0_PROTECTIONELIGIBILITY] => Eligible
            [PAYMENTINFO_0_PROTECTIONELIGIBILITYTYPE] => ItemNotReceivedEligible,UnauthorizedPaymentEligible
            [PAYMENTINFO_0_SELLERPAYPALACCOUNTID] => fr-tech-facilitator@wikimedia.org
            [PAYMENTINFO_0_SECUREMERCHANTACCOUNTID] => XBAQ9CSARUZ7J
            [PAYMENTINFO_0_ERRORCODE] => 0
            [PAYMENTINFO_0_ACK] => Success
        )

    [gateway_txn_id:protected] => 6BP189448J588054R
    [status:protected] => complete
    [rawStatus:protected] => Success
    [successful:protected] => 1
    [timeTaken:protected] => 
)

Reach out if that above doesn't work!

Note: Don't forget to remove the debug code you added!
Another Note: You could also capture the request info by setting a breakpoint at line 618 of DonationInterface/paypal_ec_gateway/paypal_express.adapter.php and using xdebug. Either way would work fine to get the initial required info.

gerritbot added a comment.Nov 4 2022, 6:56 AM

Change 845045 merged by jenkins-bot:

[wikimedia/fundraising/SmashPig@master] Implement PayPal EC DoExpressCheckoutPayment API call

https://gerrit.wikimedia.org/r/845045

Maintenance_bot removed a project: Patch-For-Review.Nov 4 2022, 7:30 AM
jgleeson moved this task from Doing to Pending Deployment on the Fundraising Sprint Turtles that are robotic that destroy the whole world with their foot theory board.Nov 7 2022, 2:29 PM
gerritbot added a comment.Nov 8 2022, 7:47 PM

Change 854581 had a related patch set uploaded (by Jgleeson; author: Jgleeson):

[wikimedia/fundraising/SmashPig@master] Update PayPal EC approvePayment/doExpressCheckoutPayment status mapping to handle all available status messages

https://gerrit.wikimedia.org/r/854581

gerritbot added a project: Patch-For-Review.Nov 8 2022, 7:47 PM
gerritbot added a comment.Nov 9 2022, 7:59 PM

Change 855060 had a related patch set uploaded (by Jgleeson; author: Jgleeson):

[wikimedia/fundraising/SmashPig@master] Add tests for Paypal Express implementation

https://gerrit.wikimedia.org/r/855060

greg added a project: Fundraising Sprint Undefined.Nov 9 2022, 8:44 PM
gerritbot added a comment.Nov 10 2022, 11:03 PM

Change 855060 merged by Wfan:

[wikimedia/fundraising/SmashPig@master] Add test for Paypal Express API

https://gerrit.wikimedia.org/r/855060

gerritbot added a comment.Nov 11 2022, 12:26 AM

Change 855749 had a related patch set uploaded (by Jgleeson; author: Jgleeson):

[wikimedia/fundraising/SmashPig@master] Add Paypal EC PaymentProvider Tests

https://gerrit.wikimedia.org/r/855749

AnnWF moved this task from Backlog to Being Reviewed on the Fundraising Sprint Undefined board.Nov 14 2022, 8:03 PM
gerritbot added a comment.Nov 15 2022, 7:11 PM

Change 854581 merged by jenkins-bot:

[wikimedia/fundraising/SmashPig@master] Update PayPal EC approvePayment/doExpressCheckoutPayment status mapping.

https://gerrit.wikimedia.org/r/854581

gerritbot added a comment.Nov 16 2022, 12:30 AM

Change 855749 merged by jenkins-bot:

[wikimedia/fundraising/SmashPig@master] Add Paypal EC PaymentProvider Tests

https://gerrit.wikimedia.org/r/855749

Maintenance_bot removed a project: Patch-For-Review.Nov 16 2022, 1:30 AM
AnnWF moved this task from Being Reviewed to Done on the Fundraising Sprint Undefined board.Nov 16 2022, 1:44 AM
AnnWF moved this task from Done to Pending Deployment on the Fundraising Sprint Undefined board.
XenoRyet closed this task as Resolved.Nov 22 2022, 8:51 PM
XenoRyet set Final Story Points to 4.
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL