API Reference
Section titled “API Reference”The VoltPay API allows programmatic access to contractor management, pay runs, and payment tracking.
Authentication
Section titled “Authentication”All API requests require a Bearer token in the Authorization header:
Authorization: Bearer vp_live_xxxxxxxxxxxxxEndpoints
Section titled “Endpoints”Contractors
Section titled “Contractors”| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/contractors | List all contractors |
| POST | /v1/contractors | Create a contractor |
| GET | /v1/contractors/:id | Get contractor details |
| PATCH | /v1/contractors/:id | Update a contractor |
Pay Runs
Section titled “Pay Runs”| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/pay-runs | List pay runs |
| POST | /v1/pay-runs | Create a pay run |
| POST | /v1/pay-runs/:id/approve | Approve a pay run |
| GET | /v1/pay-runs/:id/status | Get pay run status |
Payments
Section titled “Payments”| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/payments | List payments |
| GET | /v1/payments/:id | Get payment details |
| GET | /v1/payments/:id/tracking | Get payment tracking info |
Rate Limits
Section titled “Rate Limits”- 100 requests per minute per API key
- Bulk operations count as a single request
Webhooks
Section titled “Webhooks”VoltPay sends webhooks for key events:
payment.completed: A payment was successfully deliveredpayment.failed: A payment failedcontractor.verified: KYC verification completedpayrun.ready: A scheduled pay run is ready for approval