Type alias PaymentModule

Type declaration

• paymentCredentials: { credentialsExists: ((query: { paymentCredentialsId: string }) => Promise<boolean>); findPaymentCredential: ((query: { isPreferred?: boolean; paymentCredentialsId?: string; paymentProviderId?: string; userId?: string }, options?: FindOptions) => Promise<PaymentCredentials>); findPaymentCredentials: ((query: Query, options?: FindOptions) => Promise<PaymentCredentials[]>); markPreferred: ((query: { paymentCredentialsId: string; userId: string }) => Promise<void>); removeCredentials: ((paymentCredentialsId: string) => Promise<PaymentCredentials>); upsertCredentials: ((doc: Pick<PaymentCredentials, "userId" | "paymentProviderId" | "_id" | "token"> & { [x: string]: any }) => Promise<string | null>) }

  • credentialsExists: ((query: { paymentCredentialsId: string }) => Promise<boolean>)

    • • (query: { paymentCredentialsId: string }): Promise<boolean>

      • Parameters

        • query: { paymentCredentialsId: string }

          • paymentCredentialsId: string

        Returns Promise<boolean>

  • findPaymentCredential: ((query: { isPreferred?: boolean; paymentCredentialsId?: string; paymentProviderId?: string; userId?: string }, options?: FindOptions) => Promise<PaymentCredentials>)

    • • (query: { isPreferred?: boolean; paymentCredentialsId?: string; paymentProviderId?: string; userId?: string }, options?: FindOptions): Promise<PaymentCredentials>

      • Parameters

        • query: { isPreferred?: boolean; paymentCredentialsId?: string; paymentProviderId?: string; userId?: string }

          • Optional isPreferred?: boolean

          • Optional paymentCredentialsId?: string

          • Optional paymentProviderId?: string

          • Optional userId?: string

        • Optional options: FindOptions

        Returns Promise<PaymentCredentials>

  • findPaymentCredentials: ((query: Query, options?: FindOptions) => Promise<PaymentCredentials[]>)

    • • (query: Query, options?: FindOptions): Promise<PaymentCredentials[]>

      • Parameters

        • query: Query

        • Optional options: FindOptions

        Returns Promise<PaymentCredentials[]>

  • markPreferred: ((query: { paymentCredentialsId: string; userId: string }) => Promise<void>)

    • • (query: { paymentCredentialsId: string; userId: string }): Promise<void>

      • Parameters

        • query: { paymentCredentialsId: string; userId: string }

          • paymentCredentialsId: string

          • userId: string

        Returns Promise<void>

  • removeCredentials: ((paymentCredentialsId: string) => Promise<PaymentCredentials>)

    • • (paymentCredentialsId: string): Promise<PaymentCredentials>

      • Parameters

        • paymentCredentialsId: string

        Returns Promise<PaymentCredentials>

  • upsertCredentials: ((doc: Pick<PaymentCredentials, "userId" | "paymentProviderId" | "_id" | "token"> & { [x: string]: any }) => Promise<string | null>)

    • • (doc: Pick<PaymentCredentials, "userId" | "paymentProviderId" | "_id" | "token"> & { [x: string]: any }): Promise<string | null>

      • Parameters

        • doc: Pick<PaymentCredentials, "userId" | "paymentProviderId" | "_id" | "token"> & { [x: string]: any }

        Returns Promise<string | null>

• paymentProviders: ModuleMutationsWithReturnDoc<PaymentProvider> & { calculate: ((pricingContext: PaymentPricingContext, requestContext: Context) => Promise<PaymentPricingCalculation[]>); cancel: ((paymentProviderId: string, paymentContext: PaymentContext, requestContext: Context) => Promise<boolean>); charge: ((paymentProviderId: string, paymentContext: PaymentContext, requestContext: Context) => Promise<PaymentChargeActionResult | false>); configurationError: ((paymentProvider: PaymentProvider, requestContext: Context) => Promise<PaymentError>); confirm: ((paymentProviderId: string, paymentContext: PaymentContext, requestContext: Context) => Promise<boolean>); count: ((query: PaymentProviderQuery) => Promise<number>); determineDefault: ((paymentProviders: PaymentProvider[], params: { order: Order; paymentCredentials?: PaymentCredentials[] }, requestContext: Context) => Promise<PaymentProvider>); findInterface: ((query: PaymentProvider) => PaymentInterface); findInterfaces: ((query: { type: PaymentProviderType }) => PaymentInterface[]); findProvider: ((query: Query & { paymentProviderId: string }, options?: FindOptions) => Promise<PaymentProvider>); findProviders: ((query: PaymentProviderQuery, options?: FindOptions) => Promise<PaymentProvider[]>); findSupported: ((query: { order: Order }, requestContext: Context) => Promise<PaymentProvider[]>); isActive: ((paymentProvider: PaymentProvider, requestContext: Context) => Promise<boolean>); isPayLaterAllowed: ((paymentProvider: PaymentProvider, requestContext: Context) => Promise<boolean>); pricingSheet: ((params: { calculation: PaymentPricingCalculation[]; currency: string }) => IPaymentPricingSheet); providerExists: ((query: { paymentProviderId: string }) => Promise<boolean>); register: ((paymentProviderId: string, paymentContext: PaymentContext, requestContext: Context) => Promise<any>); sign: ((paymentProviderId: string, paymentContext: PaymentContext, requestContext: Context) => Promise<string>); validate: ((paymentProviderId: string, paymentContext: PaymentContext, requestContext: Context) => Promise<boolean>) }