• Namespace
  • Class
  • Tree
  • Deprecated
  • Hook Reference

Namespaces

  • None
  • PaymentPlugins

Classes

  • WC_Payment_Gateway_Stripe
  • WC_Payment_Gateway_Stripe_ACH
  • WC_Payment_Gateway_Stripe_Afterpay
  • WC_Payment_Gateway_Stripe_Alipay
  • WC_Payment_Gateway_Stripe_ApplePay
  • WC_Payment_Gateway_Stripe_Bancontact
  • WC_Payment_Gateway_Stripe_BECS
  • WC_Payment_Gateway_Stripe_Boleto
  • WC_Payment_Gateway_Stripe_CC
  • WC_Payment_Gateway_Stripe_EPS
  • WC_Payment_Gateway_Stripe_FPX
  • WC_Payment_Gateway_Stripe_Giropay
  • WC_Payment_Gateway_Stripe_GooglePay
  • WC_Payment_Gateway_Stripe_GrabPay
  • WC_Payment_Gateway_Stripe_Ideal
  • WC_Payment_Gateway_Stripe_Klarna
  • WC_Payment_Gateway_Stripe_Local_Payment
  • WC_Payment_Gateway_Stripe_Multibanco
  • WC_Payment_Gateway_Stripe_OXXO
  • WC_Payment_Gateway_Stripe_P24
  • WC_Payment_Gateway_Stripe_Payment_Request
  • WC_Payment_Gateway_Stripe_Sepa
  • WC_Payment_Gateway_Stripe_Sofort
  • WC_Payment_Gateway_Stripe_WeChat
  • WC_Payment_Token_Stripe
  • WC_Payment_Token_Stripe_ACH
  • WC_Payment_Token_Stripe_ApplePay
  • WC_Payment_Token_Stripe_CC
  • WC_Payment_Token_Stripe_GooglePay
  • WC_Payment_Token_Stripe_Local
  • WC_Payment_Token_Stripe_Sepa
  • WC_Stripe_Account_Settings
  • WC_Stripe_Admin_Assets
  • WC_Stripe_Admin_Menus
  • WC_Stripe_Admin_Order_Metaboxes
  • WC_Stripe_Admin_Settings
  • WC_Stripe_Admin_User_Edit
  • WC_Stripe_Advanced_Settings
  • WC_Stripe_API_Operation
  • WC_Stripe_API_Request_Filter
  • WC_Stripe_API_Settings
  • WC_Stripe_Constants
  • WC_Stripe_Controller_Cart
  • WC_Stripe_Controller_Checkout
  • WC_Stripe_Controller_Gateway_Settings
  • WC_Stripe_Controller_GooglePay
  • WC_Stripe_Controller_Order_Actions
  • WC_Stripe_Controller_Payment_Intent
  • WC_Stripe_Controller_Payment_Method
  • WC_Stripe_Controller_Plaid
  • WC_Stripe_Controller_Product_Data
  • WC_Stripe_Controller_Source
  • WC_Stripe_Controller_Webhook
  • WC_Stripe_Customer_Manager
  • WC_Stripe_Field_Manager
  • WC_Stripe_Frontend_Scripts
  • WC_Stripe_Gateway
  • WC_Stripe_Gateway_Conversion
  • WC_Stripe_Install
  • WC_Stripe_Manager
  • WC_Stripe_Payment
  • WC_Stripe_Payment_Balance
  • WC_Stripe_Payment_Charge
  • WC_Stripe_Payment_Charge_Local
  • WC_Stripe_Payment_Factory
  • WC_Stripe_Payment_Intent
  • WC_Stripe_Product_Gateway_Option
  • WC_Stripe_Product_Option
  • WC_Stripe_Redirect_Handler
  • WC_Stripe_Rest_API
  • WC_Stripe_Rest_Controller
  • WC_Stripe_Settings_API
  • WC_Stripe_Shortcode_Payment_Buttons
  • WC_Stripe_Shortcodes
  • WC_Stripe_Update
  • WC_Stripe_Utils

Traits

  • WC_Payment_Token_Payment_Method_Trait
  • WC_Payment_Token_Source_Trait
  • WC_Stripe_Controller_Cart_Trait
  • WC_Stripe_Controller_Frontend_Trait
  • WC_Stripe_Local_Payment_Charge_Trait
  • WC_Stripe_Local_Payment_Intent_Trait
  • WC_Stripe_Payment_Charge_Trait
  • WC_Stripe_Payment_Intent_Trait
  • WC_Stripe_Settings_Trait

