Sign in
Ecommerce: Payments

List store payment providers

List a store's payment providers, split into providers already connected to the store and gateways available to install. Never exposes gateway credentials, secrets, or configuration.

get/api/ecommerce/v1/stores/{store_id}/payment-providers

Path parameters

store_idstring required
Example:store_01J8Z5F8W9K8M4A7B3C2D1E0FG

The ID of the store to list payment providers for.

Query parameters

include_currency_unsupportedboolean
Example:true

Include gateways that do not support the store currency in the available list.

Response

Success response

Example response

{
  "data": {
    "connected": [
      {
        "id": "storepp_01J8Z5F8W9K8M4A7B3C2D1E0FG",
        "provider_id": "stripe",
        "title": "Stripe",
        "is_enabled": true,
        "status": "connected",
        "shows_at_checkout": true
      }
    ],
    "available": [
      {
        "id": "stripe",
        "is_currency_supported": true,
        "supported_currencies": [
          "usd"
        ]
      }
    ]
  }
}

Changes

Changed in 1 of the 88 revisions of this API.1