Stripe (Tokenized)

Take card payments through Stripe's secure card field on your own pages, and let clients keep a card for later payments and automatic renewals.

Reaching the Screen

Go to Settings → Financial → Payment Gateways, open All Modules and click the Stripe (Tokenized) card: {admin}/modules/payment?module=StripeTokenized

Adding the gateway to the method list clients see is covered in Payment Configuration.

What Is on the Screen

One short settings form: the Stripe key pair, the notification signing secret and the shared gateway settings every module carries.

The client types the card into Stripe's secure card field, shown inside your checkout, invoice and add-funds pages. The card number goes straight to Stripe and never passes through your server. A card that needs 3-D verification opens the bank's check and then returns to your site.

The module also stores cards for later use, charges a stored card automatically and refunds a payment from the invoice screen. It does not open subscriptions and does not offer installments.

Before You Configure It

• A Stripe account with its key pair. Test keys and live keys are two separate pairs.
• The currencies you sell in enabled on the Stripe account.
• For stored cards and automatic renewal payments, this module selected under Card Storage Module on the Initial tab.

Fields

The key pair alone decides the environment: test keys charge in a Stripe sandbox, live keys take real payments.

Status, Commission Rate (%), Converting Currency, Accepted Amount Range and the country lists work the same way in every gateway. See Payment Configuration. Callback URL, Success URL and Failed URL cannot be edited: copy them with the icon at the end of the field.

Tasks

Take the keys from Stripe

1. Sign in to the Stripe dashboard. For test keys switch to a sandbox from the account picker; for real payments stay in live mode.
2. Open the Developers menu, click Workbench and go to API keys.
3. Copy the publishable key and the secret key from Standard keys. Sandbox keys start with pk_test_ and sk_test_, live keys with pk_live_ and sk_live_.
4. In live mode a secret key you created is shown once. When it is lost, roll it from the same page and copy the new value.

Enter the credentials

1. Open the module card and tick Status. The other fields stay locked until you do.
2. Fill in API Key and Secret Key from the same pair.
3. Click Save Changes. Clients who pick this method now see Stripe's card field.

Let clients keep their card

1. Go back to Settings → Financial → Payment Gateways and open the Initial tab.
2. Choose Stripe (Tokenized) under Card Storage Module and click Save Changes.
3. Clients can now add a card from their account, pick a stored card at checkout and turn on automatic payment.

What the client goes through

1. The client selects the card method at checkout, on an invoice or when adding funds.
2. The client types the card into Stripe's card field, or picks a card kept earlier. Ticking the save box keeps the new card.
3. If the bank asks for 3-D verification, the client confirms it and comes back to your site.
4. The charge closes the invoice and the service is activated.

How the client adds a card from the account

1. On the Saved Cards tab of the account settings, the client clicks Add Card and then Continue.
2. A Stripe window opens. The client types the card and clicks Save card.
3. If the bank asks for 3-D verification, the client completes it in the same window.
4. The window closes and the card appears in the list under the account holder's name.

Charge renewals from a stored card

1. The client turns on automatic payment for a stored card in their account.
2. On a due renewal invoice the system uses account balance first, then the stored cards in the client's order of preference.
3. A successful charge closes the invoice. When every card fails, the client receives the failed-payment notification and the invoice stays open.

Refund a payment

1. Open the paid invoice: {admin}/invoices/detail?id={invoice}
2. Change the status to Refunded, choose Refund via payment gateway and click Update Status.
3. Stripe returns the invoice's payment to the card. When one charge closed several invoices, each invoice returns only its own share.

In 5.0-beta.4 and earlier, a charge that closed a single invoice cannot be refunded through the module. Refund it from the Stripe dashboard, then mark the invoice Refunded with Add as expense.

Things to Watch

Required Privileges

Payment Gateways (MODULES_PAYMENT_SETTINGS) is required.

Related Articles

• Payment Configuration
• Invoice Detail Overview
• Module Management