Skip to main content

PaymentMethod

A payment method known to the shop. Used to reference a customer's default payment method.

type PaymentMethod implements Node {
id: ID!
name: String
salesChannelDefaultAssignments(
first: Int = 10
after: String
filter: SalesChannelFilterInput
): SalesChannelConnection
customers(
first: Int = 10
after: String
filter: CustomerFilterInput
): CustomerConnection
salesChannels(
first: Int = 10
after: String
filter: SalesChannelFilterInput
): SalesChannelConnection
}

Fields

PaymentMethod.id ● ID! non-null scalar

Global identifier for this entity.

PaymentMethod.name ● String scalar

Localised display name of the payment method.

PaymentMethod.salesChannelDefaultAssignments ● SalesChannelConnection object

PaymentMethod.salesChannelDefaultAssignments.first ● Int scalar
PaymentMethod.salesChannelDefaultAssignments.after ● String scalar
PaymentMethod.salesChannelDefaultAssignments.filter ● SalesChannelFilterInput input

PaymentMethod.customers ● CustomerConnection object

PaymentMethod.customers.first ● Int scalar
PaymentMethod.customers.after ● String scalar
PaymentMethod.customers.filter ● CustomerFilterInput input

PaymentMethod.salesChannels ● SalesChannelConnection object

PaymentMethod.salesChannels.first ● Int scalar
PaymentMethod.salesChannels.after ● String scalar
PaymentMethod.salesChannels.filter ● SalesChannelFilterInput input

Interfaces

Node interface

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By

paymentMethod query

Member Of

Customer object ● PaymentMethodEdge object ● SalesChannel object