Class MockProvider

In-memory payment provider for tests.

Example

import { betterPayment } from 'better-payment';
import { MockProvider, MOCK_CARDS } from 'better-payment/testing';

const payment = betterPayment({ providers: { mock: new MockProvider() } });

const result = await payment.mock.createPayment({
  ...order,
  paymentCard: { ...card, cardNumber: MOCK_CARDS.INSUFFICIENT_FUNDS },
});
// result.status === 'failure', result.code === 'INSUFFICIENT_FUNDS'

Hierarchy (View Summary)

PaymentProvider<MockProviderConfig>
- MockProvider

Index

Constructors

constructor

new MockProvider(config?: MockProviderConfig): MockProvider
Parameters
- config: MockProviderConfig = {}
Returns MockProvider
Overrides PaymentProvider.constructor
- Defined in packages/better-payment/src/testing/index.ts:182

Accessors

payments

get payments(): MockPaymentRecord[]
All payments, oldest first

Returns MockPaymentRecord[]
- Defined in packages/better-payment/src/testing/index.ts:227

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>
Overrides PaymentProvider.authorize
- Defined in packages/better-payment/src/testing/index.ts:258

binCheck

binCheck(binNumber: string): Promise<BinCheckResponse>
Look up a BIN
Parameters
- binNumber: string
Returns Promise<BinCheckResponse>
Overrides PaymentProvider.binCheck
- Defined in packages/better-payment/src/testing/index.ts:488

cancel

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

capture

capture(request: CaptureRequest): Promise<PaymentResponse>
Charges (all or part of) a pre-authorized amount
Parameters
- request: CaptureRequest
Returns Promise<PaymentResponse>
Overrides PaymentProvider.capture
- Defined in packages/better-payment/src/testing/index.ts:303

completeThreeDSPayment

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

createPayment

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

deleteCard

deleteCard(request: DeleteCardRequest): Promise<DeleteCardResponse>
Deletes a saved card
Parameters
- request: DeleteCardRequest
Returns Promise<DeleteCardResponse>
Overrides PaymentProvider.deleteCard
- Defined in packages/better-payment/src/testing/index.ts:478

failNext

failNext(
    operation: MockOperation,
    code?: PaymentErrorCode,
    message?: string,
): this
The next operation fails with code (default CARD_DECLINED), whatever the card
Parameters
- operation: MockOperation
- code: PaymentErrorCode = PaymentErrorCode.CARD_DECLINED
- Optionalmessage: string
Returns this
- Defined in packages/better-payment/src/testing/index.ts:194

getPayment

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

getRecord

getRecord(paymentId: string): MockPaymentRecord | undefined
The mock bank's record of a payment, for assertions
Parameters
- paymentId: string
Returns MockPaymentRecord | undefined
- Defined in packages/better-payment/src/testing/index.ts:221

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>
Overrides PaymentProvider.initThreeDSAuthorize
- Defined in packages/better-payment/src/testing/index.ts:266

initThreeDSPayment

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

installmentInfo

installmentInfo(
request: InstallmentInfoRequest,
): Promise<InstallmentInfoResponse>
Query installment options
Parameters
- request: InstallmentInfoRequest
Returns Promise<InstallmentInfoResponse>
Overrides PaymentProvider.installmentInfo
- Defined in packages/better-payment/src/testing/index.ts:501

listCards

listCards(request: { customerToken: string }): Promise<ListCardsResponse>
A customer's saved cards
Parameters
- request: { customerToken: string }
Returns Promise<ListCardsResponse>
Overrides PaymentProvider.listCards
- Defined in packages/better-payment/src/testing/index.ts:469

networkErrorNext

networkErrorNext(operation: MockOperation): this
The next operation is processed but its response is lost: it returns PENDING with NETWORK_ERROR, and getPayment() shows the real outcome.
Parameters
- operation: MockOperation
Returns this
- Defined in packages/better-payment/src/testing/index.ts:207

refund

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

reset

reset(): void
Clears payments, saved cards and queued outcomes

Returns void
- Defined in packages/better-payment/src/testing/index.ts:213

saveCard

saveCard(request: SaveCardRequest): Promise<SaveCardResponse>
Saves a card with the provider without charging it
Parameters
- request: SaveCardRequest
Returns Promise<SaveCardResponse>
Overrides PaymentProvider.saveCard
- Defined in packages/better-payment/src/testing/index.ts:447

threeDSCallback

threeDSCallback(
paymentId: string,
options?: { approve?: boolean },
): Promise<Record<string, string>>
The signed callback the mock bank posts to callbackUrl after the 3D Secure page. Post it to the handler (/mock/payment/complete-3ds) or pass it to completeThreeDSPayment(). approve: false simulates a failed or abandoned authentication.
Parameters
- paymentId: string
- options: { approve?: boolean } = {}
Returns Promise<Record<string, string>>
- Defined in packages/better-payment/src/testing/index.ts:237

voidAuthorization

voidAuthorization(request: VoidAuthorizationRequest): Promise<CancelResponse>
Releases a pre-authorization; nothing is charged
Parameters
- request: VoidAuthorizationRequest
Returns Promise<CancelResponse>
Overrides PaymentProvider.voidAuthorization
- Defined in packages/better-payment/src/testing/index.ts:333

Class MockProvider

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MockProvider

Accessors

payments

Returns MockPaymentRecord[]

Methods

authorize

Parameters

Returns Promise<PaymentResponse>

binCheck

Parameters

Returns Promise<BinCheckResponse>

cancel

Parameters

Returns Promise<CancelResponse>

capture

Parameters

Returns Promise<PaymentResponse>

completeThreeDSPayment

Parameters

Returns Promise<PaymentResponse>

createPayment

Parameters

Returns Promise<PaymentResponse>

deleteCard

Parameters

Returns Promise<DeleteCardResponse>

failNext

Parameters

Returns this

getPayment

Parameters

Returns Promise<PaymentResponse>

getRecord

Parameters

Returns MockPaymentRecord | undefined

initThreeDSAuthorize

Parameters

Returns Promise<ThreeDSInitResponse>

initThreeDSPayment

Parameters

Returns Promise<ThreeDSInitResponse>

installmentInfo

Parameters

Returns Promise<InstallmentInfoResponse>

listCards

Parameters

Returns Promise<ListCardsResponse>

networkErrorNext

Parameters

Returns this

refund

Parameters

Returns Promise<RefundResponse>

reset

Returns void

saveCard

Parameters

Returns Promise<SaveCardResponse>

threeDSCallback

Parameters

Returns Promise<Record<string, string>>

voidAuthorization

Parameters

Returns Promise<CancelResponse>

Settings

On This Page