Zip API

Name: Zip API
Brand: Zip API
Availability: InStock

✓ Official Vendor SpecPaymentsPayment ProcessingapiKey10 EndpointsREST

For Agents

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

Use for: I need to authorize order, I want to order status, Search for capture order, Find all refund order

Install Jentic One Beta

Connect the Zip API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Zip API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Zip API.

Authorize order

Get order status

Capture order

Refund order

GET STARTED

Start building with Zip API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Zip API for, with concrete tasks.

★ 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.

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.

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.

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

Key Endpoints

10 endpoints — buy now, pay later (bnpl) payment processing api.

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

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

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Zip API apiKey credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'authorize order') and Jentic returns the matching Zip API operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct Zip API integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Zip API through Jentic.

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 the MAXsystem vault 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 at https://app.jentic.com/sign-up, 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.

Zip API

Connect the Zip API to your agent

Capabilities

Start building with Zip API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs