Skip to content

Update ZipPay API endpoints to v2 with new domains#8

Open
jack-workhouse wants to merge 3 commits intoignited:masterfrom
jack-workhouse:update-zippay-api-endpoints-v2
Open

Update ZipPay API endpoints to v2 with new domains#8
jack-workhouse wants to merge 3 commits intoignited:masterfrom
jack-workhouse:update-zippay-api-endpoints-v2

Conversation

@jack-workhouse
Copy link
Copy Markdown

@jack-workhouse jack-workhouse commented Aug 25, 2025

Summary

Updates the ZipPay API endpoints from v1 to v2 with new domain infrastructure. This includes both an API version upgrade and domain migration from the legacy zipmoney.com.au domains to the new merchant-api.com domains.

Changes

  • Live endpoint: Updated from https://api.zipmoney.com.au/merchant/v1 to https://merchant-api.com/au/merchant/v2
  • Sandbox endpoint: Updated from https://api.sandbox.zipmoney.com.au/merchant/v1 to https://sand.merchant-api.com/au/merchant/v2

Reason

ZipPay is migrating to v2 API endpoints with new domain infrastructure. This update includes:

  • API version upgrade from v1 to v2
  • Domain migration from zipmoney.com.au to merchant-api.com
  • Following ZipPay's latest API recommendations

Please see: https://developers.zip.co/v11/docs/checkouts-api-merchants

- Update live endpoint from api.zipmoney.com.au/merchant/v1 to merchant-api.com/au/merchant/v2
- Update sandbox endpoint from api.sandbox.zipmoney.com.au/merchant/v1 to sand.merchant-api.com/au/merchant/v2
- Follows ZipPay's new v2 API endpoint structure
- Live endpoint: https://merchant-api.com/au/merchant/v1
- Sandbox endpoint: https://sand.merchant-api.com/au/merchant/v1
- Only the domain is changing from zipmoney.com.au to merchant-api.com
@jack-workhouse jack-workhouse changed the title Update ZipPay API endpoints to v2 Update ZipPay API endpoint domains (v1 endpoints maintained) Aug 25, 2025
@simonworkhouse
Copy link
Copy Markdown

I had to double check other implementations because the merchant-api.com domain really does not feel right, but it's in the official Zip documentation and I have confirmed that this change is present in their WordPress plugin. See https://plugins.trac.wordpress.org/changeset/3348133/zipmoney-payments-woocommerce/trunk/vendor/zipmoney/merchantapi-php/lib/Configuration.php?old=3293661&old_path=zipmoney-payments-woocommerce%2Ftrunk%2Fvendor%2Fzipmoney%2Fmerchantapi-php%2Flib%2FConfiguration.php

@alexw23
Copy link
Copy Markdown
Contributor

alexw23 commented Aug 27, 2025

Hi @jack-workhouse thanks for the PR, will take a look later this week or next.

@jack-workhouse jack-workhouse changed the title Update ZipPay API endpoint domains (v1 endpoints maintained) Update ZipPay API endpoint domains to v2 Aug 27, 2025
@jack-workhouse jack-workhouse changed the title Update ZipPay API endpoint domains to v2 Update ZipPay API endpoints to v2 with new domains Aug 27, 2025
@alexw23
Copy link
Copy Markdown
Contributor

alexw23 commented Sep 2, 2025

@jack-workhouse, have had a chance to review. May I ask why you are proposing to bump to v2? The new API endpoint should be: https://merchant-api.com/au/merchant/v1/ given this package has only been tested for v1.

@jack-workhouse
Copy link
Copy Markdown
Author

@alexw23,

According to the Zip migration documentation (https://developers.zip.co/v11/docs/checkouts-api-merchants), this package is currently using the "Production AU (v2)" endpoints:

  • Current (OLD): https://api.zipmoney.com.au/merchant/v1/
  • Required (NEW): https://merchant-api.com/au/merchant/v2/

The documentation shows that what Zip calls "v2" in the new domain structure corresponds to the /merchant/v1/ path in the old domain. It's Zip's new versioning scheme for their domain migration.

@simonworkhouse
Copy link
Copy Markdown

@alexw23 Zip have stated that the existing domain is going to be retired at the end of this month, although not sure if that means they're going to deactivate it or not. I'd hope that they'd just leave it active, but I have not been able to get any confirmation from Zip on that yet.

@alexw23
Copy link
Copy Markdown
Contributor

alexw23 commented Sep 17, 2025

@jack-workhouse @simonworkhouse

The project I'm working on is no longer using Zip thus for my slight apathy here. Would either one of you like to take over this repo?

@simonworkhouse
Copy link
Copy Markdown

@alexw23 I'm not entirely fond of the idea of taking over the repo but could possibly be persuaded to become a maintainer of sorts. With that in mind, we'd also have to consider how package versions would be published to packagist, are the relevant webhooks set up? I wouldn't want access to your packagist organisation and we'd have to have the absolute minimum required permissions assigned. Maybe we could find a way to compensate you for your time instead?

@simonworkhouse
Copy link
Copy Markdown

Seeing that there's limited time left for this (according to Zip's notice) we may have to consider maintaining a fork instead. Unless of course this PR might be merged this week, perhaps?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants