You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org
Fundraising/Data and flow/PSP integrations/Adyen Checkout
|Original Name||Adyen Checkout|
|Our Name||Adyen Checkout|
|Current Name||Adyen Checkout|
|Payment Methods||Credit Card, iDEAL, Apple Pay|
Adyen is our backup credit card processor.
In 2021, we updated our Adyen code to use their 'Checkout' integration, version 4. Checkout integration sources Adyen-hosted JS on our payments page and renders payment fields in the same form as the donor data, encrypting the data before submitting it to our server. We are using the 'components' style Checkout integration rather than the 'drop-in' style. Both styles use the same Adyen JS objects, but with components we instantiate a slightly lower-level JS object that is specific to the payment method.
A month after we deployed our new integration, Adyen released Checkout version 5 with some breaking changes and a simplified control flow. We have not made plans to update to version 5.
All calls to the Adyen API are routed through the SmashPig library. There are PaymentProcessor subclasses for each payment method.
Documentation for the former (Hosted Payment Pages) integration is at https://www.mediawiki.org/wiki/Fundraising_tech/Adyen
Credit cards are available with payment_method=cc which adds Adyen's fields (Card number, Expiry date, and CVC / CVV) below ours in the payments form.
|Credit Card form|
Which implementation are we using? https://docs.adyen.com/online-payments/3d-secure
iDEAL is bank transfer payment method only available in the Netherlands (payment_method=rtbt&country=NL).
The supported banking systems can be down so Adyen handles creating the list of available banks (referred to as issuers by Adyen) which we get by calling getPaymentMethods.
The donor chooses a bank and is then redirected to their bank's website to complete the donation.
When that is complete they are redirected to our thank you page.
|List of available banks (issuers)||Example redirect to donors bank|
iDEAL recurring has a unique flow as Adyen sends the recurring token on an IPN after the donor finishes the transaction. The donation isn't immediately put onto the donations queue.
From the donor's perspective the flow is exactly the same as a one time donation but on our end we don't complete the donation until we get a RECURRING_CONTRACT IPN that has the recurring token on it.
RECURRING_CONTRACT IPNs are set for every new recurring so we filter out just the iDEAL recurrings, find the matching pending database entry, add the recurring token to the message and send it to the donations queue.
Recurring iDEAL donations are of the type SEPA Direct Debit.
- Implemented using https://docs.adyen.com/payment-methods/apple-pay/web-component
- Using "own certificate" approach
Apple Pay is available on Safari with payment_method=apple
It replaces the credit card form with a Donate to Apple Pay button as seen below. When the donor clicks on it it brings up a sheet (I think this is what its called?) that lets the donor choose which card and contact information to use.
|Using Apple Pay in Safari||Choosing card and contact information|
Apple Pay Testing Links (TBC)
- Apple Pay Developer Account login here
- Apple Pay test cards here
- Fundraising-tech Apple Pay Sandbox tester accounts here
- Fundraising-tech Apple Pay Test Server List here
- Use https://groups.google.com/forum/#!forum/googlepay-test-mode-stub-data to join test group, then you can test google pay with test card implemented by google already
Recurring Adyen donations are tokenized and are charged on our schedule by the SmashPig Civi extension's recurring payment charge job. Adyen recurring donations require two identifiers:
- Standard payment token, stored in the civicrm_payment_token table and called recurring_payment_token in queue messages and SmashPig parameters, referred to as 'storedPaymentMethodId' in the Adyen API
- Shopper identifier, stored in civicrm_contribution_recur as invoice_id and called processor_contact_id in queue messages and SmashPig parameters, referred to as shopperReference in the Adyen API
We continue to receive Adyen IPN messages in SOAP format, as with the HPP integration. Because with Checkout we are able to capture card payments directly from payments-wiki, we have disabled the asynchronous capture flow that we were using with the HPP integration. Code for async capture is still present in SmashPig but is disabled in config/adyen/main.yaml by setting capture-from-ipn-listener: false. We should probably remove that code and config variable as part of T291448.
The IPN messages have an
eventCode that we use to identify them and then either do something or ignore the notification.
List of possible eventCodes here: https://docs.adyen.com/development-resources/webhooks/understand-notifications
This notification comes in when a new recurring payment is created. Right now we are ignoring all of them except recurring iDEAL.
iDEAL only When a Pending/Received payment is not authorized.
When Adyen returns a Pending or Received result from a redirect: "The shopper has completed the payment but the final result is not yet known. It may take minutes or hours for the iDEAL payments network to confirm this."
The final result of the payment: "You will receive the final result of the payment in an AUTHORISATION notification. If the transaction is not authorised within 30 minutes, the offer will close. Optionally, you can be informed of this through an OFFER_CLOSED notification"
Adyen generates csv files on an irregular schedule 'whenever a payable batch closes' https://docs.adyen.com/reporting/settlement-detail-report . We process them with the wmf_audits drupal module that calls functions from SmashPig to parse the CSVs.
The DonationInterface Adyen Checkout adapter as of November 2021 sends duplicated messages to the Pending queue. It might not need to send any messages for card payments, as that queue is mostly used for pending transaction resolution, and that scenario is much less likely under Adyen Checkout due to us making the payment authorization and capture in the same HTTP request where we get the donor data.
The IPN listener sends 'RecordCaptureJob' messages to the Jobs-Adyen queue. These jobs combine information from the IPN message with information from the pending queue and send information to the donations queue.
There is also RecurringContractJob which are used for creating new iDEAL recurrings. They combine the recurring token from the IPN message from the original donation information in the pending queue and send the combined information to the donations queue.