@plyaz/types 1.27.0 → 1.27.2

package/dist/payments/kyc/types.d.ts

@@ -0,0 +1,49 @@
+import type { PAYMENT_PROVIDER_TYPE } from '../provider';
+import type { KYC_ENTITY_TYPE, KYC_TIER, ONBOARD_LINK_TYPE, ONBOARD_STATUS } from './enum';
+export interface CreatePayoutAccountParams<TMetadata extends object = object> {
+    provider: PAYMENT_PROVIDER_TYPE;
+    userId: string;
+    email: string;
+    country: string;
+    entityType: KYC_ENTITY_TYPE;
+    tier: KYC_TIER;
+    onboardType?: 'standard' | 'express' | 'custom';
+    redirectUrls?: {
+        refreshUrl: string;
+        returnUrl: string;
+    };
+    metadata?: TMetadata;
+}
+export interface CreatePayoutAccountResponse<TMetadata extends object = object> {
+    userId: string;
+    provider: PAYMENT_PROVIDER_TYPE;
+    providerAccountId: string;
+    status: ONBOARD_STATUS;
+    tier: KYC_TIER;
+    metadata?: TMetadata;
+    createdAt: string;
+}
+export interface CreateAccountLinkParams {
+    providerAccountId: string;
+    onboardType: ONBOARD_LINK_TYPE;
+    clientSecret?: string;
+    tier: KYC_TIER;
+    redirectUrls: {
+        refreshUrl: string;
+        returnUrl: string;
+    };
+}
+export interface CreateAccountLinkResponse {
+    providerAccountId: string;
+    redirectUrl: string;
+    createdAt: string;
+    tier: KYC_TIER;
+}
+export interface PayoutAccountStatus {
+    id: string;
+    payoutsEnabled: boolean;
+    chargesEnabled: boolean;
+    detailsSubmitted: boolean;
+    currentlyDue?: string[] | null;
+    eventuallyDue?: string[] | null;
+}

package/dist/payments/provider/adapter/types.d.ts

@@ -4,9 +4,10 @@ import type { BaseProviderConfig, CreatePricingParams, CreatePricingResult, Crea
 import type { PaymentResult, ProcessPaymentRequest } from '../../request';
 import type { FeeBreakdown, Money } from '../../transaction';
 import type { AdapterConfiguration, CreateCustomerParams, CreateSubscriptionParams, CustomerResult, FeeStructure, PaymentStatusResult, PayoutParams, PayoutResult, RefundParams, RefundResult, SavedPaymentMethod, SavedPaymentMethodResult, SavePaymentMethodParams, SubscriptionResult, TransactionDetails, TransactionHistory, TransactionHistoryParams, WebhookPayload, WebhookResult, WithdrawalParams, WithdrawalResult } from '../core';
-import type { ProviderCapabilities, ProviderConfiguration } from '../payment-provider';
+import type { PayoutAccountCapabilities, ProviderCapabilities, ProviderConfiguration } from '../payment-provider';
 import type { PAYMENT_METHOD, PAYMENT_PROVIDER_TYPE } from '../provider-capability';
 import type { CalculateFeeParams } from '../../gateways/provider/fee/types';
+import type { CreateAccountLinkParams, CreateAccountLinkResponse, CreatePayoutAccountParams, CreatePayoutAccountResponse, PayoutAccountStatus } from '../../kyc';
 /**
  * Core interface that all payment providers must implement.
  * This interface ensures consistent behavior across all providers
@@ -29,6 +30,11 @@ export interface PaymentAdapter {
     readonly supportedCurrencies: CurrencyCode[];
     /** Detailed capabilities of this provider */
     readonly capabilities: ProviderCapabilities;
+    /**
+     * Detailed payout/account-level capabilities.
+     * Includes core, optional/region-specific, advanced, and compliance capabilities.
+     */
+    readonly payoutAccountCapabilities: PayoutAccountCapabilities;
     /** Provider configuration and metadata */
     readonly config: ProviderConfiguration;
     /**
@@ -202,6 +208,10 @@ export interface PaymentAdapter {
      * Process payout to recipient (optional)
      */
     processPayout?(params: PayoutParams): Promise<PayoutResult>;
+    onboardPayoutAccount?<TMetadata extends object = object>(params: CreatePayoutAccountParams<TMetadata>): Promise<CreatePayoutAccountResponse<TMetadata>>;
+    generateOnboardingLink?(params: CreateAccountLinkParams): Promise<CreateAccountLinkResponse>;
+    getPayoutAccountStatus?(accountId: string): Promise<PayoutAccountStatus>;
+    getCapabilities?(): Promise<PayoutAccountCapabilities>;
     /**
      * Process withdrawal from a user's balance (optional)
      * This method represents a user-initiated request to move funds from their platform account

package/dist/payments/provider/payment-provider/types.d.ts

@@ -219,6 +219,64 @@ export interface ProviderCapabilities {
     /** Settlement time estimates per payment method */
     settlementTimes: Record<PAYMENT_METHOD, SettlementTimeEstimate>;
 }
