Class PaymentProvider<TConfig>`Abstract`

Abstract base class for all payment providers

Type Parameters

TConfig extends PaymentProviderConfig = PaymentProviderConfig

Hierarchy (View Summary)

PaymentProvider
- MockProvider
- Iyzico
- PayTR
- Akbank
- Parampos
- KuveytTurk
- Sipay
- Est

Index

Constructors

Methods

authorize binCheck cancel capture completeThreeDSPayment createPayment deleteCard getPayment initThreeDSAuthorize initThreeDSPayment installmentInfo listCards refund saveCard voidAuthorization

Constructors

constructor

new PaymentProvider<
TConfig extends PaymentProviderConfig = PaymentProviderConfig,
>(
config: TConfig,
): PaymentProvider<TConfig>
Type Parameters
- TConfig extends PaymentProviderConfig = PaymentProviderConfig
Parameters
- config: TConfig
Returns PaymentProvider<TConfig>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:62

Methods

authorize

authorize(_request: PaymentRequest): Promise<PaymentResponse>
Pre-authorization: blocks the amount on the card without charging it. Charge it later with capture(), or release it with voidAuthorization(). A success result means the amount is blocked.
Parameters
- _request: PaymentRequest
Returns Promise<PaymentResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:167

binCheck

binCheck(_binNumber: string): Promise<BinCheckResponse>
Look up a BIN
Parameters
- _binNumber: string
Returns Promise<BinCheckResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:233

`Abstract`cancel

cancel(request: CancelRequest): Promise<CancelResponse>
Cancel a payment
Parameters
- request: CancelRequest
Returns Promise<CancelResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:136

capture

capture(_request: CaptureRequest): Promise<PaymentResponse>
Charges (all or part of) a pre-authorized amount
Parameters
- _request: CaptureRequest
Returns Promise<PaymentResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:180

`Abstract`completeThreeDSPayment

completeThreeDSPayment(callbackData: unknown): Promise<PaymentResponse>
Complete a 3D Secure payment (after the callback)
Parameters
- callbackData: unknown
Returns Promise<PaymentResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:126

`Abstract`createPayment

createPayment(request: PaymentRequest): Promise<PaymentResponse>
Direct payment (without 3D Secure)
Parameters
- request: PaymentRequest
Returns Promise<PaymentResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:116

deleteCard

deleteCard(_request: DeleteCardRequest): Promise<DeleteCardResponse>
Deletes a saved card
Parameters
- _request: DeleteCardRequest
Returns Promise<DeleteCardResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:200

`Abstract`getPayment

getPayment(paymentId: string): Promise<PaymentResponse>
Query a payment
Parameters
- paymentId: string
Returns Promise<PaymentResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:141

initThreeDSAuthorize

initThreeDSAuthorize(
_request: ThreeDSPaymentRequest,
): Promise<ThreeDSInitResponse>
Pre-authorization with 3D Secure. Complete it with completeThreeDSPayment() as usual; success then means the amount is blocked.
Parameters
- _request: ThreeDSPaymentRequest
Returns Promise<ThreeDSInitResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:175

`Abstract`initThreeDSPayment

initThreeDSPayment(request: ThreeDSPaymentRequest): Promise<ThreeDSInitResponse>
Initialize a 3D Secure payment
Parameters
- request: ThreeDSPaymentRequest
Returns Promise<ThreeDSInitResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:121

installmentInfo

installmentInfo(
_request: InstallmentInfoRequest,
): Promise<InstallmentInfoResponse>
Query installment options
Parameters
- _request: InstallmentInfoRequest
Returns Promise<InstallmentInfoResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:240

listCards

listCards(_request: { customerToken: string }): Promise<ListCardsResponse>
A customer's saved cards
Parameters
- _request: { customerToken: string }
Returns Promise<ListCardsResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:195

`Abstract`refund

refund(request: RefundRequest): Promise<RefundResponse>
Refund a payment
Parameters
- request: RefundRequest
Returns Promise<RefundResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:131

saveCard

saveCard(_request: SaveCardRequest): Promise<SaveCardResponse>
Saves a card with the provider without charging it
Parameters
- _request: SaveCardRequest
Returns Promise<SaveCardResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:190

voidAuthorization

voidAuthorization(_request: VoidAuthorizationRequest): Promise<CancelResponse>
Releases a pre-authorization; nothing is charged
Parameters
- _request: VoidAuthorizationRequest
Returns Promise<CancelResponse>
- Defined in packages/better-payment/src/core/PaymentProvider.ts:185