canonical: https://jentic.com/apis/zip.co/zip

# Zip API

Buy now, pay later (BNPL) payment processing API. The API exposes 10 endpoints secured with apiKey authentication.

## For AI agents

Programmatically authorize order, get order status. Covers 10 operations with apiKey authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Authorize order
- Get order status
- Capture order
- Refund order
- Void order
- Confirm order

## Use cases

### Payments Operations

Use the Zip API to perform payments operations programmatically. The API provides 10 endpoints covering core functionality including authorize order, get order status, capture order.

Example prompt: Call POST /orders/authorize to authorize order

### Automated Orders Management

Automate orders operations by combining multiple Zip API endpoints. Agents can get order status and then capture order in a single workflow.

Example prompt: Call GET /orders/{orderId}/status to get order status, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Zip API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'authorize order', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /orders/authorize | Authorize order |
| GET | /orders/{orderId}/status | Get order status |
| POST | /orders/{orderId}/capture | Capture order |
| POST | /orders/{orderId}/refund | Refund order |
| POST | /orders/{orderId}/void | Void order |
| POST | /orders/{orderId}/confirm | Confirm order |
| GET | /configuration/{merchantId} | Get merchant configuration |
| GET | /merchant-disputes/search | Search merchant disputes |

## Key resources

- **Orders** — Order management and processing
- **Configuration** — Merchant configuration
- **Disputes** — Merchant dispute management

## Why Jentic

- **Setup:** Wiring Zip by hand means computing its X-QP-Signature header on every request and pointing calls at the US gateway host yourself. Through Jentic you install once, import Zip from the API Directory, store the signing credential once, and your agent calls it.
- **Permission scoping:** Zip puts the order id in the URL path (/orders/{orderId}/...), so a rule can pin your agent to one order: it can check status and confirm that order and nothing else. You choose the operations it may call, so money-moving ones like capture, refund, or void are not included unless you add them.
- **Credential handling:** Your Zip signing credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'authorize an order' or 'check order status', and Jentic returns the matching Zip operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Zip API use?

The Zip API uses an API key passed in the `X-QP-Signature` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I authorize order with the Zip API?

Yes. Use the POST /orders/authorize endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Zip API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I authorize order through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'authorize order'. Jentic returns the matching Zip API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Zip API have?

The Zip API exposes 10 endpoints covering orders, configuration, disputes operations.

### Can I limit what my agent is allowed to do with the Zip API?

Yes. Jentic One is self-hosted, so your own rules decide which Zip operations and credentials your agent may use. Because Zip puts the order id in the URL path (/orders/{orderId}/...), a rule can pin the agent to a single order and let it only check status and confirm that order. You choose the operations it may call, so money-moving ones like capture, refund, and void stay off limits unless you explicitly add them.