Functions

  • stripe_wc
  • wc_stripe_add_allowed_html
  • wc_stripe_add_number_precision
  • wc_stripe_api_options
  • wc_stripe_available_payment_gateways
  • wc_stripe_charge_dispute_closed
  • wc_stripe_charge_dispute_created
  • wc_stripe_credit_card_labels
  • wc_stripe_delete_customer
  • wc_stripe_display_prices_including_tax
  • wc_stripe_filter_address_state
  • wc_stripe_filter_order_id
  • wc_stripe_get_account_id
  • wc_stripe_get_available_local_gateways
  • wc_stripe_get_checkout_fields
  • wc_stripe_get_currencies
  • wc_stripe_get_current_page
  • wc_stripe_get_custom_forms
  • wc_stripe_get_customer_id
  • wc_stripe_get_customer_payment_tokens
  • wc_stripe_get_display_items
  • wc_stripe_get_error_messages
  • wc_stripe_get_idempotency_key
  • wc_stripe_get_local_payment_params
  • wc_stripe_get_order_from_source_id
  • wc_stripe_get_order_from_transaction
  • wc_stripe_get_publishable_key
  • wc_stripe_get_secret_key
  • wc_stripe_get_shipping_options
  • wc_stripe_get_site_locale
  • wc_stripe_get_template
  • wc_stripe_get_template_html
  • wc_stripe_hidden_field
  • wc_stripe_log
  • wc_stripe_log_error
  • wc_stripe_log_info
  • wc_stripe_mode
  • wc_stripe_order_cancelled
  • wc_stripe_order_has_shipping_address
  • wc_stripe_order_mode
  • wc_stripe_order_status_completed
  • wc_stripe_output_checkout_error
  • wc_stripe_payment_complete_order_status
  • wc_stripe_payment_gateways
  • wc_stripe_payment_intent_field
  • wc_stripe_pre_orders_active
  • wc_stripe_process_charge_failed
  • wc_stripe_process_charge_succeeded
  • wc_stripe_process_create_refund
  • wc_stripe_process_payment_intent_succeeded
  • wc_stripe_process_shop_subscription_meta
  • wc_stripe_process_source_chargeable
  • wc_stripe_remove_number_precision
  • wc_stripe_remove_order_locks
  • wc_stripe_restore_cart
  • wc_stripe_restore_cart_after_product_checkout
  • wc_stripe_retry_source_chargeable
  • wc_stripe_review_closed
  • wc_stripe_review_opened
  • wc_stripe_save_customer
  • wc_stripe_set_checkout_error
  • wc_stripe_set_idempotency_key
  • wc_stripe_shipping_address_serviceable
  • wc_stripe_stash_cart
  • wc_stripe_stash_product_cart
  • wc_stripe_token_field
  • wc_stripe_update_customer_location
  • wc_stripe_update_option_3_3_13
  • wc_stripe_update_shipping_methods
  • wc_stripe_woocommerce_payment_token_deleted
  • wcs_stripe_active

Class WC_Stripe_Gateway

Gateway class that abstracts all API calls to Stripe.

Package: Stripe\Classes
Author: Payment Plugins
Located at class-wc-stripe-gateway.php

Methods summary

public
# __construct( $mode = null, $secret_key = null )
public static
# init( )
public
# __get( $key )
public static WC_Stripe_Gateway
# load( string $mode = null, string $secret_key = null )

Parameters

$mode
$secret_key

Returns

WC_Stripe_Gateway

Since

3.1.0
public
# set_mode( string $mode )

Parameters

$mode

Since

3.1.0
public WP_Error|string
# create_customer( array $args, $mode = '' )

Create a customer within Stripe.

Create a customer within Stripe.

Parameters

$args
$mode

Returns

WP_Error|string
public
# update_customer( $id, $args, $mode = '' )
public
# charge( $args, $mode = '' )
public WP_Error|Stripe\PaymentIntent
# create_payment_intent( array $args, string $mode = '' )

Parameters

$args
$mode

Returns

WP_Error|Stripe\PaymentIntent
public
# create_setup_intent( $args, $mode = '' )
public
# update_payment_intent( Stripe\PaymentIntent $id, array $args, string $mode = '' )

Parameters

$id
$intent
$args
$mode
public
# confirm_payment_intent( Stripe\PaymentIntent $id, array $args = array(), string $mode = '' )

Parameters

$id
$intent
$args
$mode
public WP_Error|Stripe\PaymentIntent
# fetch_payment_intent( string $id, string $mode = '' )

Parameters

$id
$mode

Returns

WP_Error|Stripe\PaymentIntent
public
# capture_payment_intent( $id, $args = array(), $mode = '' )
public
# cancel_payment_intent( Stripe\PaymentIntent|string $id, string $mode = '' )

Parameters

$id
$mode
public WP_Error|Stripe\SetupIntent
# fetch_setup_intent( string $id, string $mode = '' )

Parameters

$id
$mode

Returns

WP_Error|Stripe\SetupIntent
public
# capture( $id, $args, $mode = '' )
public Stripe\Charge|WP_Error
# get_charge( string $charge_id, string $mode = '' )

Parameters

$charge_id
$mode

Returns

Stripe\Charge|WP_Error
public
# refund( $args, $mode = '' )
public
# get_payment_method( $id, $mode = '' )
public
# attach_payment_method( Stripe\PaymentMethod $id, array $args = array(), string $mode = '' )

Parameters

$id
$payment_method
$args
$mode
public
# fetch_payment_method( $id, $mode = '' )
public
# delete_payment_method( Stripe\PaymentMethod $id, string $mode = '' )

