Type alias OrderPaymentsModule

Type declaration

• cancel: ((orderPayment: OrderPayment, paymentContext: any, requestContext: Context) => Promise<OrderPayment>)

  • • (orderPayment: OrderPayment, paymentContext: any, requestContext: Context): Promise<OrderPayment>

    • Parameters

      • orderPayment: OrderPayment

      • paymentContext: any

      • requestContext: Context

      Returns Promise<OrderPayment>

• charge: ((orderPayment: OrderPayment, paymentContext: any, requestContext: Context) => Promise<OrderPayment>)

  • • (orderPayment: OrderPayment, paymentContext: any, requestContext: Context): Promise<OrderPayment>

    • Parameters

      • orderPayment: OrderPayment

      • paymentContext: any

      • requestContext: Context

      Returns Promise<OrderPayment>

• confirm: ((orderPayment: OrderPayment, paymentContext: any, requestContext: Context) => Promise<OrderPayment>)

  • • (orderPayment: OrderPayment, paymentContext: any, requestContext: Context): Promise<OrderPayment>

    • Parameters

      • orderPayment: OrderPayment

      • paymentContext: any

      • requestContext: Context

      Returns Promise<OrderPayment>

• countOrderPaymentsByContextData: ((params: { context: any }, options?: FindOptions) => Promise<number>)

  • • (params: { context: any }, options?: FindOptions): Promise<number>

    • Parameters

      • params: { context: any }

        • context: any

      • Optional options: FindOptions

      Returns Promise<number>

• create: ((doc: OrderPayment, userId?: string) => Promise<OrderPayment>)

  • • (doc: OrderPayment, userId?: string): Promise<OrderPayment>

    • Parameters

      • doc: OrderPayment

      • Optional userId: string

      Returns Promise<OrderPayment>

• discounts: ((orderPayment: OrderPayment, params: { order: Order; orderDiscount: OrderDiscount }, requestContext: Context) => OrderPricingDiscount[])

  • • (orderPayment: OrderPayment, params: { order: Order; orderDiscount: OrderDiscount }, requestContext: Context): OrderPricingDiscount[]

    • Parameters

      • orderPayment: OrderPayment

      • params: { order: Order; orderDiscount: OrderDiscount }

        • order: Order

        • orderDiscount: OrderDiscount

      • requestContext: Context

      Returns OrderPricingDiscount[]

• findOrderPayment: ((params: { orderPaymentId: string }, options?: FindOptions) => Promise<OrderPayment>)

  • • (params: { orderPaymentId: string }, options?: FindOptions): Promise<OrderPayment>

    • Parameters

      • params: { orderPaymentId: string }

        • orderPaymentId: string

      • Optional options: FindOptions

      Returns Promise<OrderPayment>

• findOrderPaymentByContextData: ((params: { context: any }, options?: FindOptions) => Promise<OrderPayment>)

  • • (params: { context: any }, options?: FindOptions): Promise<OrderPayment>

    • Parameters

      • params: { context: any }

        • context: any

      • Optional options: FindOptions

      Returns Promise<OrderPayment>

• isBlockingOrderConfirmation: ((orderPayment: OrderPayment, requestContext: Context) => Promise<boolean>)

  • • (orderPayment: OrderPayment, requestContext: Context): Promise<boolean>

    • Parameters

      • orderPayment: OrderPayment

      • requestContext: Context

      Returns Promise<boolean>

• isBlockingOrderFullfillment: ((orderPayment: OrderPayment) => boolean)

  • • (orderPayment: OrderPayment): boolean

    • Parameters

      • orderPayment: OrderPayment

      Returns boolean

• logEvent: ((orderPaymentId: string, event: any, userId?: string) => Promise<boolean>)

  • • (orderPaymentId: string, event: any, userId?: string): Promise<boolean>

    • Parameters

      • orderPaymentId: string

      • event: any

      • Optional userId: string

      Returns Promise<boolean>

• markAsPaid: ((payment: OrderPayment, meta: any, userId?: string) => Promise<void>)

  • • (payment: OrderPayment, meta: any, userId?: string): Promise<void>

    • Parameters

      • payment: OrderPayment

      • meta: any

      • Optional userId: string

      Returns Promise<void>

• normalizedStatus: ((orderPayment: OrderPayment) => string)

  • • (orderPayment: OrderPayment): string

    • Parameters

      • orderPayment: OrderPayment

      Returns string

• pricingSheet: ((orderPayment: OrderPayment, currency: string, requestContext: Context) => IPaymentPricingSheet)

  • • (orderPayment: OrderPayment, currency: string, requestContext: Context): IPaymentPricingSheet

    • Parameters

      • orderPayment: OrderPayment

      • currency: string

      • requestContext: Context

      Returns IPaymentPricingSheet

• updateCalculation: ((orderPayment: OrderPayment, requestContext: Context) => Promise<OrderPayment>)

  • • (orderPayment: OrderPayment, requestContext: Context): Promise<OrderPayment>

    • Parameters

      • orderPayment: OrderPayment

      • requestContext: Context

      Returns Promise<OrderPayment>

• updateContext: ((orderPaymentId: string, context: any, requestContext: Context) => Promise<boolean>)

  • • (orderPaymentId: string, context: any, requestContext: Context): Promise<boolean>

    • Parameters

      • orderPaymentId: string

      • context: any

      • requestContext: Context

      Returns Promise<boolean>

• updateStatus: ((orderPaymentId: string, params: { info?: string; status: OrderPaymentStatus; transactionId?: string }, userId?: string) => Promise<OrderPayment>)

  • • (orderPaymentId: string, params: { info?: string; status: OrderPaymentStatus; transactionId?: string }, userId?: string): Promise<OrderPayment>

    • Parameters

      • orderPaymentId: string

      • params: { info?: string; status: OrderPaymentStatus; transactionId?: string }

        • Optional info?: string

        • status: OrderPaymentStatus

        • Optional transactionId?: string

      • Optional userId: string

      Returns Promise<OrderPayment>