PurseHeadlessCheckoutRegisterable
Extended by
Properties
canBeRegistered
canBeRegistered: boolean;
Whether the user can choose to register this method.
True only for save_token_mode values PREFER and PREFER_NO.
When false, the save-token checkbox must not be shown; the backend
enforces the registration policy (ALWAYS/NEVER) without a frontend signal.
registration
registration: Readable<RegistrationState>;
This property exposes if the mean of payment is bound for registration upon validate.
saveTokenMode
saveTokenMode: SaveTokenMode;
The effective save_token_mode resolved for this mean of payment
(ALWAYS / PREFER / PREFER_NO / NEVER), including the save_token
boolean fallback. Exposed for consumers that need to distinguish why
registration is or isn't user-controllable — e.g. ALWAYS forces
registration silently, with canBeRegistered false like NEVER.
Methods
register()
register(value?, params?): Promise<void>;
Mark this mean of payment for registration upon validate.
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | boolean | {boolean} true to register, false to unregister |
params? | { name?: string; } | - |
params.name? | string | - |
Returns
Promise<void>
Example
item.register(true);
Throws
- PurseHeadlessCheckoutError
INVALID_TOKEN_NAME
If the provided token name is invalid - PurseHeadlessCheckoutError
TOKEN_NOT_REGISTERABLE
If the token is not registerable