woocommerce/plugins/woocommerce-blocks/docs/third-party-developers/extensibility/data-store/payment.md

wc/store/payment

Table of Contents

• Overview
• Selectors
  • isExpressPaymentMethodActive
  • getActiveSavedToken
  • getActivePaymentMethod
  • getAvailablePaymentMethods
  • getAvailableExpressPaymentMethods
  • getPaymentMethodData
  • getSavedPaymentMethods
  • getActiveSavedPaymentMethods
  • getShouldSavePaymentMethod
  • getCurrentStatus
  • paymentMethodsInitialized
  • expressPaymentMethodsInitialized

Overview

The payment data store is used to store payment method data and payment processing information. When the payment status changes, the data store will reflect this.

Currently, all the actions are internal-only while we determine which ones will be useful for extensions to interact with. We do not encourage extensions to dispatch actions onto this data store yet.

Selectors

isPaymentPristine

Queries if the status is pristine

Returns

boolean: True if the payment status is pristine, false otherwise.

Example

const store = select( 'wc/store/payment' );
const isPaymentPristine = store.isPaymentPristine();

isPaymentStarted

Queries if the status is started.

Returns

boolean: True if the payment status is started, false otherwise.

Example

const store = select( 'wc/store/payment' );
const isPaymentStarted = store.isPaymentStarted();

isPaymentProcessing

Queries if the status is processing.

Returns

boolean: True if the payment status is processing, false otherwise.

Example

const store = select( 'wc/store/payment' );
const isPaymentProcessing = store.isPaymentProcessing();

isPaymentSuccess

Queries if the status is success.

Returns

boolean: True if the payment status is success, false otherwise.

Example

const store = select( 'wc/store/payment' );
const isPaymentSuccess = store.isPaymentSuccess();

isPaymentFailed

Queries if the status is failed.

Returns

boolean: True if the payment status is failed, false otherwise.

Example

const store = select( 'wc/store/payment' );
const isPaymentFailed = store.isPaymentFailed();

hasPaymentError

Queries if the status is error.

Returns

boolean: True if the payment status is error, false otherwise.

Example

const store = select( 'wc/store/payment' );
const hasPaymentError = store.hasPaymentError();

isPaymentFinished

Checks wether the payment has finished processing. This includes failed payments, payments with errors or successful payments.

Returns

boolean: True if the payment status is success, failed or error, false otherwise.

Example

const store = select( 'wc/store/payment' );
const isPaymentFinished = store.isPaymentFinished();

getCurrentStatus (deprecated)

Returns an object with booleans representing the payment status. This selector is deprecated and will be removed in a future release. Please use the selectors above

Returns

object - The current payment status. This will be an object with the following keys, the values are all booleans:

• isPristine - True if the payment process has not started, does not have an error and has not finished. This is true initially.
• isStarted - True if the payment process has started.
• isProcessing - True if the payment is processing.
• hasError - True if the payment process has resulted in an error.
• hasFailed - True if the payment process has failed.
• isSuccessful - True if the payment process is successful.
• isDoingExpressPayment - True if an express payment method is active, false otherwise

Example

const store = select( 'wc/store/payment' );
const currentStatus = store.getCurrentStatus();

isExpressPaymentMethodActive

Returns whether an express payment method is active, this will be true when the express payment method is open and taking user input. In the case of GPay it is when the modal is open but other payment methods may have different UIs.

Returns

boolean - Whether an express payment method is active.

Example

const store = select( 'wc/store/payment' );
const isExpressPaymentMethodActive = store.isExpressPaymentMethodActive();

getActiveSavedToken

Returns the active saved token. Payment methods that customers have saved to their account have tokens associated with them. If one of these is selected then this selector returns the token that is currently active. If one is not selected this will return an empty string.

Returns

string - The active saved token ID, or empty string if a saved token is not selected.

Example

const store = select( 'wc/store/payment' );
const activeSavedToken = store.getActiveSavedToken();

getActivePaymentMethod

Returns the active payment method's ID.

Returns

string - The active payment method's ID.

Example

const store = select( 'wc/store/payment' );
const activePaymentMethod = store.getActivePaymentMethod();

getAvailablePaymentMethods

Returns the available payment methods. This does not include express payment methods.

Returns

