WC_Stripe_Gateway
in package
Gateway class that abstracts all API calls to Stripe.
Tags
Table of Contents
Properties
- $accountLinks : AccountLinkService
- $accounts : AccountService
- $applePayDomains : ApplePayDomainService
- $applicationFees : ApplicationFeeService
- $balance : BalanceService
- $balanceTransactions : BalanceTransactionService
- $billingPortal : BillingPortalServiceFactory
- $charges : ChargeService
- $checkout : CheckoutServiceFactory
- $countrySpecs : CountrySpecService
- $coupons : CouponService
- $creditNotes : CreditNoteService
- $customers : CustomerService
- $disputes : DisputeService
- $ephemeralKeys : EphemeralKeyService
- $events : EventService
- $exchangeRates : ExchangeRateService
- $fileLinks : FileLinkService
- $files : FileService
- $invoiceItems : InvoiceItemService
- $invoices : InvoiceService
- $issuing : IssuingServiceFactory
- $mandates : MandateService
- $orderReturns : OrderReturnService
- $orders : OrderService
- $paymentIntents : PaymentIntentService
- $paymentMethodConfigurations : PaymentMethodConfigurationService
- $paymentMethods : PaymentMethodService
- $payouts : PayoutService
- $plans : PlanService
- $prices : PriceService
- $products : ProductService
- $radar : RadarServiceFactory
- $refunds : RefundService
- $reporting : ReportingServiceFactory
- $reviews : ReviewService
- $setupIntents : SetupIntentService
- $sigma : SigmaServiceFactory
- $skus : SkuService
- $sources : SourceService
- $subscriptionItems : SubscriptionItemService
- $subscriptions : SubscriptionService
- $subscriptionSchedules : SubscriptionScheduleService
- $taxRates : TaxRateService
- $terminal : TerminalServiceFactory
- $tokens : TokenService
- $topups : TopupService
- $transfers : TransferService
- $webhookEndpoints : WebhookEndpointService
- $client : StripeClient
- $messages : mixed
- $mode : Stripe
- $secret_key : string
Methods
- __construct() : mixed
- __get() : mixed
- attach_payment_method() : mixed
- cancel_payment_intent() : mixed
- capture() : mixed
- capture_payment_intent() : mixed
- charge() : mixed
- confirm_payment_intent() : mixed
- create_customer() : WP_Error|string
- Create a customer within Stripe.
- create_customer_source() : WP_Error|Source
- create_payment_intent() : WP_Error|PaymentIntent
- create_payment_method() : WP_Error|PaymentMethod
- create_setup_intent() : mixed
- create_source() : WP_Error|Source
- create_webhook() : mixed
- delete_card() : mixed
- delete_domain() : mixed
- delete_payment_method() : mixed
- fetch_customer() : mixed
- fetch_customers() : mixed
- fetch_domains() : mixed
- fetch_payment_intent() : WP_Error|PaymentIntent
- fetch_payment_method() : mixed
- fetch_payment_methods() : mixed
- fetch_payment_source() : WP_Error|Source
- fetch_setup_intent() : WP_Error|SetupIntent
- fetch_webhook() : mixed
- get_api_options() : mixed
- get_charge() : Charge|WP_Error
- get_payment_method() : mixed
- get_wp_error() : mixed
- init() : mixed
- load() : WC_Stripe_Gateway
- mode() : $this
- refund() : mixed
- register_domain() : mixed
- set_mode() : mixed
- update_customer() : mixed
- update_payment_intent() : mixed
- update_source() : mixed
- update_webhook() : mixed
- webhooks() : mixed
- get_client_config() : mixed
- get_error_message() : string
Properties
$accountLinks
public
AccountLinkService
$accountLinks
$accounts
public
AccountService
$accounts
$applePayDomains
public
ApplePayDomainService
$applePayDomains
$applicationFees
public
ApplicationFeeService
$applicationFees
$balance
public
BalanceService
$balance
$balanceTransactions
public
BalanceTransactionService
$balanceTransactions
$billingPortal
public
BillingPortalServiceFactory
$billingPortal
$charges
public
ChargeService
$charges
$checkout
public
CheckoutServiceFactory
$checkout
$countrySpecs
public
CountrySpecService
$countrySpecs
$coupons
public
CouponService
$coupons
$creditNotes
public
CreditNoteService
$creditNotes
$customers
public
CustomerService
$customers
$disputes
public
DisputeService
$disputes
$ephemeralKeys
public
EphemeralKeyService
$ephemeralKeys
$events
public
EventService
$events
$exchangeRates
public
ExchangeRateService
$exchangeRates
$fileLinks
public
FileLinkService
$fileLinks
$files
public
FileService
$files
$invoiceItems
public
InvoiceItemService
$invoiceItems
$invoices
public
InvoiceService
$invoices
$issuing
public
IssuingServiceFactory
$issuing
$mandates
public
MandateService
$mandates
$orderReturns
public
OrderReturnService
$orderReturns
$orders
public
OrderService
$orders
$paymentIntents
public
PaymentIntentService
$paymentIntents
$paymentMethodConfigurations
public
PaymentMethodConfigurationService
$paymentMethodConfigurations
$paymentMethods
public
PaymentMethodService
$paymentMethods
$payouts
public
PayoutService
$payouts
$plans
public
PlanService
$plans
$prices
public
PriceService
$prices
$products
public
ProductService
$products
$radar
public
RadarServiceFactory
$radar
$refunds
public
RefundService
$refunds
$reporting
public
ReportingServiceFactory
$reporting
$reviews
public
ReviewService
$reviews
$setupIntents
public
SetupIntentService
$setupIntents
$sigma
public
SigmaServiceFactory
$sigma
$skus
public
SkuService
$skus
$sources
public
SourceService
$sources
$subscriptionItems
public
SubscriptionItemService
$subscriptionItems
$subscriptions
public
SubscriptionService
$subscriptions
$subscriptionSchedules
public
SubscriptionScheduleService
$subscriptionSchedules
$taxRates
public
TaxRateService
$taxRates
$terminal
public
TerminalServiceFactory
$terminal
$tokens
public
TokenService
$tokens
$topups
public
TopupService
$topups
$transfers
public
TransferService
$transfers
$webhookEndpoints
public
WebhookEndpointService
$webhookEndpoints
$client
private
StripeClient
$client
= \null
$messages
private
mixed
$messages
= array()
$mode
private
Stripe
$mode
= \null
mode (test, live)
Tags
$secret_key
private
string
$secret_key
= \null
Tags
Methods
__construct()
public
__construct([mixed $mode = null ][, mixed $secret_key = null ][, mixed $config = array() ]) : mixed
Parameters
- $mode : mixed = null
- $secret_key : mixed = null
- $config : mixed = array()
__get()
public
__get(mixed $key) : mixed
Parameters
- $key : mixed
attach_payment_method()
public
attach_payment_method(mixed $id[, array<string|int, mixed> $args = array() ][, string $mode = '' ]) : mixed
Parameters
- $id : mixed
- $args : array<string|int, mixed> = array()
- $mode : string = ''
cancel_payment_intent()
public
cancel_payment_intent(PaymentIntent|string $id[, string $mode = '' ]) : mixed
Parameters
- $id : PaymentIntent|string
- $mode : string = ''
capture()
public
capture(mixed $id, mixed $args[, mixed $mode = '' ]) : mixed
Parameters
- $id : mixed
- $args : mixed
- $mode : mixed = ''
capture_payment_intent()
public
capture_payment_intent(mixed $id[, mixed $args = array() ][, mixed $mode = '' ]) : mixed
Parameters
- $id : mixed
- $args : mixed = array()
- $mode : mixed = ''
charge()
public
charge(mixed $args[, mixed $mode = '' ]) : mixed
Parameters
- $args : mixed
- $mode : mixed = ''
confirm_payment_intent()
public
confirm_payment_intent(mixed $id[, array<string|int, mixed> $args = array() ][, string $mode = '' ]) : mixed
Parameters
- $id : mixed
- $args : array<string|int, mixed> = array()
- $mode : string = ''
create_customer()
Create a customer within Stripe.
public
create_customer(array<string|int, mixed> $args[, mixed $mode = '' ]) : WP_Error|string
Parameters
- $args : array<string|int, mixed>
- $mode : mixed = ''
Return values
WP_Error|stringcreate_customer_source()
public
create_customer_source(string $customer_id, string $id[, string $mode = '' ]) : WP_Error|Source
Parameters
- $customer_id : string
- $id : string
- $mode : string = ''
Return values
WP_Error|Sourcecreate_payment_intent()
public
create_payment_intent(array<string|int, mixed> $args[, string $mode = '' ]) : WP_Error|PaymentIntent
Parameters
- $args : array<string|int, mixed>
- $mode : string = ''
Return values
WP_Error|PaymentIntentcreate_payment_method()
public
create_payment_method(array<string|int, mixed> $args[, string $mode = '' ]) : WP_Error|PaymentMethod
Parameters
- $args : array<string|int, mixed>
- $mode : string = ''
Return values
WP_Error|PaymentMethodcreate_setup_intent()
public
create_setup_intent(mixed $args[, mixed $mode = '' ]) : mixed
Parameters
- $args : mixed
- $mode : mixed = ''
create_source()
public
create_source(array<string|int, mixed> $args[, string $mode = '' ]) : WP_Error|Source
Parameters
- $args : array<string|int, mixed>
- $mode : string = ''
Return values
WP_Error|Sourcecreate_webhook()
public
create_webhook(mixed $url, mixed $events[, mixed $mode = '' ]) : mixed
Parameters
- $url : mixed
- $events : mixed
- $mode : mixed = ''
delete_card()
public
delete_card(string $id, string $customer[, string $mode = '' ]) : mixed
Parameters
- $id : string
- $customer : string
- $mode : string = ''
delete_domain()
public
delete_domain(mixed $id[, string $mode = '' ]) : mixed
Parameters
- $id : mixed
- $mode : string = ''
Tags
delete_payment_method()
public
delete_payment_method(mixed $id[, string $mode = '' ]) : mixed
Parameters
- $id : mixed
- $mode : string = ''
fetch_customer()
public
fetch_customer(mixed $customer_id[, mixed $mode = '' ]) : mixed
Parameters
- $customer_id : mixed
- $mode : mixed = ''
fetch_customers()
public
fetch_customers([mixed $mode = '' ]) : mixed
Parameters
- $mode : mixed = ''
fetch_domains()
public
fetch_domains([string $mode = '' ]) : mixed
Parameters
- $mode : string = ''
Tags
fetch_payment_intent()
public
fetch_payment_intent(string $id[, string $mode = '' ]) : WP_Error|PaymentIntent
Parameters
- $id : string
- $mode : string = ''
Return values
WP_Error|PaymentIntentfetch_payment_method()
public
fetch_payment_method(mixed $id[, mixed $mode = '' ]) : mixed
Parameters
- $id : mixed
- $mode : mixed = ''
fetch_payment_methods()
public
fetch_payment_methods(mixed $customer_id[, mixed $mode = '' ][, mixed $type = 'card' ]) : mixed
Parameters
- $customer_id : mixed
- $mode : mixed = ''
- $type : mixed = 'card'
fetch_payment_source()
public
fetch_payment_source(string $id[, string $mode = '' ]) : WP_Error|Source
Parameters
- $id : string
- $mode : string = ''
Return values
WP_Error|Sourcefetch_setup_intent()
public
fetch_setup_intent(string $id[, string $mode = '' ]) : WP_Error|SetupIntent
Parameters
- $id : string
- $mode : string = ''
Return values
WP_Error|SetupIntentfetch_webhook()
public
fetch_webhook(mixed $id[, mixed $mode = '' ]) : mixed
Parameters
- $id : mixed
- $mode : mixed = ''
get_api_options()
public
get_api_options([mixed $mode = '' ]) : mixed
Parameters
- $mode : mixed = ''
get_charge()
public
get_charge(string $charge_id[, string $mode = '' ]) : Charge|WP_Error
Parameters
- $charge_id : string
- $mode : string = ''
Return values
Charge|WP_Errorget_payment_method()
public
get_payment_method(mixed $id[, mixed $mode = '' ]) : mixed
Parameters
- $id : mixed
- $mode : mixed = ''
get_wp_error()
public
get_wp_error(ApiErrorException $e[, string $code = 'stripe-error' ]) : mixed
Parameters
- $e : ApiErrorException
- $code : string = 'stripe-error'
Tags
init()
public
static init() : mixed
load()
public
static load([string $mode = null ][, string $secret_key = null ][, mixed $config = array() ]) : WC_Stripe_Gateway
Parameters
- $mode : string = null
- $secret_key : string = null
- $config : mixed = array()
Tags
Return values
WC_Stripe_Gatewaymode()
public
mode(string|WC_Order $mode) : $this
Parameters
- $mode : string|WC_Order
Tags
Return values
$thisrefund()
public
refund(mixed $args[, mixed $mode = '' ]) : mixed
Parameters
- $args : mixed
- $mode : mixed = ''
register_domain()
public
register_domain(mixed $domain[, mixed $mode = '' ]) : mixed
Parameters
- $domain : mixed
- $mode : mixed = ''
set_mode()
public
set_mode(string $mode) : mixed
Parameters
- $mode : string
Tags
update_customer()
public
update_customer(mixed $id, mixed $args[, mixed $mode = '' ]) : mixed
Parameters
- $id : mixed
- $args : mixed
- $mode : mixed = ''
update_payment_intent()
public
update_payment_intent(mixed $id, array<string|int, mixed> $args[, string $mode = '' ]) : mixed
Parameters
- $id : mixed
- $args : array<string|int, mixed>
- $mode : string = ''
update_source()
public
update_source(string $source_id, array<string|int, mixed> $args[, string $mode = '' ]) : mixed
Parameters
- $source_id : string
- $args : array<string|int, mixed>
- $mode : string = ''
Tags
update_webhook()
public
update_webhook(mixed $id, mixed $params[, mixed $mode = '' ]) : mixed
Parameters
- $id : mixed
- $params : mixed
- $mode : mixed = ''
webhooks()
public
webhooks([mixed $mode = '' ]) : mixed
Parameters
- $mode : mixed = ''
get_client_config()
protected
get_client_config() : mixed
get_error_message()
private
get_error_message(mixed $err) : string
Parameters
- $err : mixed