Gatemi Stripe for WooCommerce Developer Reference

Everything below is applied in the plugin's code. Identifiers use the gmstripe_ prefix; the namespace is GatemiStripe.

Gateway ids

One WooCommerce gateway per payment method, with the id gmstripe_{method}: gmstripe_card, gmstripe_apple_pay, gmstripe_google_pay, gmstripe_link, gmstripe_sepa_debit, gmstripe_us_bank_account, gmstripe_becs_debit, gmstripe_ideal, gmstripe_bancontact, gmstripe_klarna, gmstripe_afterpay_clearpay, gmstripe_oxxo, gmstripe_boleto and so on — the method ids in the catalog.

Filters

gmstripe_payment_methods

The catalog of payment methods, keyed by method id. An extension adds a method by adding a row — there is no class to subclass, because one gateway class is instantiated once per row.

Row key Type
type string The Stripe payment method type (defaults to the id)
title, description string Shown at checkout
flow string element (inline Stripe Element), redirect (to the provider and back; the default) or wallet (express button)
currencies string[] ISO codes; empty means any
countries string[] Billing countries; empty means any
manual_capture bool Can be authorised now and captured later
recurring bool Can be saved and charged again
mandate bool A bank debit that carries a mandate
add_filter( 'gmstripe_payment_methods', function ( $catalog ) {
	$catalog['example_pay'] = array(
		'type'       => 'example_pay',
		'title'      => 'Example Pay',
		'flow'       => 'redirect',
		'currencies' => array( 'EUR' ),
		'countries'  => array( 'NL', 'BE' ),
	);
	return $catalog;
} );

The new method then appears under Payment methods on the settings screen and is offered only within its limits. It must also be a type your Stripe account supports.

gmstripe_payment_intent_args

The arguments sent to Stripe when a Payment Intent is created or updated.

Argument Type
$args array — the request body
$order WC_Order
$method PaymentMethod

Return a non-array and the original arguments are used.

add_filter( 'gmstripe_payment_intent_args', function ( $args, $order ) {
	$args['metadata']['warehouse'] = 'north';
	return $args;
}, 10, 2 );

gmstripe_order_intent_id

The payment intent id stored on an order ($stored, $order). The migration layer answers here with another Stripe plugin's intent id, so past orders can be refunded.

gmstripe_gateway_supports

The features a gateway declares ($supports, $method). Every gateway supports products and refunds; reusable methods add tokenization and add_payment_method when saving is on; the subscriptions module adds its own list when WooCommerce Subscriptions is active.

gmstripe_is_payment_page

Whether the current request collects a payment (default: is_checkout(), the order-pay page or the add-payment-method page). Return true for a custom checkout template where is_checkout() is false, or the payment fields will not load.

gmstripe_express_locations

Where the express wallet buttons appear: any of product, cart, checkout. The add-ons and German Market integrations remove placements here.

gmstripe_express_missing_fields

Labels of required checkout fields a wallet payment cannot fill. When the list is not empty, the express payment is refused with those fields named. Shipping fields are only checked when the cart needs shipping. Clear a field that has a sensible default rather than lose express checkout over it.

gmstripe_product_has_addons

Whether a product has priced add-ons ($has_addons, $product_id). Applied only when none of the supported add-on plugins' meta (_product_addons, tm_meta, _wcpa_product_fields) was found. Return true and the express button is removed from that product.

gmstripe_gateway_id_map

The map of another plugin's gateway id to this plugin's gateway id, used to read old orders and subscriptions after a migration.

gmstripe_integrations

The list of third-party integrations (each implementing CompatIntegrationInterface). Only integrations whose plugin is present are loaded.

gmstripe_currency_exponent

Decimal places Stripe expects for a currency ($exponent, $currency). Defaults to 0 for zero-decimal currencies, 3 for BHD, KWD, OMR and the other three-decimal currencies, otherwise 2.

Requests and webhooks

Filter Default
gmstripe_request_max_retries 2 Retries for a failed request to Stripe, clamped to 0–5. Receives the API path. A retry reuses the same idempotency key
gmstripe_request_timeout 30 Request timeout in seconds. Receives the API path
gmstripe_webhook_tolerance 300 How old a signed webhook may be, in seconds. 0 disables the age check

