Class PaymentService<Methods, P>

Default payment service implementation of zibri.

Type Parameters

Methods extends readonly PaymentMethod[]
P extends readonly PaymentProviderInterface<
    Methods[number][],
    Record<Methods[number], AnyObject & { transactionId: string }>,
    Record<Methods[number], AnyObject & { transactionId: string }>,
    Record<Methods[number], AnyObject>,
    Record<Methods[number], AnyObject>,
    Record<Methods[number], boolean>,
    Record<Methods[number], boolean>,
    Record<Methods[number], boolean>,
>[]

Implements

PaymentServiceInterface<Methods, P>

Index

Constructors

constructor

Methods

cancelPayment collectPaymentFromReservation confirmPayment confirmPaymentReservation refundPayment startPayment startPaymentReservation validatePaymentData

Constructors

constructor

new PaymentService<
    Methods extends readonly PaymentMethod[],
    P extends
        readonly PaymentProviderInterface<
            Methods[number][],
            Record<Methods[number], AnyObject & { transactionId: string }>,
            Record<Methods[number], AnyObject & { transactionId: string }>,
            Record<Methods[number], AnyObject>,
            Record<Methods[number], AnyObject>,
            Record<Methods[number], boolean>,
            Record<Methods[number], boolean>,
            Record<Methods[number], boolean>,
        >[],
>(
    options: PaymentPluginOptions<Methods, P>,
    logger: LoggerInterface,
    paymentRepository: Repository<Payment<string, AnyObject>>,
): PaymentService<Methods, P>
Type Parameters
- Methods extends readonly PaymentMethod[]
- P extends readonly PaymentProviderInterface<
      Methods[number][],
      Record<Methods[number], AnyObject & { transactionId: string }>,
      Record<Methods[number], AnyObject & { transactionId: string }>,
      Record<Methods[number], AnyObject>,
      Record<Methods[number], AnyObject>,
      Record<Methods[number], boolean>,
      Record<Methods[number], boolean>,
      Record<Methods[number], boolean>,
  >[]
Parameters
- options: PaymentPluginOptions<Methods, P>
- logger: LoggerInterface
- paymentRepository: Repository<Payment<string, AnyObject>>
Returns PaymentService<Methods, P>
- Defined in src/plugin/payment/services/payment.service.ts:35

Methods

cancelPayment

cancelPayment<M extends PaymentMethod>(
    payment:
        | PaymentForMethod<Methods, M, P>
        | PaymentReservationForMethod<Methods, M, P>,
): Promise<void>
Cancels the given payment. Only works if it has not been paid already.
Type Parameters
- M extends PaymentMethod
Parameters
- payment: PaymentForMethod<Methods, M, P> | PaymentReservationForMethod<Methods, M, P>
Returns Promise<void>
Implementation of PaymentServiceInterface.cancelPayment
- Defined in src/plugin/payment/services/payment.service.ts:136

collectPaymentFromReservation

collectPaymentFromReservation<M extends PaymentMethod>(
payment: PaymentReservationForMethod<Methods, M, P>,
): Promise<void>
Collects a payment of the given reserved payment.
Type Parameters
- M extends PaymentMethod
Parameters
- payment: PaymentReservationForMethod<Methods, M, P>
Returns Promise<void>
Implementation of PaymentServiceInterface.collectPaymentFromReservation
- Defined in src/plugin/payment/services/payment.service.ts:120

confirmPayment

confirmPayment<M extends PaymentMethod>(
payment: PaymentForMethod<Methods, M, P>,
): Promise<void>
Confirms the given payment.
Type Parameters
- M extends PaymentMethod
Parameters
- payment: PaymentForMethod<Methods, M, P>
Returns Promise<void>
Implementation of PaymentServiceInterface.confirmPayment
- Defined in src/plugin/payment/services/payment.service.ts:106

confirmPaymentReservation

confirmPaymentReservation<M extends PaymentMethod>(
payment: PaymentReservationForMethod<Methods, M, P>,
): Promise<void>
Confirms a payment reservations. This just reserves/freezes the funds, it does NOT move any money yet.
Type Parameters
- M extends PaymentMethod
Parameters
- payment: PaymentReservationForMethod<Methods, M, P>
Returns Promise<void>
Implementation of PaymentServiceInterface.confirmPaymentReservation
- Defined in src/plugin/payment/services/payment.service.ts:88

refundPayment

refundPayment<M extends PaymentMethod>(
payment: PaymentForMethod<Methods, M, P>,
): Promise<void>
Refunds the given payment.
Type Parameters
- M extends PaymentMethod
Parameters
- payment: PaymentForMethod<Methods, M, P>
Returns Promise<void>
Implementation of PaymentServiceInterface.refundPayment
- Defined in src/plugin/payment/services/payment.service.ts:152

Class PaymentService<Methods, P>

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PaymentService<Methods, P>

Methods

cancelPayment

Type Parameters

Parameters

Returns Promise<void>

collectPaymentFromReservation

Type Parameters

Parameters

Returns Promise<void>

confirmPayment

Type Parameters

Parameters

Returns Promise<void>

confirmPaymentReservation

Type Parameters

Parameters

Returns Promise<void>

refundPayment

Type Parameters

Parameters

Returns Promise<void>

startPayment

Type Parameters

Parameters

Returns Promise<PaymentForMethod<Methods, M, P>>

startPaymentReservation

Type Parameters

Parameters

Returns Promise<PaymentReservationForMethod<Methods, M, P>>

validatePaymentData

Type Parameters

Parameters

Returns Promise<ValidatedPaymentDataForMethod<Methods, M, P>>

Settings

On This Page