object - The available payment methods. This is currently just an object keyed by the payment method IDs. Each member contains a name entry with the payment method ID as its value.

Example

const store = select( 'wc/store/payment' );
const availablePaymentMethods = store.getAvailablePaymentMethods();

availablePaymentMethods will look like this:

{
    "cheque": {
        name: "cheque",
    },
    "cod": {
        name: "cod",
    },
    "bacs": {
        name: "bacs",
    },
}

getAvailableExpressPaymentMethods

Returns the available express payment methods.

Returns

object - The available express payment methods. This is currently just an object keyed by the payment method IDs. Each member contains a name entry with the payment method ID as its value.

Example

const store = select( 'wc/store/payment' );
const availableExpressPaymentMethods =
	store.getAvailableExpressPaymentMethods();

availableExpressPaymentMethods will look like this:

{
    "payment_request": {
        name: "payment_request",
    },
    "other_express_method": {
        name: "other_express_method",
    },
}

getPaymentMethodData

Returns the current payment method data. This will change every time the active payment method changes and is not persisted for each payment method. For example, if the customer has PayPal selected, the payment method data will be specific to that payment method. If they switch to Stripe, the payment method data will be overwritten by Stripe, and the previous value (when PayPal was selected) will not be available anymore.

Returns

object - The current payment method data. This is specific to each payment method so further details cannot be provided here.

Example

const store = select( 'wc/store/payment' );
const paymentMethodData = store.getPaymentMethodData();

getSavedPaymentMethods

Returns all saved payment methods for the current customer.

Returns

object - The saved payment methods for the current customer. This is an object, it will be specific to each payment method. As an example, Stripe's saved tokens are returned like so:

savedPaymentMethods: {
	cc: [
		{
			method: {
				gateway: 'stripe',
				last4: '4242',
				brand: 'Visa',
			},
			expires: '04/24',
			is_default: true,
			actions: {
				wcs_deletion_error: {
					url: '#choose_default',
					name: 'Delete',
				},
			},
			tokenId: 2,
		},
	];
}

Example

const store = select( 'wc/store/payment' );
const savedPaymentMethods = store.getSavedPaymentMethods();

getActiveSavedPaymentMethods

Returns the saved payment methods for the current customer that are active, i.e. the ones that can be used to pay for the current order.

Returns

object - The saved payment methods for the current customer that are active, i.e. the ones that can be used to pay for this order. This is an object, it will be specific to each payment method. As an example, Stripe's saved tokens are returned like so:

activeSavedPaymentMethods: {
	cc: [
		{
			method: {
				gateway: 'stripe',
				last4: '4242',
				brand: 'Visa',
			},
			expires: '04/24',
			is_default: true,
			actions: {
				wcs_deletion_error: {
					url: '#choose_default',
					name: 'Delete',
				},
			},
			tokenId: 2,
		},
	];
}

getShouldSavePaymentMethod

Returns whether the payment method should be saved to the customer's account.

Returns

boolean - Whether the payment method should be saved. True if it should be, false if it should not be.

Example

const store = select( 'wc/store/payment' );
const shouldSavePaymentMethod = store.getShouldSavePaymentMethod();

paymentMethodsInitialized

Returns whether the payment methods have been initialized.

Returns

boolean - True if the payment methods have been initialized, false if they have not.

Example

const store = select( 'wc/store/payment' );
const paymentMethodsInitialized = store.paymentMethodsInitialized();

expressPaymentMethodsInitialized

Returns whether the express payment methods have been initialized.

Returns

boolean - True if the express payment methods have been initialized, false if they have not.

Example

const store = select( 'wc/store/payment' );
const expressPaymentMethodsInitialized =
	store.expressPaymentMethodsInitialized();

getPaymentResult

Returns the result of the last payment attempt

Returns

object - An object with the following properties:

{
	message: string;
	paymentStatus: 'success' | 'failure' | 'pending' | 'error' | 'not set';
	paymentDetails: Record< string, string > | Record< string, never >;
	redirectUrl: string;
}

Example

const store = select( 'wc/store/payment' );
const expressPaymentMethodsInitialized =
	store.expressPaymentMethodsInitialized();

---

We're hiring! Come work with us!

🐞 Found a mistake, or have a suggestion? Leave feedback about this document here.