+/**
+ * Represents the unified capabilities of a payout/payment account
+ * across multiple payment providers.
+ */
+export interface PayoutAccountCapabilities {
+    /** Can accept card or online payments from customers. Equivalent to Stripe's `card_payments`. */
+    canAcceptPayments: boolean;
+    /** Can receive funds/transfers from the platform or other accounts. Equivalent to Stripe's `transfers`. */
+    canReceiveTransfers: boolean;
+    /** Can withdraw funds to an external bank account. Equivalent to Stripe's `payouts`. */
+    canPayout: boolean;
+    /** Can accept SEPA Direct Debit payments (EU). */
+    canAcceptSEPA: boolean;
+    /** Can accept BACS Direct Debit payments (UK). */
+    canAcceptBACS: boolean;
+    /** Can accept iDEAL payments (Netherlands). */
+    canAcceptiDEAL: boolean;
+    /** Can accept Klarna Buy-Now-Pay-Later payments. */
+    canAcceptKlarna: boolean;
+    /** Can accept other Buy-Now-Pay-Later methods like Afterpay / Clearpay. */
+    canAcceptOtherBNPL: boolean;
+    /** Can accept ACH payments (US bank account transfers). */
+    canAcceptACH: boolean;
+    /** Can accept Faster Payments (UK). */
+    canAcceptFasterPayments: boolean;
+    /** Can accept Przelewy24 payments (Poland). */
+    canAcceptP24: boolean;
+    /** Can accept EPS payments (Austria). */
+    canAcceptEPS: boolean;
+    /** Can accept Giropay payments (Germany). */
+    canAcceptGiropay: boolean;
+    /** Can accept Alipay payments (China / global). */
+    canAcceptAlipay: boolean;
+    /** Can accept WeChat Pay payments (China / global). */
+    canAcceptWeChatPay: boolean;
+    /** Can use Treasury-like products such as wallets or balance accounts. */
+    canUseTreasury: boolean;
+    /** Can issue virtual or physical cards (Stripe Issuing). */
+    canIssueCards: boolean;
+    /** Can perform instant payouts (provider-dependent). */
+    canUseInstantPayouts: boolean;
+    /** Can hold funds in the platform account before payout. */
+    canHoldBalance: boolean;
+    /** Can create sub-accounts or nested merchant accounts. */
+    canCreateSubAccounts: boolean;
+    /** Can use provider-level tax reporting (e.g., US 1099). */
+    canUseTaxReporting: boolean;
+    /** Bank account is verified and ready for payouts. */
+    bankVerified: boolean;
+    /** User has passed KYC verification checks. */
+    canUseKYCVerification: boolean;
+    /** User has passed AML (Anti-Money Laundering) checks. */
+    canUseAMLCheck: boolean;
+    /** Can issue refunds to customers. */
+    canProcessRefunds: boolean;
+    /** Can handle disputes, chargebacks, or payment reversals. */
+    canHandleDisputes: boolean;
+}
 /**
  * Provider configuration interface for initialization.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.27.0",
+  "version": "1.27.2",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",