Developer Resources

API Documentation

Build powerful lending applications with our comprehensive API. Every feature available through clean, well-documented endpoints.

99.99%

API Uptime

<50ms

Avg Response

200+

API Endpoints

6

Official SDKs

example.ts
// Initialize the Paywallet SDK
import Paywallet from '@paywallet/sdk';

const client = new Paywallet({
 apiKey: process.env.PAYWALLET_API_KEY,
 environment: 'sandbox' // or 'production'
});

// Create a new loan
const loan = await client.loans.create({
 borrowerId: 'bor_123abc',
 productId: 'prod_456def',
 principalAmount: 25000,
 termMonths: 36,
 interestRate: 8.5,
 disbursementDate: '2024-01-15'
});

console.log('Loan created:', loan.id);
// Output: Loan created: loan_789xyz

Developer-first platform

Everything you need to integrate lending into your applications.

RESTful API

Clean, intuitive RESTful endpoints following industry best practices with comprehensive documentation.

SDKs & Libraries

Official SDKs for Python, JavaScript, Ruby, PHP, and more popular languages with type definitions.

Webhooks

Real-time event notifications for loan lifecycle events with configurable retry policies.

OAuth 2.0 & API Keys

Secure authentication with API keys for server-to-server and OAuth 2.0 for user authorization.

Sandbox Environment

Full-featured sandbox for testing without affecting production data. Instant API key provisioning.

Interactive Docs

Try API calls directly in the browser with our interactive documentation and code generators.

Official SDKs

🟨

JavaScript/TypeScript

v2.5.0

🐍

Python

v2.4.1

💎

Ruby

v2.3.0

🐘

PHP

v2.2.0

🔵

Go

v2.1.0

Java

v2.0.5

API Endpoints

A preview of our most commonly used endpoints.

GET/v1/loans
POST/v1/loans
GET/v1/loans/{id}
PATCH/v1/loans/{id}
POST/v1/payments
GET/v1/payments/{id}
GET/v1/borrowers
POST/v1/borrowers
POST/v1/applications
GET/v1/applications/{id}/status
POST/v1/webhooks
GET/v1/reports/portfolio

Webhooks

Receive real-time notifications when events occur in your lending platform. Configure webhooks to automate workflows and keep your systems in sync.

  • Automatic retries with exponential backoff
  • Webhook signature verification
  • Event filtering by type
  • Detailed delivery logs

Available Events

loan.createdFired when a new loan is created
loan.disbursedFired when funds are disbursed
payment.receivedFired when a payment is processed
payment.failedFired when a payment fails
loan.delinquentFired when a loan becomes delinquent
loan.paid_offFired when a loan is fully paid

Ready to start building?

Get your API keys and start integrating in minutes. Free sandbox environment with full API access.