Getting started
First, you'll need a Zip account. If you haven’t already, please
You can build your Zip integration while you're waiting for account approval. You have full access to our Dashboard and APIs in test mode.
Read our Getting Started guide to get your Zip account set up.
Get your API key
To get started with the API, you will need an API key, which you can get from Developers > API keys.
Make sure you keep your API keys private. Never save API keys in your code or in Github. Instead use environment files and secure your server.
If you ever have issues with losing an API key, contact our support team immediately to revoke the key and generate a new one.
Making requests
The Zip API can be accessed from https://api.zip.ph. All requests should be made over HTTPS and every request requires authentication.
The API accepts and returns JSON-encoded data and as such you should include the following headers in each request.
Accept: application/json
Content-Type: application/json
Authentication
The API uses Basic authentication for all requests. You will need your API key from Developers > API keys.
To authenticate, add an Authorization header to all requests containing a valid API key:
Authorization: Basic {api_key}:
In summary, you need three headers (Accept, Content-Type, and Authorization) when making requests to our API.
For more information about authentication and rate limiting, please visit the API reference.
API overview
The Zip API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
You can use the API to manage your account as well set up payments for customers, manage refunds, and more.
Some examples of what's possible with the API:
- Create checkout links to accept payments
- Send payment requests to customers
- Charge a customer's saved card
- Refund a payment
For more information, check out our API reference.