List Accepted Payment Methods

GET

https://api.bigcommerce.com/stores/:store_hash/v3/payments/methods

GET

/stores/:store_hash/v3/payments/methods

curl https://api.bigcommerce.com/stores/store_hash/v3/payments/methods \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "id": "bigcommerce.gift_certificate",
      "name": "Gift Certificate",
      "supported_instruments": [],
      "test_mode": false,
      "type": "gift_certificate",
      "stored_instruments": []
    },
    {
      "id": "bigcommerce.store_credit",
      "name": "Store Credit",
      "supported_instruments": [],
      "test_mode": false,
      "type": "store_credit",
      "stored_instruments": []
    },
    {
      "id": "stripe.card",
      "name": "Stripe",
      "supported_instruments": [
        {
          "instrument_type": "VISA",
          "verification_value_required": true
        },
        {
          "instrument_type": "MASTERCARD",
          "verification_value_required": true
        },
        {
          "instrument_type": "AMEX",
          "verification_value_required": true
        },
        {
          "instrument_type": "DISCOVER",
          "verification_value_required": true
        },
        {
          "instrument_type": "JCB",
          "verification_value_required": true
        },
        {
          "instrument_type": "DINERS_CLUB",
          "verification_value_required": true
        },
        {
          "instrument_type": "STORED_CARD",
          "verification_value_required": true
        }
      ],
      "test_mode": true,
      "type": "card",
      "stored_instruments": [
        {
          "brand": "VISA",
          "expiry_month": 9,
          "expiry_year": 2020,
          "issuer_identification_number": "424242",
          "last_4": "4242",
          "token": "050a1e5c982e5905288ec5ec33f292772762033a0704f46fccb16bf1940b51ef",
          "is_default": true,
          "type": "stored_card"
        }
      ]
    }
  ],
  "meta": {}
}

Returns a list of accepted payment methods based on the order_id or checkout_id.

Notes

Use the Create an Order endpoint to generate the order_id.
Orders created will be set to incomplete order status.
The cart ID and checkout ID are the same.

Required Fields

order_id or checkout_id

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Create Payments	create	`store_payments_access_token_create`
Get Payment Methods	read-only	`store_payments_methods_read`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

order_idintegerOptional

The ID of the subject order.

checkout_idstringOptional

The ID of the subject checkout; identical to the cart ID.

Response

A list of accepted payment methods.

datalist of objectsOptional

metaobjectOptional

Response metadata.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error