The first API call you will make in processing a zip payment is a call to our /checkouts endpoint. This request is made once a customer chooses to use zip as their payment method at checkout and will contain all order and customer information. The zip API will then provide a response that includes a redirect url, allowing you to point the customer to the Zzip checkout flow where they will complete their application or log in to their zip account to confirm the payment.

The Checkouts Response
  • id STRING

    unique Checkout identifier. This value will be used throughout the integration flow to complete the payment authorisation.

  • uri STRING

    URL where customers will be redirected to complete the payment authorisation.

  • type STRING

    checkout type standard or express . Default value is standard.

  • created STRING

    The date on which the checkouts was created.

  • state STRING

    Checkout status created approved completed expired

  • product STRING

    Zip product name

Language
Authentication
Header
Click Try It! to start a request and see the response here!