Interface PaymentMethodSummary

Summary of a user's enrolled payment method.

interface PaymentMethodSummary {
    alias?: null | string;
    allowedApiKeyIds?: null | string[];
    brand: string;
    expMonth: number;
    expYear: number;
    id: string;
    last4: string;
    provider?: string;
    status?: string;
    type: string;
}

Properties

alias?: null | string

Human-readable alias, if set

allowedApiKeyIds?: null | string[]

NVM API Key IDs allowed to use this payment method, or null if unrestricted

brand: string

Card brand (e.g., 'visa', 'mastercard') or payment method type ('paypal', 'venmo')

expMonth: number

Expiration month (0 for non-card methods)

expYear: number

Expiration year (0 for non-card methods)

id: string

Payment method ID (Stripe 'pm_...' or Braintree vault token)

last4: string

Last 4 digits (cards) or email/username (PayPal/Venmo)

provider?: string

Payment provider: 'stripe' or 'braintree'

status?: string

Current status ('Active' or 'Revoked')

type: string

Payment method type (e.g., 'card', 'paypal')