Gift card Component

Add gift card payments to an existing Components integration.

Implementation examples
  Java Spring
  .NET
  Node.js

This page explains how to add gift cards to your existing Web Components integration.

Requirements

Requirement	Description
Integration type	Make sure that you have built your Components integration.
Setup steps	Before you begin, in your Customer Area add each gift card variant that you want to test.

API reference

You do not need to send additional fields for gift cards. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:

/sessions: This is the default with Components v5.0.0 or later.
/payments: If you implemented an additional use case.

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="giftcard-container"></div>

Step 2: Create an instance of the Component

Select your integration:

(Optional) Customize logos

You can specify a custom logo for a gift card brand when creating a configuration object. This example shows a custom icon for Plastix:

Test and go live

Before making live gift card payments, simulate transactions:

Test your integration using our test card numbers depending on your gift card provider. When testing, you use a simulator that tries to behave and respond in the same way as an end-to-end connection.

To simulate a scenario, send one of the following amounts in the test payment request:

Amount (last three digits)	`resultCode`	`refusalReason`
100	Authorised
123	Refused	Refused
124	Refused	Not enough balance
125	Refused	Blocked Card
126	Refused	Expired Card
130	Error	Acquirer Error
134	Refused	Invalid Pin
135	Refused	Pin tries exceeded

For example, send a payment amount with 100 as the last three digits, such as 1.00 or 11.00. This will result in an Authorised transaction.

Check the status of test payments in your test Customer Area > Transactions > Payments.

When you are ready to go live:

Onboard with a gift card provider and add the gift card variant to your live Customer Area.
Contact our Support Team to add the gift card to your live Customer Area.

You can test end-to-end scenarios in your live environment using real gift card details and small amounts.