Skip to main content

PurseHeadlessCheckoutPaymentItemBase

Base interface for all payment items in the Purse checkout system. Provides common properties shared between payment methods and tokens.

Remarks​

This interface should not be used directly in your application code. Instead, use PurseHeadlessCheckoutMethod or PurseHeadlessCheckoutToken.

Extended by​

Properties​

additionalAssets​

additionalAssets: CardSchemeAsset[];

Additional assets associated with this payment item, primarily card scheme logos.

For credit card methods with vault support, this contains one entry per supported card scheme (e.g. Visa, Mastercard, CB). For all other payment methods the array is empty.

Each asset provides a CDN URL and a human-readable label suitable for display and accessibility purposes.

Example​

// React
{method.additionalAssets.map(asset => (
  <img key={asset.url} src={asset.url} alt={asset.label} />
))}

iconUrl​

iconUrl: string;

Absolute URL of the payment method icon on the Purse CDN.

The URL is stable and environment-aware (sandbox vs production). The icon is an SVG file that respects the brand guidelines of the payment partner. It can be used directly in an <img> tag or as a CSS background image without any further processing.

Example​

// React
<img src={method.iconUrl} alt={method.method} />

id​

id: string;

Unique identifier of the payment method

Examples​

'hipay-bancontact'
'illicado-giftcard'
'aci-creditcard'

isSecondary​

isSecondary: boolean;

Indicates if the payment method is a secondary mean of payment

maxAmount​

maxAmount: number | null;

Maximum amount to use the payment method

method​

method: string;

Type of payment method, it can be a card, a wallet, a bank transfer, etc.

Examples​

'applepay'
'googlepay'
'creditcard'

minAmount​

minAmount: number | null;

Minimum amount to use the payment method

partner​

partner: string;

Partner associated with the payment method

Examples​

'hipay'
'paypal'

type​

type: "method" | "token" | "temporary_token" | undefined;