For AI agents: visit https://docs.us.zip.co/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
ZipZipGuidesAPI 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
    • Retrieve a checkoutget
    • Retrieve a chargeget

Master Gateway

  • Getting Started With Your API
Powered by 

Configuration

The merchant Configuration endpoint allows you to see the checkout configuration for a merchant.

Base URLs

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

Updated over 2 years ago


What’s Next

  • /configuration/{merchantId}

Updated over 2 years ago


What’s Next

  • /configuration/{merchantId}
  • Table of Contents
    • Base URLs