PurseHeadlessCheckoutPrimaryToken

Represents a primary token in the Purse checkout system. Primary tokens are saved payment methods like stored credit cards or digital wallet accounts.

Extends

• PurseHeadlessCheckoutToken

Properties

description

description: object;

Description holds all display values to describe the token in a UI. This is useful since the rendering of a token is limited to the CVV.

brand?

optional brand: string;

Brand of the token

expiration_date

expiration_date: string;

Date at which the token is excepted to expire

holderName?

optional holderName: string;

Holder name of the token

label?

optional label: string;

Label is optional, the user have not necessarily given a label to the token when creating it.

masked_pan

masked_pan: string;

Will contain displayable value of the PAN or the account email

---

disabled

disabled: Readable<DisabledState | null>;

Indicates if the payment token is disabled with an error code and message

Inherited from

PurseHeadlessCheckoutToken.disabled

---

id

id: string;

Unique identifier of the payment method

Examples

'hipay-bancontact'

'illicado-giftcard'

'aci-creditcard'

Inherited from

PurseHeadlessCheckoutToken.id

---

isSecondary

isSecondary: false;

Indicates if the token is a secondary mean of payment

Overrides

PurseHeadlessCheckoutToken.isSecondary

---

maxAmount

maxAmount: number | null;

Maximum amount to use the payment method

Inherited from

PurseHeadlessCheckoutToken.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

PurseHeadlessCheckoutToken.method

---

minAmount

minAmount: number | null;

Minimum amount to use the payment method

Inherited from

PurseHeadlessCheckoutToken.minAmount

---

name

name: string;

Inherited from

PurseHeadlessCheckoutToken.name

---

partner

partner: string;

Partner associated with the payment method

Examples

'hipay'

'paypal'

Inherited from

PurseHeadlessCheckoutToken.partner

---

type

type: "token";

Overrides

PurseHeadlessCheckoutToken.type

Methods

delete()

delete(): Promise<void>;

Delete the token from the user's wallet

Returns

Promise<void>

Throws

• PurseHeadlessCheckoutError METHOD_NOT_IMPLEMENTED
  If the token is of type PurseHeadlessCheckoutTemporarySecondaryToken
• PurseHeadlessCheckoutError MISSING_SESSION
  If the session is missing
• PurseHeadlessCheckoutError MISSING_TOKEN
  If the provided token cannot be found
• PurseHeadlessCheckoutError MISSING_WALLET_SESSION
  If the wallet session is missing
• PurseHeadlessCheckoutError UNKNOWN_ERROR
  If an unknown error is caught during the deletion

Example

token.delete();

Inherited from

PurseHeadlessCheckoutToken.delete

---

edit()

edit(payload): Promise<void>;

Edit the token's name

Parameters

Parameter	Type	Description
payload	{ name: string; }
payload.name	string	-

Returns

Promise<void>

Throws

• PurseHeadlessCheckoutError TOKEN_NOT_REGISTERABLE
  If the token is not registerable
• PurseHeadlessCheckoutError TOKEN_NOT_REGISTERED
  If the token is not registered (see PurseHeadlessCheckoutRegisterable.register)
• PurseHeadlessCheckoutError TOKEN_NAME_EXISTS
  If the token name already exists
• PurseHeadlessCheckoutError MISSING_TOKEN
  If the provided token cannot be found
• PurseHeadlessCheckoutError INVALID_TOKEN_NAME
  If the provided token name is invalid
• PurseHeadlessCheckoutError MISSING_WALLET_SESSION
  If the wallet session is missing

Example

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

Inherited from

PurseHeadlessCheckoutToken.edit

---

getHostedFields()

getHostedFields(options?): PurseHeadlessCheckoutHostedFields;

Creates and returns a hosted fields UI instance for this payment method.

Parameters

Parameter	Type	Description
options?	HostedFieldsOptions	HostedFieldsOptions: settings for the hosted fields

Returns

PurseHeadlessCheckoutHostedFields

A hosted fields instance for this payment method

Example

  const hostedFields = primaryMethod.getHostedFields({
     fields: {
       cvv: {
         target: '#card-cvv',
         placeholder: 'CVV',
       },
     },
     theme: {
       global: {
         fontSrc: 'https://fonts.googleapis.com/css?family=Roboto',
       },
       input: {
         color: '#333',
         fontSize: '16px',
         fontFamily: 'Arial, sans-serif',
         backgroundColor: '#fff',
         fontWeight: '400',
         ':valid': {
           color: 'green',
         },
       }
     }
   });
  await hostedFields.render();

---

getPaymentElement()

getPaymentElement(options?): PurseHeadlessCheckoutPaymentElement;

Method to get the payment element. Creates the UI instance on first call. If you need to render a partner's UI, you will need a PaymentElement

Parameters

Parameter	Type	Description
options?	PurseHeadlessCheckoutUIOptions	{Options

Returns

PurseHeadlessCheckoutPaymentElement

Example

const paymentElement = token.getPaymentElement();
// Mount the payment element to your UI
paymentElement.appendTo('#payment-container');

---

setAsPrimarySource()

setAsPrimarySource(): void;

Use this method if you want to change which primary to use in the split. This can be useful if you have mounted multiple primary payment elements (ie. Wallet AND installments for instance).

Returns

void

Throws

• PurseHeadlessCheckoutError ELEMENT_NOT_FULFILLED
  If the token has empty or incomplete payment information

Example

token.setAsPrimarySource();