Skip to main content

PaymentMethodService

Contains methods relating to PaymentMethod entities.

Signature

constructor

method(connection: TransactionalConnection, configService: ConfigService, roleService: RoleService, listQueryBuilder: ListQueryBuilder, eventBus: EventBus, configArgService: ConfigArgService, channelService: ChannelService, customFieldRelationService: CustomFieldRelationService, translatableSaver: TranslatableSaver, translator: TranslatorService) => PaymentMethodService

findAll

method(ctx: RequestContext, options?: ListQueryOptions<PaymentMethod>, relations: RelationPaths<PaymentMethod> = []) => Promise<PaginatedList<PaymentMethod>>

findOne

method(ctx: RequestContext, paymentMethodId: ID, relations: RelationPaths<PaymentMethod> = []) => Promise<PaymentMethod | undefined>

create

method(ctx: RequestContext, input: CreatePaymentMethodInput) => Promise<PaymentMethod>

update

method(ctx: RequestContext, input: UpdatePaymentMethodInput) => Promise<PaymentMethod>

delete

method(ctx: RequestContext, paymentMethodId: ID, force: boolean = false) => Promise<DeletionResponse>

assignPaymentMethodsToChannel

method(ctx: RequestContext, input: AssignPaymentMethodsToChannelInput) => Promise<Array<Translated<PaymentMethod>>>

removePaymentMethodsFromChannel

method(ctx: RequestContext, input: RemovePaymentMethodsFromChannelInput) => Promise<Array<Translated<PaymentMethod>>>

getPaymentMethodEligibilityCheckers

method(ctx: RequestContext) => ConfigurableOperationDefinition[]

getPaymentMethodHandlers

method(ctx: RequestContext) => ConfigurableOperationDefinition[]

getEligiblePaymentMethods

method(ctx: RequestContext, order: Order) => Promise<PaymentMethodQuote[]>

getMethodAndOperations

method(ctx: RequestContext, method: string) => Promise<{ paymentMethod: PaymentMethod; handler: PaymentMethodHandler; checker: PaymentMethodEligibilityChecker | null; }>

getActivePaymentMethods

method(ctx: RequestContext) => Promise<PaymentMethod[]>
Was this chapter helpful?
Report Issue
Edited Feb 25, 2026ยทEdit this page