gmstripe_modules

The modules booted, in order. For tests and unusual setups.

Actions

Action Arguments When
gmstripe_booted the plugin container After every module has booted
gmstripe_installed — First boot with no stored version
gmstripe_upgraded old version, new version Boot at a version other than the stored one
gmstripe_webhook_{type} the event's data object, the whole event After a verified webhook event is handled. Dots become underscores: gmstripe_webhook_charge_dispute_created
add_action( 'gmstripe_webhook_charge_dispute_created', function ( $dispute, $event ) {
	wp_mail( get_option( 'admin_email' ), 'New Stripe dispute', $dispute['id'] ?? '' );
}, 10, 2 );

The action fires for every verified event type, including ones the plugin does not act on itself — so you can subscribe your Stripe endpoint to an extra event and handle it here.

REST route

POST /wp-json/gatemi-stripe/v1/webhook — the Stripe webhook endpoint. Public (permission_callback returns true) and trusted only after the Stripe-Signature header is verified against the signing secret of the current mode.

AJAX endpoints (?wc-ajax=)

Endpoint Used by
gmstripe_intent_secret Fetches a client secret for a 3-D Secure challenge, nonce-checked
gmstripe_complete_payment Reports back after a challenge
gmstripe_cart_total The current cart amount, for instalment messaging
gmstripe_express_address Shipping quote when the wallet address changes
gmstripe_express_rate Shipping method chosen in the wallet sheet
gmstripe_express_checkout Builds and pays the order from an express wallet

A redirect method returns to the order-received page with gmstripe_return=1, order_id and a nonce (gmstripe_return_{order_id}).

Shortcode

[gmstripe_express_buttons] — the Apple Pay / Google Pay buttons anywhere. Attributes: align (left or center, default left) and width (a CSS max-width, e.g. 320px).

[gmstripe_express_buttons align="center" width="320px"]

Options

Option
gmstripe_settings Every setting on WooCommerce → Stripe
gmstripe_version Installed version
gmstripe_seen_{event_id} One per handled webhook event, claimed with a single INSERT IGNORE (never add_option(), which upserts); autoload off; swept after three days
woocommerce_gmstripe_{method}_settings Each gateway's title, description and order status (WooCommerce's settings API)

Order meta

Key
_gmstripe_intent_id The Payment Intent id
_gmstripe_payment_method_id The Stripe payment method used
_gmstripe_mode test or live — every later refund, capture and void uses this mode's keys
_gmstripe_captured Whether funds are captured or only authorised
_gmstripe_fee, _gmstripe_net, _gmstripe_balance_currency Stripe's fee and the net, in your payout currency
_gmstripe_source checkout, blocks, express, renewal or preorder
_gmstripe_voucher_url, _gmstripe_voucher_number, _gmstripe_voucher_expires OXXO, Boleto, Konbini and Multibanco vouchers
_gmstripe_pre_dispute_status, _gmstripe_pre_review_status Where the order stood before a dispute or Radar review held it
_gmstripe_renewal_payment_method The saved method renewals and pre-orders are charged against

All order meta is read and written through the order object, so HPOS and the legacy posts store are one code path.

Product and user meta

Key On
_gmstripe_blocked_methods Product Array of method ids — Never offer these methods
_gmstripe_allowed_methods Product Array of method ids — Offer only these methods
_gmstripe_customer_id_test, _gmstripe_customer_id_live User The shopper's Stripe Customer id per mode

Cron

gmstripe_purge_webhook_claims — daily, deletes webhook claims older than three days.

Logs

WooCommerce → Status → Logs, source gmstripe. Requests and responses are logged when Log Stripe requests is on, with keys and card numbers removed; errors are always logged.

CSS classes

Class Element
.gmstripe-element The container the Payment Element is mounted in
.gmstripe-error The error line under it
.gmstripe-express An express button container
.gmstripe-express--product, --cart, --checkout, --shortcode Its placement
.gmstripe-express__error An express error message
.gmstripe-messaging The instalment message under a price

The card fields themselves are inside Stripe's iframe and are styled by Stripe, not by your theme's CSS.

Shopping Cart
Scroll to Top