Payment Methods
Get a list of a store's enabled payment methods. For processing payments, see Payment Processing API.
Get All Payment Methods
GET /stores/{store_hash}/v2/payments/methods
Request
Gets the list of enabled payment methods. Default sorting is by payment method, alphabetically from A to Z.
Note
Avoid using this API operation if possible. It is not supported; therefore, all enabled providers may not appear.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string - required
The MIME type of the response body.
- page in query - number
Optional filter param
/api/v2/payments/methods?page={number} - limit in query - number
Optional filter param
/api/v2/payments/methods?limit={count}
example
curl --request get \ --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/payments/methods' \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx' \ --data '{}'
Response
Body
codestring
Unique platform-wide code identifying the payment method.
Example: squarev2
namestring
Descriptive name of the payment method.
Example: Square
test_modeboolean
Determines whether the payment gateway is in test mode. Always false for offline payment methods.
Example: false
example
{ "code": "squarev2", "name": "Square", "test_mode": false }