Class StripeServerAdapter

constructor

• new StripeServerAdapter(config: StripeServerAdapterConfig): StripeServerAdapter

  Parameters

  • config: StripeServerAdapterConfig

  Returns StripeServerAdapter

ReadonlypspName

cancelPayment

• cancelPayment(
      pspPaymentId: string,
      idempotencyKey: string,
  ): Promise<PaymentInfo>

  Parameters

  • pspPaymentId: string
  • idempotencyKey: string

  Returns Promise<PaymentInfo>

capturePayment

• capturePayment(
      pspPaymentId: string,
      amount: number | undefined,
      idempotencyKey: string,
  ): Promise<PaymentInfo>

  Only present if getCapabilities().supportsManualCapture. Capture is the canonical double-charge operation — the idempotency key is REQUIRED, and under supportsMultiCapture each partial capture is its own charge with its own key.

  Parameters

  • pspPaymentId: string
  • amount: number | undefined
  • idempotencyKey: string

  Returns Promise<PaymentInfo>

chargeSavedPaymentMethod

• chargeSavedPaymentMethod(
      input: ChargeSavedPaymentMethodInput,
  ): Promise<PaymentInfo>

  Off-session (merchant-initiated) charge of a vaulted instrument. The networks' credential-on-file rules ride the off_session flag; a bank demanding authentication surfaces as authentication_required (retryable ONLY by bringing the customer back on-session).

  Parameters

  • input: ChargeSavedPaymentMethodInput

  Returns Promise<PaymentInfo>

createCustomer

• createCustomer(input: CreateCustomerInput): Promise<CustomerRef>

  Creates the PSP-side customer that saved instruments attach to.

  Parameters

  • input: CreateCustomerInput

  Returns Promise<CustomerRef>

createPaymentSession

• createPaymentSession(input: CreatePaymentSessionInput): Promise<PaymentSession>

  Parameters

  • input: CreatePaymentSessionInput

  Returns Promise<PaymentSession>

deleteSavedPaymentMethod

• deleteSavedPaymentMethod(pspCustomerId: string, token: string): Promise<void>

  Deletes by SavedPaymentMethod.token — the token is dead afterwards.

  Parameters

  • pspCustomerId: string
  • token: string

  Returns Promise<void>

fetchEvents

• fetchEvents(input?: FetchEventsInput): Promise<FetchEventsResult>

  Missed-webhook recovery over GET /v1/events: the same payload shapes webhooks deliver, normalized by the same mapper — dedupe by event.id works identically for delivered and fetched events. Stripe retains ~30 days.

  Parameters

  • input: FetchEventsInput = {}

  Returns Promise<FetchEventsResult>

getCapabilities

• getCapabilities(): AdapterCapabilities

  Returns AdapterCapabilities

listPayments

• listPayments(input?: ListPaymentsInput): Promise<ListPaymentsResult>

  Reconciliation passthrough. Only present if getCapabilities().supportsListing.

  Parameters

  • input: ListPaymentsInput = {}

  Returns Promise<ListPaymentsResult>

listRefunds

• listRefunds(input?: ListRefundsInput): Promise<ListRefundsResult>

  Reconciliation passthrough. Only present if getCapabilities().supportsListing.

  Parameters

  • input: ListRefundsInput = {}

  Returns Promise<ListRefundsResult>

listSavedPaymentMethods

• listSavedPaymentMethods(pspCustomerId: string): Promise<SavedPaymentMethod[]>

  Parameters

  • pspCustomerId: string

  Returns Promise<SavedPaymentMethod[]>

parseWebhookEvent

• parseWebhookEvent(rawBody: string): Promise<UnifiedWebhookEvent>

  Throws PayFanoutError (code "invalid_request") on unparseable payloads; maps genuinely unknown-but-valid event types to type "unknown" rather than throwing.

  Parameters

  • rawBody: string

  Returns Promise<UnifiedWebhookEvent>

refundPayment

• refundPayment(req: RefundRequest): Promise<RefundResult>

  Parameters

  • req: RefundRequest

  Returns Promise<RefundResult>

retrievePayment

• retrievePayment(pspPaymentId: string): Promise<PaymentInfo>

  Parameters

  • pspPaymentId: string

  Returns Promise<PaymentInfo>

retrieveRefund

• retrieveRefund(refundId: string): Promise<RefundInfo>

  Polls an async refund ("pending" from refundPayment) to its terminal state.

  Parameters

  • refundId: string

  Returns Promise<RefundInfo>

updatePaymentSession

• updatePaymentSession(input: UpdatePaymentSessionInput): Promise<PaymentSession>

  Cart total changed? Stripe PaymentIntents update in place — same pspSessionId, same clientSecret, no client remount needed (the Payment Element re-fetches the amount on confirm).

  Parameters

  • input: UpdatePaymentSessionInput

  Returns Promise<PaymentSession>

verifyCredentials

• verifyCredentials(): Promise<VerifyCredentialsResult>

  "Test connection" probe: one read-only GET /v1/events, classified so a host UI can tell a bad key (auth) from a transient outage (network). Returns a result on every path instead of throwing, and never surfaces the credential.

  Returns Promise<VerifyCredentialsResult>

verifyPaymentMethod

• verifyPaymentMethod(input: VerifyPaymentMethodInput): Promise<PaymentInfo>

  Zero-amount verification via SetupIntent (§8 option a). A succeeded SetupIntent attaches a PaymentMethod, which collides with no-vaulting — so the PaymentMethod is detached on EVERY path (success, failed verification, or error) before this method returns.

  Parameters

  • input: VerifyPaymentMethodInput

  Returns Promise<PaymentInfo>

verifyWebhookSignature

• verifyWebhookSignature(
      rawBody: string,
      headers: Record<string, string>,
  ): Promise<boolean>

  Webhook handling — same adapter, separate concerns. Both async: future PSPs may need remote key retrieval; the contract stays uniform. MUST operate on the RAW request body bytes/string — re-serializing a parsed body breaks signatures (the conformance suite tests this).

  Parameters

  • rawBody: string
  • headers: Record<string, string>

  Returns Promise<boolean>