Web Checkouts

Update API and/or checkout Javascript urls

Plugin icon

Web Checkouts Update

Online payments

Please folllow the guide below to update to the latest API endpoints and checkout Javascript (if required). Older endpoints will be sunsetted in the coming months.

Update Guide

  1. Update your API base urls for both sandbox and production.
  2. Determine if you are using our checkouts Javascript. If so, update your script base url.
  3. Test end to end payment in sandbox.

API base Urls

The base Url is the portion of a web address that serves as the root or main entry point for a website or API.

In the case of the Zip Checkouts API, you may see your solution is using an API endpoint as below for example:


If you are using any of the below base urls in your solution, please update accordingly.

❗️

There is NEW url version for each OLD url. Please make sure you update to the correct NEW url associated with your exiting url being used, as outlined below.

  • Sandbox AU (v1)
    • OLD: https://api.sandbox.zipmoney.com.au/v1/
    • NEW: https://sand.merchant-api.com/au/merchant/v1/
  • Sandbox AU (v2)
    • OLD: https://api.sandbox.zipmoney.com.au/merchant/v1/
    • NEW: https://sand.merchant-api.com/au/merchant/v2/
    Sandbox Global
    • OLD:https://global-api.sand.au.edge.zip.co/
    • OLD:https://api.sandbox.zip.co/
    • NEW: https://sand.merchant-api.com/
  • Production AU (v1)
    • OLD: https://api.zipmoney.com.au/v1/
    • NEW: https://merchant-api.com/au/merchant/v1/
    Production AU (v2)
    • OLD: https://api.zipmoney.com.au/merchant/v1/
    • NEW: https://merchant-api.com/au/merchant/v2/
    Production Global
    • OLD:https://global-api.prod.au.edge.zip.co/
    • OLD: https://api.zip.co/
    • NEW: https://merchant-api.com/

Checkout Javascript

The Zip Javascript SDK as an optional element for web integration, streamlining some of the work involved in creating a checkout and redirecting the user.

You may see your solution is using the below script (or similar) with a dated base Url:



If you are using the below base url in your solution, please update accordingly. Note there is no sandbox version.

Old JS base Url

https://static.zipmoney.com.au/

New JS base Url

https://static.zip.co/

End to end Testing

To confirm a succesful update, please place a test order in your pre-prod environment linked to the Zip sandbox environment.

  • Use our Test User Toolkit to generate a sandbox account for testing.
  • Place an order in your test / Sandbox / UAT environment and confirm user flow and payment processes as expected.

Please reach out to our team as below with any issues in testing or completing this change.




🛟

Need assistance updating?

Please contact our team directly at [email protected]