Design

The Account Payment Stripe Module introduces and extends the following concepts:

Payment

When the Account Payment Stripe Module is activated, the Payment gains new properties used to store the Stripe information from processing payments where the process method of the Payment Journal is Stripe.

A Stripe payment can be processed using a token, a source, or a payment method from the Customer. In the case a payment is processed off-session and requires authorization, an email is sent to the Party with a link to the checkout form. If an error occurs, the error message from Stripe is collected and displayed.

The Capture box can be unchecked so the payment is only authorized when processed. The payment is then captured later.

A scheduled task runs every 15 minutes to charge each processing payment. There is another that also runs every 15 minutes to capture the payments.

If a payment is disputed, it is only updated when the dispute is closed.

The Stripe payments also have a Stripe Pull button which can be used to force an update with the stripe charges.

See also

The Payment concept is introduced by the Account Payment Module.

Stripe Payment Refund

The Stripe Payment Refund represents an order to refund some amount of a Payment.

Once processed, a payment refund can not be changed.

See also

The Stripe Payment Refunds can be found by opening the main menu item:

Financial ‣ Payments ‣ Stripe Refunds

Payment Journal

When the Account Payment Stripe Module is activated, the Payment Journal gains a property for the Stripe Account for those journals where the processing method is Stripe.

See also

The Payment Journal concept is introduced by the Account Payment Module.

Stripe Account

The Stripe Account stores the credentials needed to communicate with the Stripe API.

It also displays the URL to set up on Stripe for the webhooks. For additional security, the signature from Stripe’s requests can be verified if the Webhook Signing Secret is set.

Note

If no webhooks are set up, a scheduled task is run every 15 minutes to fetch new events.

See also

The Stripe Accounts can be found by opening the main menu item:

Financial ‣ Configuration ‣ Payments ‣ Stripe Accounts

Stripe Customer

The Stripe Customer links a Party to a Stripe customer.

A scheduled task runs every hour to create new customers on Stripe and another to delete them if they have become inactivate.

See also

The Stripe Customers can be found by opening the main menu item:

Financial ‣ Payments ‣ Stripe Customers

Stripe Checkout

The Stripe Checkout report renders an HTML document using the Stripe Javascript library to display a checkout form for Payments or Stripe Customers.