mage2pro / stripe

Stripe integration with Magento 2

The module integrates Magento 2 with the Stripe payment service. The module is free and open source.

Screenshots

See also a showcase of the real clients usage.

1. Frontend. A simple payment form without saved bank cards

2. Frontend. Using a saved bank card

3. Frontend. Using a new bank card

4. Frontend. A multishipping checkout.

5. Backend. A payment's imformation

6. Backend. Choosing the payments currency

7. Backend. The extension's settings

8. Backend. A transaction's details

Demo videos

1. Capture and Refund
2. Preauthorization and Capture
3. Preauthorization and Voiding
4. Review and Accept / Deny
5. Capture from a Stripe account
6. Refund from a Stripe account
7. Save and reuse bank cards
8. Multishipping checkout

Who is using it?

stripe.mage2.pro/customers
See also a showcase of the real clients usage.

How to install

Hire me in Upwork, and I will:

• install and configure the module properly on your website
• answer your questions
• solve compatiblity problems with third-party checkout, shipping, marketing modules
• implement new features you need

Self-installation

bin/magento maintenance:enable
rm -f composer.lock
composer clear-cache
composer require mage2pro/stripe:*
bin/magento setup:upgrade
bin/magento cache:enable
rm -rf var/di var/generation generated/code
bin/magento setup:di:compile
rm -rf pub/static/*
bin/magento setup:static-content:deploy -f en_US <additional locales>
bin/magento maintenance:disable

How to update

bin/magento maintenance:enable
composer remove mage2pro/stripe
rm -f composer.lock
composer clear-cache
composer require mage2pro/stripe:*
bin/magento setup:upgrade
bin/magento cache:enable
rm -rf var/di var/generation generated/code
bin/magento setup:di:compile
rm -rf pub/static/*
bin/magento setup:static-content:deploy -f en_US <additional locales>
bin/magento maintenance:disable

stripe's Issues

Provide the iDEAL payments option

Stripe users in Europe can accept iDEAL payments from customers in the Netherlands using Sources — a single integration path for creating payments using any supported method.

https://stripe.com/docs/sources/ideal
https://stripe.com/payments/payment-methods-guide#ideal

Add support for Apple Pay

https://stripe.com/docs/apple-pay/web/v2
https://stripe.com/payments/payment-methods-guide#apple-pay
«I want to integrate Apple Pay with Stripe»: https://mage2.pro/t/2070

Provide the SEPA Direct Debit payment option

Stripe users in Europe can use Sources — a single integration path for creating payments using any supported method—to accept SEPA Direct Debit payments from customers in countries within the Single Euro Payments Area.

https://stripe.com/docs/sources/sepa-debit
https://stripe.com/payments/payment-methods-guide#sepa-direct-debit

The ineligible characters should be automatically replaced by the corresponding eligible ones in the multi-shipping scenario while prefilling the cardholder's name (if «Prefill the cardholder's name from the billing address?» option is enabled)

Similar to mage2pro/core#37

Stripe API version (2017-08-15) does not accept a WebHook URL: «You passed an empty string for 'expand'»

When trying to add the webhook url as specified in https://mage2.pro/t/topic/977 it doest not work.

Stripe Displays the Following Information:

You passed an empty string for 'expand'. We assume empty values are an attempt to unset a parameter; however 'expand' cannot be unset. You should remove 'expand' from your request or supply a non-empty value.

«Mexican Stripe accounts (currently in Preview) can only charge in Mexican Peso»

https://stripe.com/docs/currencies#charge-currencies
The currency limitation can be implemented similar to the «JCB, Discover, and Diners Club cards can only be charged in USD»: #28

Implement the subscriptions / recurring payments feature

https://stripe.com/docs/subscriptions

Provide the Giropay payment option

Stripe users in Europe can accept Giropay payments from customers in Germany using Sources — a single integration path for creating payments using any supported method.

https://stripe.com/docs/sources/giropay
https://stripe.com/payments/payment-methods-guide#giropay

Remove the `layout` attribute (e.g.: `layout='1column'`) from the root `<page>` tag in the layout XML files because this attribute value is not necessary for us, but can conflict with some third-party design themes and some third-party checkout extensions

Nobody of my clients has reported it, but I noticed a similar issue here: Inchoo/magento2-Inchoo_Stripe#15 (comment)

Create a Source object instead of a token on the client side: it will allow us to implement additional Stripe's payment options in future (3D Secure, local European and Chinese payment options, etc.)

Now we use stripe.createToken().
We should use stripe.createSource() instead.

Attach the initial reusable source for a card which require a 3D Secure verification to the customer (cardholder)

[Stripe] An initial reusable source for a card which requires a 3D Secure verification

https://github.com/mage2pro/stripe/blob/2.4.5/W/Strategy/Charge3DS.php#L29-L46

#15

Pass the brand of ther used bank card from the payment form to the Magento server part in the multi-shipping scenario (in the same way as it is happen in the single-shipping scenario)

The single-shipping scenario's implementation: https://github.com/mage2pro/stripe/blob/2.2.0/view/frontend/web/main.js#L71-L80

If a customer does not have saved cards, then the multi-shipping payment page passes the Stripe payment token twice to the server in the same form (the second token value is empty)

POST /multishipping/checkout/overview/

It is related to "[Df\Payment\Token::get] A result of this method is rejected by the «df_result_sne» validator. The diagnostic message: A non-empty string is required, but got an empty one."

Provide the ACH payments option

Stripe supports accepting ACH payments—direct from bank accounts—alongside credit cards.

https://stripe.com/docs/ach
https://stripe.com/payments/payment-methods-guide#ach-credit-transfers
https://stripe.com/payments/payment-methods-guide#ach-debits
https://en.wikipedia.org/wiki/Automated_Clearing_House

A charge for the test card with required 3D Secure verification (4000000000003063) fails: «Your card was declined»

My Stripe account: [email protected]
I use it in the test mode.
I use the official test bank card with required 3D Secure verification: 4000000000003063

1. The problem payment: ch_1BNNbYFzKb8aMux1r8am3qhm.

2. The problem POST /v1/charges API request : req_uOlp1BAbu4LOPM

2.1. Request POST body

{
  "customer": "cus_BktO7aVsP2aC5m",
  "description": "Alligator Briefcase (2), New Very Prive 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890 1234567890",
  "capture": "true",
  "statement_descriptor": "PREVED, MEDVED!",
  "amount": "12700",
  "currency": "USD",
  "source": "src_1BNNaQFzKb8aMux1a5L3DynD",
  "metadata": {
    "Customer Name": "Dmitry Fedyuk",
    "Order ID": "ORD-2017/11-01225",
    "Order Items": "Alligator Briefcase (2), New Very Prive",
    "Store Domain": "mage2.pro",
    "Store Name": "Mage2.PRO",
    "Store URL": "https://mage2.pro/sandbox/"
  },
  "shipping": {
    "address": {
      "city": "Sydney",
      "country": "AU",
      "line1": "72 Liverpool St",
      "line2": "",
      "postal_code": "2000"
    },
    "carrier": "Flat Rate",
    "name": "Dmitry Fedyuk",
    "phone": "[phone]"
  }
}

2.1. Response POST body

{
  "error": {
    "message": "Your card was declined.",
    "type": "card_error",
    "code": "card_declined",
    "decline_code": "generic_decline",
    "charge": "ch_1BNNbYFzKb8aMux1r8am3qhm"
  }
}

3. The used source: src_1BNNaQFzKb8aMux1a5L3DynD

3.1. As it is shown in my Stripe dashboard

3.2. The POST /v1/sources API request used to create the source: req_vm8i83J8J5voZR

3.2.1. Request POST body

{
  "type": "card",
  "owner": {
    "address": {
      "city": "Sydney",
      "country": "AU",
      "line1": "72 Liverpool St",
      "postal_code": "2000"
    },
    "email": "[email protected]",
    "name": "DMITRY FEDYUK",
    "phone": "[phone]"
  },
  "usage": "reusable",
  "card": {
    "number": "************3063",
    "cvc": "***",
    "exp_month": "07",
    "exp_year": "21"
  },
  "payment_user_agent": "stripe.js/e8028cf; stripe-js-v3/e8028cf",
  "referrer": "https://mage2.pro/sandbox/checkout/",
  "key": "pk_test_xf2fh0Hu3LqXlqqUg2DEWhEz",
  "pasted_fields": "number"
}

3.2.2. Response body

{
  "id": "src_1BNNaQFzKb8aMux1a5L3DynD",
  "object": "source",
  "amount": null,
  "client_secret": "src_client_secret_BktNAJs55Ik0PLD3pjFcuC3V",
  "created": 1510501290,
  "currency": null,
  "flow": "none",
  "livemode": false,
  "metadata": {
  },
  "owner": {
    "address": {
      "city": "Sydney",
      "country": "AU",
      "line1": "72 Liverpool St",
      "line2": null,
      "postal_code": "2000",
      "state": null
    },
    "email": "[email protected]",
    "name": "DMITRY FEDYUK",
    "phone": "[phone]",
    "verified_address": null,
    "verified_email": null,
    "verified_name": null,
    "verified_phone": null
  },
  "statement_descriptor": null,
  "status": "chargeable",
  "type": "card",
  "usage": "reusable",
  "card": {
    "exp_month": 7,
    "exp_year": 2021,
    "address_line1_check": "unchecked",
    "address_zip_check": "unchecked",
    "brand": "Visa",
    "country": "US",
    "cvc_check": "unchecked",
    "funding": "credit",
    "last4": "3063",
    "three_d_secure": "required",
    "tokenization_method": null,
    "dynamic_last4": null
  }
} 

Pass the customer's billing address to the createToken() Stripe.js method in the multi-shipping scenario (in the same way as it is happen in the single-shipping scenario)

«I want to pass the customer's billing address to the createToken() Stripe.js method»: https://mage2.pro/t/4412

`afterRender='<callback>'` does not work at least in Magento 2.0.2

Provide the Alipay payments option

Use Sources to accept payments using Alipay, the most popular payment method in China.

https://stripe.com/docs/sources/alipay
https://stripe.com/payments/payment-methods-guide#alipay
«Stripe adds support for Alipay and WeChat Pay, China’s top digital payment services» (TechCrunch, 2017-07-09)

«Could not save credit memo»: «Division by zero in magento/module-sales/Model/Order/Creditmemo/Item.php»

https://sentry.io/dmitry-fedyuk/mage2pro-stripe/issues/375345346/events/8240096335

$this->setRowTotalInclTax(
    $creditmemo->roundPrice($rowTotalInclTax / $orderItemQty * $qty, 'including')
);

https://github.com/magento/magento2/blob/2.1.7/app/code/Magento/Sales/Model/Order/Creditmemo/Item.php#L263-L265

Optionally separate bank card fields in the multishipping scenario

https://mage2.pro/t/4672

The payment form in the frontend multishipping scenario does not ask a customer for the cardholder name even if the «Require the cardholder's name?» option is enabled

An example from the Stripe's documentation:

https://stripe.com/docs#try-now

«window.checkout is undefined» (repost)

https://github.com/mage2pro/stripe

After configure this module, from front-end when redirect to checkout page from cart page
it show blank page with below error on console

TypeError: window.checkout is undefined

[1.6.40] «Customer does not have a linked source with ID 0» for a new Magento customer (guest)

«Could not save credit memo»: «The most money available to refund is <...>»

https://sentry.io/dmitry-fedyuk/mage2pro-stripe/issues/375345346/events/8236472907

Provide the P24 (Przelewy24) payments option

Use Sources to accept payments using P24 (Przelewy24), the most popular payment method in Poland.

https://stripe.com/docs/sources/p24

Implement the WeChat Pay payment option

https://stripe.com/payments/payment-methods-guide#wechat-pay

«Stripe adds support for Alipay and WeChat Pay, China’s top digital payment services» (TechCrunch, 2017-07-09)

The 3D Secure verification is not applied for a bank card with an optional 3D Secure support ("three_d_secure": "optional") even been enabled in the Magento 2 backend for all customers when `redirect/status` is `not_required`

1. An initial reusable source for a card with an optional 3D Secure support ("three_d_secure": "optional")

{
  "object": {
    "id": "src_1BNt5mFzKb8aMux1TxtRtHEN",
    "object": "source",
    "amount": null,
    "client_secret": "src_client_secret_BlPv7LrthYboKKDEc4dx1Trp",
    "created": 1510622398,
    "currency": null,
    "flow": "none",
    "livemode": false,
    "metadata": {
    },
    "owner": {
      "address": {
        "city": "Sydney",
        "country": "AU",
        "line1": "72 Liverpool St",
        "line2": null,
        "postal_code": "2000",
        "state": null
      },
      "email": "[email protected]",
      "name": "DMITRY FEDYUK",
      "phone": "[phone]",
      "verified_address": null,
      "verified_email": null,
      "verified_name": null,
      "verified_phone": null
    },
    "statement_descriptor": null,
    "status": "chargeable",
    "type": "card",
    "usage": "reusable",
    "card": {
      "exp_month": 7,
      "exp_year": 2021,
      "address_line1_check": "unchecked",
      "address_zip_check": "unchecked",
      "brand": "Visa",
      "country": "US",
      "cvc_check": "unchecked",
      "fingerprint": "slrGvOFRzFPq9wGq",
      "funding": "credit",
      "last4": "4242",
      "three_d_secure": "optional",
      "tokenization_method": null,
      "dynamic_last4": null
    }
  },
  "previous_attributes": null
}

2. The derived single-use 3D Secure source

{
  "object": {
    "id": "src_1BNt5rFzKb8aMux1wrGBra5u",
    "object": "source",
    "amount": 12700,
    "client_secret": "src_client_secret_BlPvYxsByORoyQ43jLY8LCdI",
    "created": 1510622403,
    "currency": "usd",
    "flow": "redirect",
    "livemode": false,
    "metadata": {
    },
    "owner": {
      "address": {
        "city": "Sydney",
        "country": "AU",
        "line1": "72 Liverpool St",
        "line2": null,
        "postal_code": "2000",
        "state": null
      },
      "email": "[email protected]",
      "name": "DMITRY FEDYUK",
      "phone": "[phone]",
      "verified_address": null,
      "verified_email": null,
      "verified_name": null,
      "verified_phone": null
    },
    "redirect": {
      "failure_reason": null,
      "return_url": "https://mage2.pro/sandbox/dfe-stripe/customerReturn",
      "status": "not_required",
      "url": "https://hooks.stripe.com/redirect/authenticate/src_1BNt5rFzKb8aMux1wrGBra5u?client_secret=src_client_secret_BlPvYxsByORoyQ43jLY8LCdI"
    },
    "statement_descriptor": null,
    "status": "chargeable",
    "type": "three_d_secure",
    "usage": "single_use",
    "three_d_secure": {
      "card": "src_1BNt5mFzKb8aMux1TxtRtHEN",
      "customer": null,
      "authenticated": false
    }
  },
  "previous_attributes": null
}

Provide the SOFORT payments option

Stripe users in Europe can use Sources — a single integration path for creating payments using any supported method—to accept SOFORT payments from customers in the following countries:

• Austria
• Belgium
• Germany
• Italy
• Netherlands
• Spain

https://stripe.com/docs/sources/sofort
https://stripe.com/payments/payment-methods-guide#sofort

Provide the Bancontact payments option

Stripe users in Europe can accept Bancontact payments from customers in Belgium using Sources — a single integration path for creating payments using any supported method.

https://stripe.com/docs/sources/bancontact
https://stripe.com/payments/payment-methods-guide#bancontact

Pass order items to Stripe (so they can be viewed through the Stripe dashboard)

Orders API:
https://stripe.com/docs/orders
https://stripe.com/docs/api#orders

Use the Orders API to sell and organize your products through Stripe.

«bin/magento module:enable --all»: «The file "/composer.json" doesn't exist»

After installation with composer following error occurs:

php bin/magento module:enable --all
                                             
  [Magento\Framework\Exception\FileSystemException]  
  The file "/composer.json" doesn't exist            
                                               

Provide an ability to require the cardholder's name

https://mage2.pro/t/2776

Add a new option «Prefill the cardholder's name from the billing address?»

The option should be visible / available to the administrator if he has already enabled the «Require the cardholder's name?» option.

The primary task:

• Add a new option «Prefill the cardholder's name from the billing address?» to the payment modules which require (or accept) the cardholder's name

Provide the Bancontact payments option

Stripe users in Europe can accept Bancontact payments from customers in Belgium using Sources — a single integration path for creating payments using any supported method.

The «Prefill the cardholder's name from the billing address?» option is wrongly ignored in the multi-shipping scenario

It should be implemented similar to: https://github.com/mage2pro/core/blob/3.2.8/Payment/view/frontend/web/card.js#L171-L178

«Brazilian Stripe accounts (currently in Preview) can only charge in Brazilian Real»

https://stripe.com/docs/currencies#charge-currencies
The currency limitation can be implemented similar to the «JCB, Discover, and Diners Club cards can only be charged in USD»: #28

Provide an ability to make a payment from the Magento 2 backend

• https://mage2.pro/t/1992
• https://mage2.pro/t/2042
• https://mage2.pro/t/3974

«It looks like you have entered an incorrect bank card number»

Creating a custom payment form with Stripe.js is deprecated

https://stripe.com/docs/custom-form

This method of using Stripe.js to collect card information using a custom payment form has been deprecated. When creating a payment form to collect card information, use Stripe Elements—our pre-built UI components. Check out our Elements migration guide to learn how to migrate your checkout flow to Elements.

«To best leverage Stripe’s advanced fraud functionality, include Stripe.js script on every page on your site, not just the checkout page»

https://stripe.com/docs/stripe.js#including-stripejs

Some Stripe's currencies are not supported by American Express

Currencies marked with * are not supported by American Express

https://stripe.com/docs/currencies#presentment-currencies

Implement the 3D Secure verification (optionally, if the Magento store owner wants so)

Stripe users in the United States, Canada, Europe, Hong Kong, and Singapore can process card payments that require authentication with 3D Secure using Sources — a single integration path for creating payments using any supported method.
Users in other countries that Stripe supports can request an invite.

https://stripe.com/docs/sources/three-d-secure

Provide the Bitcoin payments option

Stripe users in the United States can accept Bitcoin for USD payments from customers using Sources — a single integration path for creating payments using any supported method.

https://stripe.com/docs/sources/bitcoin
https://stripe.com/payments/payment-methods-guide#bitcoin
https://mage2.pro/t/4441

«Request does not match any route»

i am still getting this error (Request does not match any route) when trying to pay through stripe test mode.

«element.prop is not a function»

Hi after an update to 2.1.6 the checkout page is going in loop i means it keep loading and nothing is happening, upon checking in inspect elements its showing files from the stripe extension are not loading and getting 404 error Can you please fix this issue for me asap. please let me know if you require login details,

Thanks

Can I get support without paying for the extension?

Interceptors generation... 4/7 [================>-----------] 57% 9 secs 172.0 MiBPHP Fatal error: Class Dfe\Stripe\Method\Interceptor may not inherit from final class (Dfe\Stripe\Method)

Upgrade the Stripe PHP SDK from 3.* to the latest version (5.3.0)

https://github.com/mage2pro/stripe/blob/2.3.4/composer.json#L14
https://github.com/stripe/stripe-php/releases/tag/v5.3.0

Improve handling of the «Your card was declined» Stripe API response

https://sentry.io/dmitry-fedyuk/mage2pro/issues/249492974/

"error": {
	"message": "Your card was declined.",
	"type": "card_error",
	"code": "card_declined",
	"decline_code": "generic_decline",
	"charge": "ch_1A6og3EKzP5C7dKHbsJ4insn"
}

«JCB, Discover, and Diners Club cards can only be charged in USD»

https://stripe.com/docs/currencies#charge-currencies

The Stripe «Elements» technology does not allow to prefill the card number, CVC, and expiration date fields, so the «Prefill the Payment Form with Test Data?» option should be removed

sensitive card information (card number, CVC, and expiration date) cannot be pre-filled.

https://stripe.com/docs/stripe.js#element-options