Cmdlets for Stripe

Build 24.0.9060

PaymentMethodConfigurations

Create, update, and query Payment Method Configurations in Stripe.

Table Specific Information

Select

Server-Side Query Support

The cmdlet uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the cmdlet.

  • Id and Application support the following operator: =.

You can select:

All payment method configurations:

SELECT * FROM PaymentMethodConfigurations

A payment method configuration by specifying its Id:

SELECT * FROM PaymentMethodConfigurations WHERE Id = 'pmc_1Q3YXeATXQzBWNrl5zbq9orM'

Payment method configurations associated with an application:

SELECT * FROM PaymentMethodConfigurations WHERE Application = 'ca_81Gw6dl5WN1GwS1VOKGC3vPUwwY7HvDD'

Insert

Name column is required to create a new payment method configuration:

INSERT INTO PaymentMethodConfigurations (Name, CardDisplayPreferencePreference, ApplePayLaterDisplayPreferencePreference, PaypalDisplayPreferencePreference, GooglePayDisplayPreferencePreference) VALUES ('homelander', 'on', 'on', 'on', 'on')

Update

To update a payment method configuration, specify the Id:

UPDATE PaymentMethodConfigurations SET GooglePayDisplayPreferencePreference = 'off' WHERE Id='pmc_1Q3YXeATXQzBWNrl5zbq9orM'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Id of the Payment Method Configuration.

Active Boolean False

Whether the configuration can be used for new payments.

Application String True

For child configs, the Connect application associated with the configuration.

IsDefault Boolean True

The default configuration is used whenever a payment method configuration is not specified.

Name String False

The configuration's name.

Parent String False

For child configs, the configuration's parent configuration.

Livemode Boolean True

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Object String True

String representing the object's type. Objects of the same type share the same value.

AcssDebitAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

AcssDebitDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

AcssDebitDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

AcssDebitDisplayPreferenceValue String True

The effective display preference value.

AffirmAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

AffirmDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

AffirmDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

AffirmDisplayPreferenceValue String True

The effective display preference value.

AfterpayClearpayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

AfterpayClearpayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

AfterpayClearpayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

AfterpayClearpayDisplayPreferenceValue String True

The effective display preference value.

AlipayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

AlipayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

AlipayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

AlipayDisplayPreferenceValue String True

The effective display preference value.

AmazonPayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

AmazonPayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

AmazonPayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

AmazonPayDisplayPreferenceValue String True

The effective display preference value.

ApplePayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

ApplePayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

ApplePayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

ApplePayDisplayPreferenceValue String True

The effective display preference value.

AuBecsDebitAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

AuBecsDebitDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

AuBecsDebitDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

AuBecsDebitDisplayPreferenceValue String True

The effective display preference value.

BacsDebitAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

BacsDebitDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

BacsDebitDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

BacsDebitDisplayPreferenceValue String True

The effective display preference value.

BancontactAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

BancontactDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

BancontactDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

BancontactDisplayPreferenceValue String True

The effective display preference value.

BlikAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

BlikDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

BlikDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

BlikDisplayPreferenceValue String True

The effective display preference value.

BoletoAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

BoletoDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

BoletoDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

BoletoDisplayPreferenceValue String True

The effective display preference value.

CardAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

CardDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

CardDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

CardDisplayPreferenceValue String True

The effective display preference value.

CartesBancairesAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

CartesBancairesDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

CartesBancairesDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

CartesBancairesDisplayPreferenceValue String True

The effective display preference value.

CashappAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

CashappDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

CashappDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

CashappDisplayPreferenceValue String True

The effective display preference value.

CustomerBalanceAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

CustomerBalanceDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

CustomerBalanceDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

CustomerBalanceDisplayPreferenceValue String True

The effective display preference value.

EpsAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

EpsDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

EpsDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

EpsDisplayPreferenceValue String True

The effective display preference value.

FpxAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

FpxDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

FpxDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

FpxDisplayPreferenceValue String True

The effective display preference value.

GiropayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

GiropayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

GiropayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

GiropayDisplayPreferenceValue String True

The effective display preference value.

GooglePayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

GooglePayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

GooglePayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

GooglePayDisplayPreferenceValue String True

The effective display preference value.

GrabpayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

GrabpayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

GrabpayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

GrabpayDisplayPreferenceValue String True

The effective display preference value.

IdealAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

IdealDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

IdealDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

IdealDisplayPreferenceValue String True

The effective display preference value.

JcbAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

JcbDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

JcbDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

JcbDisplayPreferenceValue String True

The effective display preference value.

KlarnaAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

KlarnaDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

KlarnaDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

KlarnaDisplayPreferenceValue String True

The effective display preference value.

KonbiniAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

KonbiniDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

KonbiniDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

KonbiniDisplayPreferenceValue String True

The effective display preference value.

LinkAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

LinkDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

LinkDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

LinkDisplayPreferenceValue String True

The effective display preference value.

MobilepayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

MobilepayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

MobilepayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

MobilepayDisplayPreferenceValue String True

The effective display preference value.

MultibancoAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

MultibancoDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

MultibancoDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

MultibancoDisplayPreferenceValue String True

The effective display preference value.

OxxoAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

OxxoDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

OxxoDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

OxxoDisplayPreferenceValue String True

The effective display preference value.

P24Available Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

P24DisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

P24DisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

P24DisplayPreferenceValue String True

The effective display preference value.

PaynowAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

PaynowDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

PaynowDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

PaynowDisplayPreferenceValue String True

The effective display preference value.

PaypalAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

PaypalDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

PaypalDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

PaypalDisplayPreferenceValue String True

The effective display preference value.

PromptpayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

PromptpayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

PromptpayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

PromptpayDisplayPreferenceValue String True

The effective display preference value.

RevolutPayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

RevolutPayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

RevolutPayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

RevolutPayDisplayPreferenceValue String True

The effective display preference value.

SepaDebitAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

SepaDebitDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

SepaDebitDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

SepaDebitDisplayPreferenceValue String True

The effective display preference value.

SofortAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

SofortDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

SofortDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

SofortDisplayPreferenceValue String True

The effective display preference value.

SwishAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

SwishDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

SwishDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

SwishDisplayPreferenceValue String True

The effective display preference value.

TwintAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

TwintDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

TwintDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

TwintDisplayPreferenceValue String True

The effective display preference value.

UsBankAccountAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

UsBankAccountDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

UsBankAccountDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

UsBankAccountDisplayPreferenceValue String True

The effective display preference value.

WechatPayAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

WechatPayDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

WechatPayDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

WechatPayDisplayPreferenceValue String True

The effective display preference value.

ZipAvailable Boolean True

Whether this payment method may be offered at checkout. True if display_preference is on and the payment method’s capability is active.

ZipDisplayPreferenceOverridable Boolean True

For child configs, whether or not the account’s preference will be observed. If false, the parent configuration’s default is used.

ZipDisplayPreferencePreference String False

The account's display preference.

The allowed values are none, off, on.

ZipDisplayPreferenceValue String True

The effective display preference value.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ApplePayLaterDisplayPreferencePreference String

The account’s preference for whether or not to display this payment method. Used only in INSERT and UPDATE operations.

The allowed values are none, off, on.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060