Class PayPalPaymentProvider

Payment Provider that uses the PayPal API.

Implements

PaymentProviderInterface<
    SupportedMethods,
    PaymentDataMap,
    ValidatedPaymentDataMap,
    ProviderPaymentDataMap,
    ProviderReservationPaymentDataMap,
    CancellationSupport,
    RefundSupport,
    ReservationSupport,
>

Index

Constructors

constructor

new PayPalPaymentProvider(
name: string,
options: PayPalProviderOptions,
): PayPalPaymentProvider
Parameters
- name: string
- options: PayPalProviderOptions
Returns PayPalPaymentProvider
- Defined in src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts:191

Properties

`Readonly`cancellationSupported

cancellationSupported: CancellationSupport = ...

A map that defines which payment methods support cancellation.

`Readonly`name

name: string

The unique name of the provider, used to differentiate between them.

`Readonly`refundSupported

refundSupported: RefundSupport = ...

A map that defines which payment methods support refunding.

`Readonly`reservationSupported

reservationSupported: ReservationSupport = ...

A map that defines which payment methods support reservation.

Methods

cancelPayment

cancelPayment<M extends PAY_PAL>(
    payment:
        | Payment<M, ProviderPaymentDataMap[M]>
        | Payment<M, ProviderReservationPaymentDataMap[M]>,
): Promise<void>
Cancels the given payment.
Type Parameters
- M extends PAY_PAL
Parameters
- payment:
  | Payment<M, ProviderPaymentDataMap[M]>
  | Payment<M, ProviderReservationPaymentDataMap[M]>
Returns Promise<void>
Implementation of PaymentProviderInterface.cancelPayment
- Defined in src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts:421

collectPaymentFromReservation

collectPaymentFromReservation<M extends PAY_PAL>(
payment: Payment<M, ProviderReservationPaymentDataMap[M]>,
): Promise<void>
Collects payment from the given payment reservation.
Type Parameters
- M extends PAY_PAL
Parameters
- payment: Payment<M, ProviderReservationPaymentDataMap[M]>
Returns Promise<void>
Implementation of PaymentProviderInterface.collectPaymentFromReservation
- Defined in src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts:367

confirmPayment

confirmPayment<M extends PAY_PAL>(
payment: Payment<M, ProviderPaymentDataMap[M]>,
): Promise<void>
Confirms and finishes a payment.
Type Parameters
- M extends PAY_PAL
Parameters
- payment: Payment<M, ProviderPaymentDataMap[M]>
Returns Promise<void>
Implementation of PaymentProviderInterface.confirmPayment
- Defined in src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts:334

confirmPaymentReservation

confirmPaymentReservation<M extends PAY_PAL>(
payment: Payment<M, ProviderReservationPaymentDataMap[M]>,
): Promise<void>
Confirms The given payment reservation. This does NOT move any money yet, it just reserves the funds.
Type Parameters
- M extends PAY_PAL
Parameters
- payment: Payment<M, ProviderReservationPaymentDataMap[M]>
Returns Promise<void>
Implementation of PaymentProviderInterface.confirmPaymentReservation
- Defined in src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts:293

refundPayment

refundPayment<M extends PAY_PAL>(
payment: Payment<M, ProviderPaymentDataMap[M]>,
): Promise<void>
Refunds the given payment.
Type Parameters
- M extends PAY_PAL
Parameters
- payment: Payment<M, ProviderPaymentDataMap[M]>
Returns Promise<void>
Implementation of PaymentProviderInterface.refundPayment
- Defined in src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts:460

startPayment

startPayment<M extends PAY_PAL>(
method: M,
data: ValidatedPaymentDataMap[M],
): Promise<Payment<M, ProviderPaymentDataMap[M]>>
Starts a new payment with the given method and data.
Type Parameters
- M extends PAY_PAL
Parameters
- method: M
- data: ValidatedPaymentDataMap[M]
Returns Promise<Payment<M, ProviderPaymentDataMap[M]>>
Implementation of PaymentProviderInterface.startPayment
- Defined in src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts:232

startPaymentReservation

startPaymentReservation<M extends PAY_PAL>(
method: M,
data: ValidatedPaymentDataMap[M],
): Promise<Payment<M, ProviderReservationPaymentDataMap[M]>>
Starts a new payment reservation with the given method and data.
Type Parameters
- M extends PAY_PAL
Parameters
- method: M
- data: ValidatedPaymentDataMap[M]
Returns Promise<Payment<M, ProviderReservationPaymentDataMap[M]>>
Implementation of PaymentProviderInterface.startPaymentReservation
- Defined in src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts:260

validatePaymentData

validatePaymentData<M extends PAY_PAL>(
method: M,
data: PaymentDataMap[M],
): ValidatedPaymentDataMap[M]
Validates the given payment data for the given method.
Type Parameters
- M extends PAY_PAL
Parameters
- method: M
- data: PaymentDataMap[M]
Returns ValidatedPaymentDataMap[M]
Implementation of PaymentProviderInterface.validatePaymentData
- Defined in src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts:210

Class PayPalPaymentProvider

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PayPalPaymentProvider

Properties

ReadonlycancellationSupported

Readonlyname

ReadonlyrefundSupported

ReadonlyreservationSupported

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<Payment<M, ProviderPaymentDataMap[M]>>

startPaymentReservation

Type Parameters

Parameters

Returns Promise<Payment<M, ProviderReservationPaymentDataMap[M]>>

validatePaymentData

Type Parameters

Parameters

Returns ValidatedPaymentDataMap[M]

Settings

On This Page

`Readonly`cancellationSupported

`Readonly`name

`Readonly`refundSupported

`Readonly`reservationSupported