PaymentMethods
Lists all payment methods.
Table Specific Information
Select
The cmdlet uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- OrderId supports the = comparison.
- CheckoutId supports the = comparison.
For example, the following queries are processed server-side:
SELECT * FROM PaymentMethods WHERE OrderId = 2;
SELECT * FROM PaymentMethods WHERE CheckoutId = 2;
The following query retrieves results for the OrderIds that have a status = Incomplete.
SELECT * FROM PaymentMethods;
Columns
| Name | Type | References | Description |
| Id [KEY] | String | Identifier for this payment method | |
| Name | String | Name of this payment method | |
| TestMode | Boolean | Whether this payment method is on test mode | |
| StoredInstruments | String | Stored Instruments of payment method | |
| SupportedInstruments | String | Supported Instruments of payment method | |
| Type | String | Type to classify this payment method | |
| OrderId | String | The ID of the subject order. | |
| CheckoutId | String | The ID of the subject checkout; identical to the cart ID. | |
| RowId [KEY] | String | A unique identifier for payment methods, generated by combining the OrderId (or CheckoutId) with the Id. When OrderId is present, the format is o_{OrderId}_{id}; otherwise, it is c_{CheckoutId}_{id}. |