Getting Started

Plugin icon

API Products (North America)

Give your shoppers the option to pay with Zip on your web platform with our web checkout solution.

This document will outline the API and the high-level requirements of completing a custom Zip API integration as a payment gateway for a merchant's website in North America.

Quick Start

Simply complete each of the below steps to begin accepting Zip payments.

  1. Get sandbox credentials from the Integrations team and confirm your connection
  2. Integrate with the Zip product as defined in the pre-sales stage for your site
  3. Begin implementation and testing
  4. Certify and go live with Zip!

Alternative channels for accepting payments


Zip also offers a variety of alternative payment channels to accept Zip payments:

  • eCommerce plugins : Use our plugins to accept payments on leading technology platforms!
Supported Plugins in North America
  • Shopify
  • WooCommerce
  • BigCommerce
  • Magento 2

📘

Which API do I use? Gateway vs. Legacy


The API Endpoint Documentation references two well-supported APIs that are used for custom integrations — the Gateway and Legacy merchant APIs.

Zip recommends that all new integrations use the Gateway API. The Gateway API was built with additional resiliency and scalability in mind. Implementations with the Gateway have the following differences:

  • Zip will make a server-side webhook callback API request to the merchant's platform to confirm the success/failure of all operations, such as order authorizations, refunds, captures, and voids. This removes the need to poll for order processing updates from Zip.

  • The merchant will receive data on callbacks and user redirects to create the order in their system with all the data needed instead of multiple subsequent calls to Zip's API.

  • Requests to the Zip gateway API must contain a header with a signature to secure requests. This implementation results in less API calls to authenticate from our identity provider and no need for the merchant to manage credential caching.

  • Support for deferred order confirmation.

While our Gateway API is the preferred implementation path for merchant's looking to do a full custom API integration, we will continue to support the legacy API. When should you use the legacy API instead of the Gateway API?

  • You already have an integration with Zip and don't want to rebuild it.
  • You are unable to receive HTTP requests (for the webhooks/callbacks) from Zip servers in your system.