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
    • Retrieve a checkoutget
    • Retrieve a chargeget

Master Gateway

  • Getting Started With Your API
Powered by 

/order

post https://api.us.zip.co/order

Creates Order in Zip

If the merchant is configured with deferFundsCapture set to false, the entire order amount will be Captured immediately.

If this configuration is set to true, you are required to manually call the /capture endpoint when you want funds to be released.

Response Data Types

KeyValue Data Type
expiryDateTimestring
redirectUrlstring
orderIdstring
Language
Credentials
OAuth2