Jump to Content
ZipGuidesAPI Reference
HomeGuidesAPI Reference
GuidesAPI ReferenceLog InZip
API Reference
Log In

Gateway API

  • Orders
    • /orders/{orderId}/statusget
    • /orders/authorizepost
    • /orders/authorize (for Advanced Approvals merchants)post
    • /orders/{orderId}/capturepost
    • /orders/{orderId}/refundpost
    • /orders/{orderId}/voidpost
    • /orders/{orderId}/confirmpost
    • /orders/associatepost
  • Configuration
    • /configuration/{merchantId}get
  • Merchant Disputes
    • /merchant-disputes/searchget
    • /merchant-disputesget
    • /merchant-disputes/fileget
    • /merchant-disputes/closepost
    • /merchant-disputes/submit-evidencepost
    • /merchant-disputes/filepost
    • /merchant-disputes/filedel
  • Reporting
    • /transactions/{merchantId}/v3get
    • /transactions/{merchantId}/v3/csvget
    • /payments/{merchantId}/jsonget
    • /payments/{merchantId}/csvget

Single Merchant Interface (SMI) API

  • Overview
    • Create a checkoutpost
    • Create a chargepost
    • Capture a chargepost
    • Refundpost
    • Voidpost
    • Calculate Installment Fee (formerly MFPP)post
    • Retrieve a checkoutget
    • Retrieve a chargeget

Master Gateway

  • Getting Started With Your API
Powered by 

Reporting

The merchant Reporting endpoints allow you to manage reporting outside of the Merchant Portal. To consume these reports, the API integration utilizing the seller-provided API credentials is the best path forward. Both reporting APIs support output for ‘amt’ in JSON and CSV.

Base URLs

Production - US - https://gateway.us.zip.co/
Sandbox (Test) - US - https://gateway.sand.us.zip.co/

  • Table of Contents
    • Base URLs