Skip to main content

​
Overview

Payout Operations API provides administrative functions for processing store payout requests, managing payout workflows, and handling financial operations. Location: convex/admins/payoutOperations.ts

​
Get Pending Payouts

​
storeId
Id<'stores'>
Filter by store ID
​
limit
number
Maximum records
const pendingPayouts = await convex.query(api.admins.payoutOperations.getPendingPayouts, {
  limit: 50
});

​
Approve Payout

​
adminUserId
string
required
Admin user ID
​
payoutId
Id<'payouts'>
required
Payout ID
await convex.mutation(api.admins.payoutOperations.approvePayout, {
  adminUserId: "admin_123",
  payoutId: "p123456789",
  adminNotes: "Approved after verification"
});

​
Complete Payout

​
adminUserId
string
required
Admin user ID
​
payoutId
Id<'payouts'>
required
Payout ID
await convex.mutation(api.admins.payoutOperations.completePayout, {
  adminUserId: "admin_123",
  payoutId: "p123456789",
  transactionReference: "TXN123456789"
});
Payout operations require admin privileges and proper verification procedures.