Objects

#
GiftCard

An object with the methods to create and set up a Gift Cards payment.

Created by calling the payments.giftCard() method.

Methods

Adds an event listener to the GiftCard instance. Provides specific typings related to giftCard element events.

Attaches the GiftCard form to the page.

Clears the gift card fields and removes error messages

Configures the GiftCard payment method with visual and behavior options.

Destroys the payment method. The attached element is emptied and all event listeners are removed.

Detach the gift card payment object. The attached element is emptied but event listeners on the gift card remain. This is different from Destroy as this method only removes the gift card element and allows the developer to re-attach it to the page when they want to display it again.

Sets the DOM focus of one of the input fields within the GiftCard form.

Removes an event listener from the GiftCard instance. Provides specific typings related to Gift Cards element events.

Tokenizes a GiftCard payment method instance.


const payments = Square.payments(appId, locationId);

const giftCard = await payments.giftCard();

await giftCard.attach('#gift-card');

const form = document.querySelector('#gift-card-payment');

form.addEventListener('submit', async (event) => {

   event.preventDefault();

   const result = await giftCard.tokenize(); // the gift card nonce

});

# GiftCard

Methods

#
GiftCard