OVN Pay API

Appearance

API Endpoints ​

Complete list of all available API endpoints.

Drivers ​

List Drivers ​

http
GET /api/v1/drivers

Query Parameters:

  • page (integer, optional): Page number (default: 1)
  • pageSize (integer, optional): Items per page (default: 50)
  • status (string, optional): Filter by status (active, inactive, pending)

Response:

json
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "drv_abc123",
        "ovnId": "OVN123456",
        "email": "driver@example.com",
        "status": "active",
        "walletBalance": 0,
        "createdAt": "2025-01-15T10:30:00Z"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 50,
    "hasNextPage": false
  }
}

Get Driver by ID ​

http
GET /api/v1/drivers/:id

Create Driver ​

http
POST /api/v1/drivers

Body:

json
{
  "ovnId": "OVN123456",
  "email": "driver@example.com",
  "phone": "+15551234567"
}

Update Driver ​

http
PUT /api/v1/drivers/:id

Delete Driver ​

http
DELETE /api/v1/drivers/:id

Payouts ​

Create Payout ​

http
POST /api/v1/payouts

Body:

json
{
  "driverId": "drv_abc123",
  "amount": 50000,
  "description": "Load #12345",
  "rail": "standard"
}

Rails:

  • standard - Standard ACH (1-2 business days)
  • instant - Instant payout (seconds to minutes)

List Payouts ​

http
GET /api/v1/payouts

Query Parameters:

  • page, pageSize - Pagination
  • driverId - Filter by driver
  • status - Filter by status
  • rail - Filter by rail type

Get Payout Details ​

http
GET /api/v1/payouts/:id

Cancel Payout ​

http
POST /api/v1/payouts/:id/cancel

Retry Failed Payout ​

http
POST /api/v1/payouts/:id/retry

Batches ​

Create Batch ​

http
POST /api/v1/batches

Body:

json
{
  "name": "Weekly Payouts 2025-01-15",
  "payoutIds": ["payout_1", "payout_2", "payout_3"]
}

List Batches ​

http
GET /api/v1/batches

Get Batch Details ​

http
GET /api/v1/batches/:id

Release Batch ​

http
POST /api/v1/batches/:id/release

Run Batch ​

http
POST /api/v1/batches/:id/run

Balance ​

Get Wallet Balance ​

http
GET /api/v1/balance

Response:

json
{
  "success": true,
  "data": {
    "available": 5000000,
    "pending": 250000,
    "currency": "USD"
  }
}

Instant Pay ​

Request Instant Pay ​

http
POST /api/v1/payouts/instant

Body:

json
{
  "driverId": "drv_abc123",
  "amount": 50000,
  "cardLast4": "1234",
  "description": "Instant pay request"
}

Get Instant Pay Fee ​

http
GET /api/v1/payouts/instant/fee?amount=50000

Response:

json
{
  "success": true,
  "data": {
    "amount": 50000,
    "fee": 250,
    "feePercent": 0.5,
    "total": 50250,
    "estimatedDeposit": 49750
  }
}