Core Resources
Explore VeriPay's core API resources for managing payments, invoices, customers, quotations, and products.
API Resources Overview
VeriPay API is organized around REST principles with predictable, resource-oriented URLs and uses standard HTTP response codes, authentication, and verbs.
JSON Everywhere
Content-Type: application/json.
Payments
Create payment links, track payment status, and manage the payment verification lifecycle.
Invoices
Generate professional invoices, send them to customers, and track payment status automatically.
Customers
Manage customer information, store contact details, and track customer payment history.
Quotations
Standard+Create professional quotes, send them to prospects, and convert accepted quotes to invoices.
Products
Manage your product catalog, track inventory, and organize your services and offerings.
Webhooks
Configure real-time notifications for payment events, invoice updates, and status changes.
Common API Patterns
Resource URLs
All API endpoints follow consistent URL patterns:
# List resources
GET /api/v1/{resource}
# Create resource
POST /api/v1/{resource}
# Get specific resource
GET /api/v1/{resource}/{id}
# Update resource
PATCH /api/v1/{resource}/{id}
# Delete resource
DELETE /api/v1/{resource}/{id}Pagination
List endpoints support pagination with consistent parameters:
Filtering & Search
Use query parameters to filter and search resources:
# Filter by status
GET /api/v1/payments?status=pending
# Search by customer email
GET /api/v1/[email protected]
# Date range filtering
GET /api/v1/invoices?created_after=2024-01-01&created_before=2024-12-31
# Multiple filters
GET /api/v1/payments?status=verified&amount_min=10000&customer_id=123Error Handling
All resources use consistent error response formats. Learn more in our Error Handling guide.
Explore Individual Resources
Click on any resource above to see detailed documentation with examples, or start with payments: