Gift card Drop-in integration

On this page, you can find additional configuration for adding gift cards to your Drop-in integration.

Before you begin

This page assumes you've already:

• Built a Drop-in integration.

• Added each gift card variant that you want to test in your Customer Area.

  You can test a limited number of gift card variants and simulate gift card payments. When testing, you use a simulator that tries to behave and respond in the same way as an end-to-end connection with a gift card provider. Before you go live, you must onboard with a gift card provider and add the gift card variant to your live Customer Area.

API reference

You don't 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 Drop-in v5.0.0 or later.
• /payments: If you implemented an advanced use case, or integrated Drop-in before v5.0.0.

Drop-in configuration

Select which endpoint you're integrating:

const giftcardConfiguration = {
    onBalanceCheck: function (resolve, reject, data) {
        // Make a POST /paymentMethods/balance request
        resolve(BalanceResponse);
    }
    onOrderRequest: function (resolve, reject, data) {
        // Make a POST /orders request
        // Create an order for the total transaction amount
        resolve(OrderResponse);
    }
    onOrderCancel: function(Order) {
        // Make a POST /orders/cancel request
        // Call the update function and pass the payment methods response to update the instance of checkout
        checkout.update(paymentMethodsResponse, amount);
    }
};

const configuration = {
  // ...  other required configuration
  paymentMethodsConfiguration: {
    giftcard: giftcardConfiguration
  }
};

(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:

const configuration = {
  // ...  other configuration
  paymentMethodsConfiguration: {
    giftcard: {
                brandsConfiguration: {
                    plastix: {
                        icon: 'https://mymerchant.com/icons/customIcon.svg'
                    }
                }
    }
  }
}

Test and go live

Before making live gift card payments, simulate transactions:

1. Test your integration using our test card numbers depending on your gift card provider. 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.
   You can test other scenarios in your live environment using real gift card details and small amounts.
   You can check the status of test payments in your test Customer Area > Transactions > Payments.

When you are ready to go live:

1. Onboard with a gift card provider.
2. 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.

See also