GET
/
store
/
payment-providers
import Medusa from "@medusajs/js-sdk"

let MEDUSA_BACKEND_URL = "http://localhost:9000"

if (process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL) {
  MEDUSA_BACKEND_URL = process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL
}

export const sdk = new Medusa({
  baseUrl: MEDUSA_BACKEND_URL,
  debug: process.env.NODE_ENV === "development",
  publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
})

sdk.store.payment.listPaymentProviders({
  region_id: "reg_123"
})
.then(({ payment_providers, count, offset, limit }) => {
  console.log(payment_providers)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "payment_providers": [
    {
      "id": "<string>"
    }
  ]
}

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
region_id
string
required

Filter by a region ID to get the payment providers enabled in that region.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The list of payment providers.