Get started with the Skipify SDK

Learn how to implement the Skipify SDK

Overview

The Email lookup and Skipify Button use the Skipify SDK for a range of features. This guide shows you how to set up the SDK on your website. The various features of the SDK are further enumerated in additional articles in this section.

🚧

This section requires you to have set up your merchant account

Haven't set that up yet? No worries! Reach out to your friendly implementation engineer and they'll make sure your account is properly set up.

  1. Set up your merchant account including relevant configurations for your use case
  2. Implement the Email Look up, Skipify Button via the Skipify SDK which includes synchronous webhooks
  3. Implement asynchronous webhooks

SDK Technical Flow - Summary Overview

High level SDK implementation flow

Requirements to use the Skipify SDK

Merchant Domains

🚧

Important

Provide relevant domains for testing in lower environments that will need to be whitelisted by your Skipify Implementation Engineer.

Localhost will need to be added for local development (ex. https://localhost:5001).
If you are using Ionic (iOS) add (capacitor://localhost as your merchant domain).

In Production, domains are added in the Skipify Merchant Portal.

Merchants are required to provide a set of allowed domains that Skipify uses to validate before initializing the Skipify SDK. Only configured domains will be able to leverage the Skipify SDK. You will need to provide that information to your implementation engineer during onboarding.

Loading the Skipify SDK

Skipify provides several options to integrate the Connected Checkout experience into your website. To get started, you can load the SDK using:

<!-- TEST -->
<script src="https://stagecdn.skipify.com/sdk/checkoutsdk.js"></script>
<!-- LIVE -->
<script src="https://cdn.skipify.com/sdk/checkoutsdk.js"></script>
$ npm install @skipifycheckout/checkout-sdk
$ yarn add @skipifycheckout/checkout-sdk

Initializing the Skipify SDK

Once you have completed the installation using one of the methods above, you can initialize the Skipify client SDK using:

const skipifySdk = new window.skipify({
  merchantId: '<your_merchantId>',
});
import Skipify from '@skipifycheckout/checkout-sdk';

const skipifySdk = new Skipify({
  merchantId: '<your-merchantId>',
});

Skipify Email Lookup

Email Lookup will launch the Connected Checkout experience for recognized shoppers using any email field on your checkout page.

skipifySdk.email("your_merchantReference").enable( < your_input_object > );

Methods

  • The SDK email function is used to configure Email Lookup. Pass merchantReference, your unique reference related to the order or cart.
  • enable is used to activate the Email Lookup functionality on your specified input field.

Skipify Button

Implement the Skipify Button anywhere on your website to accelerate checkout.

  • Recognized shoppers are presented with their payment methods and checkout information.
  • Shoppers new to the Skipify ecosystem have the option to save their info and payment methods for faster future checkouts anywhere that accepts Skipify.
skipifySdk.button("your_merchantReference").render( < your_container > );

Methods

  • button is used to create the Skipify Button component instance. Pass merchantReference, your unique reference related to the order or cart.
  • render is used to display the configured button on your website via the specified container. The button can render in any container element and the component will inherit the width of the container size.

SDK Technical Flow

Synchronous Callbacks

Before Skipify can submit a payment on your behalf, we need to gather some information about the order. Implement the applicable callbacks relevant to your business use case so that Skipify can retrieve info to facilitate a seamless shopper experience.

Skipify servers will send a request to your specified URL when needed. You will need to provide your implementation engineer a callback URL(s).

Overview

There are three callback events available via the SDK:

  • ORDER_RESOLVE- defines amount per line items or cart
  • ORDER_CHANGE - defines tax, shipping address, discounts
  • ORDER_VERIFY - validation before payment processing

Callback Event Descriptions

EventImplementation requiredResponse requiredDescription
ORDER_RESOLVEyesyesRespond to this callback event to return further details about the cart.
ORDER_CHANGEnoyesImplement this callback event to return additional information about the order as it relates to shipping, tax & discount adjustments, promos or any order quantity changes by your customer.
ORDER_VERIFYnoyesImplement this callback event to confirm whether the information is accurate. This event is used to validate the order details before a payment is processed.

Standard request payload for Callback Events

paramdescription
eventNamestring
Skipify event code name
eventTypestring
sync
liveboolean
true or false
payload{}object
merchantReference : string: Your unique reference related to the order or cart. This value will be passed to the PSP
merchantID : string : Your Skipify merchant ID
cart : object
shippingAddress : object
shippingOption : selected shipping option ID
discountCode : discount code String
metadata : object

ORDER_RESOLVE Callback Event

This callback event will be used to render cart details about the order. Skipify will pass your unique merchantReference you defined when you initiated the SDK.

Sample ORDER_RESOLVE Request and Response

{
"eventName": "ORDER_RESOLVE",  
"eventType": "sync",
"live": false, // this can be either true or false depending on the environment 
"payload": {
  "merchantReference": "YOUR_MERCHANT_REFERENCE", // this is your unique order or cart reference
  "merchantId": "YOUR_MERCHANT_ID" // this is your skipify merchant ID
 }
}
 {
	"cart": [
		{
			"itemId": "IT123123",
			"title": "Line item one",
			"quantity": 1, // integer
      "productType": "physical",
			"price": {
				"value": 1050,  // $10.50
				"uom": "USD"
			},
			"image": {
				"url": "URL HERE",
				"alt": "text"
			}
		},
		{
			"itemId": "IT4435343",
      "title": "line item 2",
			"quantity": 2, // integer
      "productType": "physical",
			"price": {
				"value": 2125, // $21.25 
				"uom": "USD"
			},
			"image": {
				"url": "URL HERE",
				"alt": "text"
			}
		}
	]
}

 {
	"cart": [
		{
			"itemId": "ORDER12312441232",
			"title": "ORDER 512300",
			"quantity": 1,    // integer
      "productType": "physical",
			"price": {
				"value": 5300,  // total order amount $53.00
				"uom": "USD"
			},
			"image": {            // optional
				"url": "URL HERE",  // optional
				"alt": "text"      // optional
			}
		}
	]
}

Request Parameters

For this event the request parameters are only the standard parameters

Response Parameters

Parameter NameTypeDescription
cartobjectThis will be the cart items

Cart Object Parameters

Parameter NameTypeRequiredDescription
titlestringyesThe title of the item(s) to be displayed
itemIdstringyesThis is the ID of your line item
productTypestringnoThe type of product. Example: shirt, pizza
quantityintegeryesLine item quantity
descriptionstringnoDescribes the cart item
priceunit objectyesThese are the amounts for each product / item
imageprice objectno{url:"", alt:""}
unit object Parameters
Parameter NameTypeRequiredDescription
valueintegeryesThe value of an item in minor units. $20.50 would be sent as 2050.
uomstringyesISO4217 three letter code identifying the currency. Skipify is only processing transactions in USD at this time.
image object Parameters
Parameter NameTypeRequiredDescription
urlstringnoUrl of the image
altstringnoA text to be displayed on hover

ORDER_CHANGE Callback Event

This callback event will be used to render more details and/or shopper-made updates about the order. Skipify will pass your unique merchantReference you defined when you initiated the SDK along with other parameters below.

Sample ORDER_CHANGE Request and Response

{
"eventName": "ORDER_CHANGE",
"eventType": "sync",
"live": false,
"payload": {
  "cart" :[], // your cart details here
  "shippingAddress": {  
    "firstName": "John",
    "lastName": "Doeg",
    "address1": "123 main street",
    "city": "New York",
    "localityCode": "NY",
    "zipCode": "10001",
    "countryCode": "USA"
  },
   "merchantReference": "YOUR MERCHANT REFERENCE",
   "merchantId":"YOUR MERCHANT ID",
   "shippingOption" : "Selected shipping option ID",
   "discountCode": "discount code entered by shopper" // wont be sent if shipper hasnt entered one
  }
}
{
"shippingOptions": [
 { "optionType": "FLAT", "id": "fast-option-id", "optionName": "Fast Shipping", "defaultFee": { "value": 800, "uom": "USD" } },      
 { "optionType": "FLAT", "id": "free-option-id", "optionName": "Free Shipping", "defaultFee": { "value": 900, "uom": "USD" } }
],
"taxDetails": [
 {
  "value": 200,  // minor unit integer
  "uom": "USD"
 }
],
"discountAmount": {
 "value": 1000,  // minor unit integer
 "uom": "USD"
}
}

Request Parameters

For this event the request parameters are the standard parameters along with the following

Parameter NameTypeDescription
cartcart objectThis will be the cart items
shippingAddressshippingAddress objectThe shipping address details
Example:
{
"firstName": "John",
"lastName": "Doe",
"address1": "123 Main St",
"address2": "Apt 1",
"city": "San Francisco",
"localityCode":"CA",
"zipCode": "94105",
"countryCode":"US"
}
shippingOptionsshippingOptions objectAn array of Shipping details
taxDetailstaxDetails objectAn object of Tax details
discountCodeStringThis is the discount code that the user inputs on the Skipify experience if applicable.

Cart Object Parameters

Parameter NameTypeRequiredDescription
titlestringyesThe title of the item(s) to be displayed
itemIdstringyesThis is the ID of your line item
productTypestringnoThe type of product. Example: shirt, pizza
quantityintegeryesLine item quantity
descriptionstringnoDescribes the cart item
priceunit objectyesThese are the amounts for each product / item
imageprice objectno{url:"", alt:""}

ShippingAddress Object Parameters

Parameter NameTypeDescription
firstnamestringFirst Name
lastnamestringLast Name
address1stringStreet address
address2stringStreet address
citystringCity name
localityCodestringLocality code could be state, region, territory, province, etc...
zipCodestringZip code
countryCodestringCountry Code

ShippingOptions Object Parameters

Parameter NameTypeRequiredDescription
idstringyesThe unique ID of the shipping method
optionNamestringyesThe name associated with the shipping method to be displayed

Example: USPS Ground, UPS Express, etc
defaultFeeobjectyesThe price associated with the shipping method
optionTypestringyes‘FLAT’, ‘PERITEM’, ‘WEIGHT_RANGE’, ‘PRICE_RANGE’
optionDescriptionstringnoThe description of the shipping method

TaxDetails Object Parameters

Parameter NameTypeDescription
valueintegerThe value of an item. The last two digits are cents, so $20.50 would be sent as 2050.
uomstringThree letter code to identify the currency. Skipify is only processing transactions in USD at this time. Make sure you are passing USD as a value.

Response Parameters

Parameter NameTypeDescription
cartcart objectThis will be the cart items
shippingAddressshippingAddress objectThe shipping address details
shippingOptionsshippingOptions objectAn array of Shipping details
taxDetailstaxDetails objectAn array of Tax details
discountAmountdiscountAmount objectThis is the discount value

Cart Object Parameters

Parameter NameTypeRequiredDescription
titlestringyesThe title of the item(s) to be displayed
itemIdstringyesThis is the ID of your line item
productTypestringnoThe type of product. Example: shirt, pizza
quantityintegeryesLine item quantity
descriptionstringnoDescribes the cart item
priceunit objectyesThese are the amounts for each product / item
imageprice objectno{url:"", alt:""}

ShippingAddress Object Parameters

Parameter NameTypeDescription
firstnamestringFirst Name
lastnamestringLast Name
address1stringStreet address
address2stringStreet address
citystringCity name
localityCodestringLocality code could be state, region, territory, province, etc...
zipCodestringZip code
countryCodestringCountry Code

ShippingOptions Object Parameters

Parameter NameTypeRequiredDescription
idstringyesThe unique ID of the shipping method
optionNamestringyesThe name associated with the shipping method to be displayed

Example: USPS Ground, UPS Express, etc
defaultFeeobjectyesThe price associated with the shipping method
optionTypestringyes‘FLAT’, ‘PERITEM’, ‘WEIGHT_RANGE’, ‘PRICE_RANGE’
optionDescriptionstringnoThe description of the shipping method

TaxDetails Object Parameters

Parameter NameTypeDescription
valueintegerThe value of an item. The last two digits are cents, so $20.50 would be sent as 2050.
uomstringThree letter code to identify the currency. Skipify is only processing transactions in USD at this time. Make sure you are passing USD as a value.

DiscountAmount Object

Parameter NameTypeRequiredDescription
valueintegeryesThe amount of the Discount for the discountCode applied for this order (if applicable). The last two digits are cents, so $20.50 would be sent as 2050.
uomstringyesThree letter code to identify the currency. Skipify is only processing transactions in USD at this time. Make sure you are passing USD as a value.

ORDER_VERIFY Callback Event

This callback event is used to validate the order details before a payment is processed. It’s an optional additional check you can use to ensure the order can be completed before the payment is authorized. This is helpful to use with rapidly changing inventory or order lifecycle changes.

Request Parameters

Skipify will pass the order information compiled from other events including product information, shipping address, pricing information, and if applicable, shipping options and discount codes.

Sample ORDER_VERIFY Request and Response

{
	"merchantReference": "YOUR MERCHANT REFERENCE",
	"merchantId": "YOUR MERCHANT ID",
	"eventName": "ORDER_VERIFY",
	"eventType": "sync",
	"live": false,
	"cart": [],   //your cart details here
	"shippingAddress": {
		"firstName": "String",
		"lastName": "String",
		"address1": "String",
		"address2": "String",
		"city": "String",
		"localityCode": "String",
		"zipCode": "String",
		"countryCode": "String"
	},
	"shippingOptions": [
		{
			"id": "String",
			"optionName": "String",
			"optionType": "String",
			"defaultFee": {
				"value": 1000, // integer
				"uom": "USD"
			}
		}
	],
	"taxDetails": [
		{
			"systemOfOriginId": "String",
			"value": 500, // integer
			"uom": "USD",
			"code": "String" 
		}
	],
	"discountAmount": {
		"value": 0, //integer
		"uom": "USD"
	}
}

Response Parameters

Skipify needs to know if the order information passed in the request can be fulfilled.

Valid responses could be:

  • An empty array that signifies the order can be fulfilled
  • Passing the same properties back

📘

Note

An error produced during this step means that the order can not be fulfilled. Skipify will prompt the user to make adjustments to the order before triggering this callback again.

Front End optional callbacks

The purpose of these callbacks is to provide customizable behavior when certain events occur, such as closing a component or after a successful transaction

Implementation Details:

The implementation involves utilizing two callback functions: onClose and onApprove. These functions are passed as options to the email and button methods provided by the skipifySdk. Below is the structure of the options object:

const options = {
    onClose: (myRef, success) => { //optional
        // Your onClose callback code here
    },
    onApprove: (myRef, data) => { //optional
        // Your onApprove callback code here
    }
};

These callbacks accept parameters that provide context about the event:

myRef: A string parameter representing your unique merchant identifier or reference associated with the transaction.
success: A boolean parameter indicating the success or failure of the transaction (applicable for onClose callback).
data: An object containing additional data or payload associated with the action (applicable for onApprove callback).

{
    "orderId": "dummy_order_id",
    "customerInfo": {
        "email": "[email protected]",
        "paymentMethod": {
            "address": {
                "address1": "123 Dummy St",
                "address2": null,
                "city": "Dummyville",
                "country": "US",
                "externalId": "dummy_payment_address_id",
                "firstName": "John",
                "lastName": "Doe",
                "isDefaultShipping": true,
                "phoneNumber": "1234567890",
                "state": "CA",
                "zip": "12345"
            },
            "addressId": "dummy_payment_address_id",
            "cardBrand": "VISA",
            "expMonth": 12,
            "expYear": 29,
            "externalId": "dummy_payment_method_id",
            "fullNameCard": "John Doe",
            "isDefault": true,
            "last4CardNumber": "1111",
            "needsCvv": true,
            "nickName": null
        },
        "phoneNumber": "1234567890"
    },
    "shippingInfo": {
        "address1": "123 Dummy St",
        "address2": null,
        "city": "Dummyville",
        "country": "US",
        "externalId": "dummy_shipping_address_id",
        "firstName": "John",
        "lastName": "Doe",
        "isDefaultShipping": true,
        "phoneNumber": "1234567890",
        "state": "CA",
        "zip": "12345"
    },
    "billingInfo": {
        "address1": "123 Dummy St",
        "address2": null,
        "city": "Dummyville",
        "country": "US",
        "externalId": "dummy_billing_address_id",
        "firstName": "John",
        "lastName": "Doe",
        "isDefaultShipping": true,
        "phoneNumber": "1234567890",
        "state": "CA",
        "zip": "12345"
    },
    "shippingMethod": {
        "externalId": "dummy_shipping_method_id",
        "name": "Dummy Shipping",
        "price": 800
    },
    "taxes": 289,
    "transactionDetails": {
        "PspTransactionId": "dummy_psp_transaction_id",
        "pspRawResponse": "dummy_psp_response"
    }
}

Usage Examples

const options = {
    onClose: (myRef, success) => { //optional
        // Your onClose callback code here
    },
    onApprove: (myRef, data) => { //optional
        // Your onApprove callback code here
    }
};

skipifySdk.email("your merchant reference here", options).enable(<your-input-object>);
const options = {
    onClose: (myRef, success) => { //optional
        // Your onClose callback code here
    },
    onApprove: (myRef, data) => { //optional
        // Your onApprove callback code here
    }
};

skipifySdk.button("your-merchantReference", options).render( < your-container > );

Callback Implementation

onClose Callback:

  • Use the onClose callback to define actions to be taken when the component is closed.
  • Utilize the myRef parameter to identify the specific component or action associated with the closure.
  • Optionally, use the success parameter to determine the success status of the action.

onApprove Callback:

  • Use the onApprove callback to define actions to be taken when an action is approved.
  • Utilize the myRef parameter to identify the specific component or action associated with the approval.
  • Utilize the data parameter to access any additional information or payload associated with the approval.

Skipify baner with link to contact us form