List Payment Providers

GET/store/:storeCode/payment-providers

publishable key

List payment providers available for a region.

Path Parameters

storeCoderequiredstring

Store slug in the URL (first argument to every SDK store method).

Query Parameters

region_idrequiredstring

Region ID to list providers for.

limitnumber

Maximum number of items to return.

offsetnumber

Number of items to skip before collecting the result set.

orderstring

Field to sort by. Prefix with `-` for descending order (e.g. `-created_at`).

fieldsstring

Comma-separated fields to include. Prefix with `*` to expand a relation (e.g. `id,*variants`).

Response

Status

200OK

Schema

Copy

HttpTypes.StorePaymentProviderListResponse

Properties

payment_providersrequiredStorePaymentProvider[]

Available payment providers.

countrequirednumber

Total count.

offsetrequirednumber

Offset applied.

limitrequirednumber

Limit applied.