---
updatedAt: 2026-07-17T02:14:13.000Z
agentTools:
  projectIndex: https://developers.zip.co/llms.txt
---

# API References

<HTMLBlock>{`
<div class="article_header">
<div class="article__header--icon">
<img src="https://docs.adyen.com/user/themes/adyen-docs/assets/icons/plugins.svg" alt="Plugin icon">
</div>
<div class="article__header--title" id="page-introduction">
<h1 class="article__title">

API Documentation and references
</h1>
<p class="article__header--description">

Build out your custom API integration in the following regions</p>
</div>
<div class="clearfix"></div>
</div>
`}</HTMLBlock>

<div class="zip-api-reference-text">
  <span>The Zip API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication.</span>
  <br/><br/>
  <span>You can use the Zip API in test mode, which does not affect your live data. All you need to do is use the sandbox API endpoint along with your sandbox API credentials.</span>
</div>

<HTMLBlock>{`
<span>NOT A DEVELOPER?</span>
<span>Use our plugins to enable Zip in your ecommerce platform and start accepting Zip payments without writing a single line of code.</span>
`}</HTMLBlock>

<HTMLBlock>{`
<div style="
    margin-top: 9px;
    background-color: rgba(101, 66, 190, 0.08);
    border-radius: 17px;
    padding: 15px 35px 21px 35px;
    display: block;
">
<h3>What country are you in?</h3>

<p style="
    font-size: 15px;
">
  <strong> Make sure you have selected the API documentation and reference that match your region.</strong> 
</p>
 
  <div class="acceptedCountriesDiv">
  <span class="acceptedCountryLabel">Supported Regions</span>
  <ul class="acceptedCountriesList">
    <li class="open">
      <span>Australian API </span>
      <br/><br/>
      <div><a href="https://developers.zip.co/v2/docs/getting-started">Guide</a> | <a href="https://developers.zip.co/v2/reference/authentication">Reference</a></div>
    </li>
    <br/>
    <li class="open">
      <br/>
      <span>North America API</span>
      <br/><br/>
      <div><a href="https://docs.us.zip.co/docs/introduction">Guide</a> | <a href="https://docs.us.zip.co/reference/orders">Reference</a></div>             
    </li>
    <br/><br/>
  </ul>
</div>
</div>
`}</HTMLBlock>

<br />