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

Get Accepted Payment Methods

GET /payments/methods

Request

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-Token in header - required
  • PAT {{PAYMENT_ACCESS_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.

  • order_id in query - integer

    Identifier for the order

  • checkout_id in query - string

    Identifier for the checkout (same as the cart ID)

example

curl --request get \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/payments/methods' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx' \
  --data '{}'

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

response

{
  "data": [
    {
      "id": "bigcommerce.gift_certificate",
      "name": "Gift Certificate",
      "test_mode": false,
      "type": "gift_certificate",
      "supported_instruments": [],
      "stored_instruments": []
    },
    {
      "id": "bigcommerce.store_credit",
      "name": "Store Credit",
      "test_mode": false,
      "type": "store_credit",
      "supported_instruments": [],
      "stored_instruments": []
    },
    {
      "id": "stripe.card",
      "name": "Stripe",
      "test_mode": true,
      "type": "card",
      "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
        }
      ],
      "stored_instruments": [
        {
          "type": "stored_card",
          "brand": "VISA",
          "expiry_month": 9,
          "expiry_year": 2020,
          "issuer_identification_number": "424242",
          "last_4": "4242",
          "token": "050a1e5c982e5905288ec5ec33f292772762033a0704f46fccb16bf1940b51ef",
          "is_default": true
        }
      ]
    }
  ],
  "meta": {}
}