Developer Documentation

Build with the Zypply API

Integrate secure escrow, instant payments, and supplier verification directly into your applications with our powerful REST API.

View Full Docs Get API Key

RESTful Design

Clean, predictable REST endpoints with JSON responses. Built with developer experience in mind.

Secure by Default

API key authentication, rate limiting, and webhook signatures to keep your integration secure.

Webhooks

Real-time event notifications for payment confirmations, escrow releases, and status changes.

Sandbox Environment

Full-featured test environment with simulated transactions. Test everything before going live.

Comprehensive Docs

Detailed guides, API reference, and code examples to get you building quickly.

Developer Support

Dedicated API support team ready to help you build and troubleshoot your integration.

API Endpoints

Our API covers everything you need to manage escrow transactions, suppliers, and payments.

Escrow

POST /v1/escrow Create new escrow

GET /v1/escrow/{id} Get escrow details

POST /v1/escrow/{id}/release Release funds

POST /v1/escrow/{id}/dispute Open dispute

Payments

POST /v1/payments Initiate payment

GET /v1/payments/{id} Get payment status

GET /v1/payments List all payments

Suppliers

GET /v1/suppliers Search suppliers

GET /v1/suppliers/{id} Get supplier profile

GET /v1/suppliers/{id}/verify Verify supplier

Quick Start

Get started with just a few lines of code. Here's how to create an escrow transaction.

// Initialize the Zypply client
import Zypply from '@zypply/sdk';

const zypply = new Zypply('sk_live_your_api_key');

// Create a new escrow transaction
const escrow = await zypply.escrow.create({
  amount: '50000.00',
  currency: 'USDC',
  supplier_id: 'sup_abc123',
  description: 'Industrial equipment purchase',
  milestones: [
    { name: 'Order confirmed', percentage: 30 },
    { name: 'Shipped', percentage: 40 },
    { name: 'Delivered', percentage: 30 }
  ]
});

console.log(escrow.id); // esc_xyz789