Skip to main content

PurseHeadlessCheckoutToken

Represents a saved payment token in the Purse checkout system. Tokens are secure references to saved payment methods like stored credit cards or digital wallet accounts.

Example​

// Assume `token` is an instance of PurseHeadlessCheckoutToken
// Edit token name
await token.edit({ name: 'Personal Card' });

// Delete token
await token.delete();

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

createdAt?​

optional createdAt?: string;

ISO 8601 date string indicating when the token was created. Useful for sorting saved payment methods chronologically.

disabled​

disabled: Readable<DisabledState | null>;

Indicates if the payment token is disabled with an 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

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

name​

name: string;

User-friendly name for the token, provided by the user during registration or by the payment partner. This name is used for display purposes in the UI to help users identify their saved payment methods.

partner​

partner: string;

Partner associated with the payment method

Examples​

'hipay'
'paypal'

Inherited from​

PurseHeadlessCheckoutPaymentItemBase.partner

type​

type: "token" | "temporary_token";

Overrides​

PurseHeadlessCheckoutPaymentItemBase.type

Methods​

delete()​

delete(): Promise<void>;

Delete the token from the user's wallet

Returns​

Promise<void>

Throws​

Example​

token.delete();

Inherited from​

PurseHeadlessCheckoutEditable.delete

edit()​

edit(payload): Promise<void>;

Edit the token's name

Parameters​

ParameterTypeDescription
payload{ name: string; }-
payload.namestring-

Returns​

Promise<void>

Throws​

Example​

token.edit({ name: 'New Name' });

Inherited from​

PurseHeadlessCheckoutEditable.edit