PaymentMethods
Returns available payment methods for a given order or checkout.
Table Specific Information
Select
The component uses the BigCommerce API to process WHERE clause conditions built with the following columns and operator:
- OrderId supports the = operator.
- CheckoutId supports the = operator.
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 of "Incomplete".
SELECT * FROM PaymentMethods;
Columns
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this payment method. |
| Name | String | The name of this payment method. |
| TestMode | Boolean | Indicates whether this payment method is in test mode. |
| StoredInstruments | String | The stored instruments associated with this payment method. |
| SupportedInstruments | String | The supported instruments for this payment method. |
| Type | String | The type used to classify this payment method. |
| OrderId | String | The Id of the order associated with this payment method. |
| CheckoutId | String | The Id of the checkout associated with this payment method; 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}. |