Thanks for being patient while we implement your feedback to improve the developer experience.

Payment Methods (Deprecated)

The Payments API processes payments using payment instruments such as credit cards or PayPal accounts. To learn more about Payments, see the Payments Overview.

This endpoint is deprecated. Use Get accepted payment methods instead.

The V3 version of this endpoint contains more information about the payment methods each payment gateway accepts. The additional information enables your application and BigCommerce to make the most likely-to-succeed payment request to the gateway, without using extra middleware or making preparatory API calls to the gateway on your end prior to running the payment. Use Get accepted payment methods for a leaner, more optimized application.

To learn more about authenticating Payments endpoints, locate the Authentication section at the top of each endpoint, then click Show Details.

Resources

Webhooks

Payments endpoints

Get All Payment Methods

GET /payments/methods

⚠️
This endpoint is deprecated.

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 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

Body

array | application/json

  • code    string

    Unique platform-wide code identifying the payment method.

    Example: squarev2

  • name    string

    Descriptive name of the payment method.

    Example: Square

  • test_mode    boolean

    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
}