API Reference Introduction

Welcome to the zDirect Platform API Reference Guide.

This section includes an OpenAPI/Swagger reverence for all endpoints.

Each API is documented in this reference in two pages:

  • The API Overview page provides a description of each API and its principle uses, as well as:
    • information on scopes
    • rate limiting policy
    • sandbox behavior
  • The API Reference page is a Swagger or OpenAPI reference for the API.

We recommend that all developers begin with the Getting Started Guide, which provides an introduction to the zDirect API, an overview of the stages of integration, and other information that every developer will need to know.

Our Developer Guide presents a conceptual, task-based guide to the stages of integration using the zDirect API.


We are available to assist you during every step of integration through our Integration Management Services.

Contact Support