Parameters

$id
$payment_method
$mode
public
# delete_card( string $id, string $customer, string $mode = '' )

Parameters

$id
$customer
$mode
public WP_Error|Stripe\PaymentMethod
# create_payment_method( array $args, string $mode = '' )

Parameters

$args
$mode

Returns

WP_Error|Stripe\PaymentMethod
public WP_Error|Stripe\Source
# fetch_payment_source( string $id, string $mode = '' )

Parameters

$id
$mode

Returns

WP_Error|Stripe\Source
public WP_Error|Stripe\Source
# create_customer_source( string $customer_id, string $id, string $mode = '' )

Parameters

$customer_id
$id
$mode

Returns

WP_Error|Stripe\Source
public WP_Error|Stripe\Source
# create_source( array $args, string $mode = '' )

Parameters

$args
$mode

Returns

WP_Error|Stripe\Source
public
# update_source( string $source_id, array $args, string $mode = '' )

Parameters

$source_id
$args
$mode

Since

3.0.2
public
# fetch_customer( $customer_id, $mode = '' )
public
# fetch_customers( $mode = '' )
public
# fetch_payment_methods( $customer_id, $mode = '', $type = 'card' )
public
# register_domain( $domain, $mode = '' )
public
# fetch_domains( string $mode = '' )

Parameters

$mode

Since

3.1.6
public
# delete_domain( Stripe\ApplePayDomain $id, string $mode = '' )

Parameters

$id
$domain
$mode

Since

3.1.6
public
# webhooks( $mode = '' )
public
# create_webhook( $url, $events, $mode = '' )
public
# update_webhook( $id, $params, $mode = '' )
public
# fetch_webhook( $id, $mode = '' )
public
# get_api_options( $mode = '' )
private string
# get_error_message( mixed $err )

Parameters

$err

Returns

string
public
# get_wp_error( Stripe\Exception\ApiErrorException $e, string $code = 'stripe-error' )

Parameters

$e
$code

Since

3.1.1
public
# mode( string|WC_Order $mode )

Parameters

$mode

Returns


$this

Since

3.3.13

Properties summary

private Stripe $mode

mode (test, live)

mode (test, live)

Since

3.0.5
# null
private array $messages
# array()
private string $secret_key

Since

3.0.8
# null
private Stripe\StripeClient $client
# null

Magic properties

public Stripe\Service\AccountLinkService $accountLinks
public Stripe\Service\AccountService $accounts
public Stripe\Service\ApplePayDomainService $applePayDomains
public Stripe\Service\ApplicationFeeService $applicationFees
public Stripe\Service\BalanceService $balance
public Stripe\Service\BalanceTransactionService $balanceTransactions
public Stripe\Service\BillingPortal\BillingPortalServiceFactory $billingPortal
public Stripe\Service\ChargeService $charges
public Stripe\Service\Checkout\CheckoutServiceFactory $checkout
public Stripe\Service\CountrySpecService $countrySpecs
public Stripe\Service\CouponService $coupons
public Stripe\Service\CreditNoteService $creditNotes
public Stripe\Service\CustomerService $customers
public Stripe\Service\DisputeService $disputes
public Stripe\Service\EphemeralKeyService $ephemeralKeys
public Stripe\Service\EventService $events
public Stripe\Service\ExchangeRateService $exchangeRates
public Stripe\Service\FileLinkService $fileLinks
public Stripe\Service\FileService $files
public Stripe\Service\InvoiceItemService $invoiceItems
public Stripe\Service\InvoiceService $invoices
public Stripe\Service\Issuing\IssuingServiceFactory $issuing
public Stripe\Service\MandateService $mandates
public Stripe\Service\OrderReturnService $orderReturns
public Stripe\Service\OrderService $orders
public Stripe\Service\PaymentIntentService $paymentIntents
public Stripe\Service\PaymentMethodService $paymentMethods
public Stripe\Service\PayoutService $payouts
public Stripe\Service\PlanService $plans
public Stripe\Service\PriceService $prices
public Stripe\Service\ProductService $products
public Stripe\Service\Radar\RadarServiceFactory $radar
public Stripe\Service\RefundService $refunds
public Stripe\Service\Reporting\ReportingServiceFactory $reporting
public Stripe\Service\ReviewService $reviews
public Stripe\Service\SetupIntentService $setupIntents
public Stripe\Service\Sigma\SigmaServiceFactory $sigma
public Stripe\Service\SkuService $skus
public Stripe\Service\SourceService $sources
public Stripe\Service\SubscriptionItemService $subscriptionItems
public Stripe\Service\SubscriptionScheduleService $subscriptionSchedules
public Stripe\Service\SubscriptionService $subscriptions
public Stripe\Service\TaxRateService $taxRates
public Stripe\Service\Terminal\TerminalServiceFactory $terminal
public Stripe\Service\TokenService $tokens
public Stripe\Service\TopupService $topups
public Stripe\Service\TransferService $transfers
public Stripe\Service\WebhookEndpointService $webhookEndpoints
Stripe API documentation generated by ApiGen