PurseHeadlessCheckoutMethod
Represents an available payment method in the Purse checkout system. Payment methods can be primary (e.g., credit cards, digital wallets) or secondary (e.g., gift cards).
Extends
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} />
))}
Inherited from
PurseHeadlessCheckoutPaymentItemBase.additionalAssets
disabled
disabled: Readable<DisabledState | null>;
Indicates if the payment method is disabled with an error code and message DisabledState error code and message
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} />
Inherited from
PurseHeadlessCheckoutPaymentItemBase.iconUrl
id
id: string;
Unique identifier of the payment method
Examples
'hipay-bancontact'
'illicado-giftcard'
'aci-creditcard'
Inherited from
PurseHeadlessCheckoutPaymentItemBase.id
isSecondary
isSecondary: boolean;
Indicates if the payment method is a secondary mean of payment
Inherited from
PurseHeadlessCheckoutPaymentItemBase.isSecondary
limit
limit: number | null;
Amount limit for the payment method (null if no limit)
maxAmount
maxAmount: number | null;
Maximum amount to use the payment method
Inherited from
PurseHeadlessCheckoutPaymentItemBase.maxAmount
method
method: string;
Type of payment method, it can be a card, a wallet, a bank transfer, etc.
Examples
'applepay'
'googlepay'
'creditcard'
Inherited from
PurseHeadlessCheckoutPaymentItemBase.method
minAmount
minAmount: number | null;
Minimum amount to use the payment method
Inherited from
PurseHeadlessCheckoutPaymentItemBase.minAmount
partner
partner: string;
Partner associated with the payment method
Examples
'hipay'
'paypal'
Inherited from
PurseHeadlessCheckoutPaymentItemBase.partner
position
position: number;
Position of the payment method in the list
type
type: "method";