Payments > Gateways > storefrontGateways
Storefront APIPaymentsGatewaysstorefrontGateways
storefrontGateways
GET:storefront/gateways.json

Description

Get all or specific gateways.

This is a typical bulk get endpoint.

Topic: Gateways

Arguments

ids: [String!]

List of gateway ids. See also: Unique Identifiers

Example: ["gw_EQzGqWoY"]


loose: Boolean

When asking for multiple items, allow returning less than was asked (in case some are missing)


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


type: GatewayType

Filter results by gateway type


Result

[Gateway!]

Preview (typescript)

function storefrontGateways(
ids?: string[]
loose?: boolean
shop_id: string
type?: GatewayType | null
): Gateway[]