DriverPayoutsApi

Method	HTTP request	Description
getDriverPayout	GET /vendors/`{vendor_id}`/drivers/`{driver_id}`/payouts/`{payout_id}`	Get driver payout request details
listDriverPayouts	GET /vendors/`{vendor_id}`/drivers/`{driver_id}`/payouts	List all payout requests for a driver
requestDriverPayout	POST /vendors/`{vendor_id}`/drivers/`{driver_id}`/payouts	Request a new driver payout

getDriverPayout

DriverPayoutDetails getDriverPayout(vendor_id, driver_id, payout_id)

Get driver payout request details

Retrieves detailed information about a specific payout request including status, amount, processing dates, and payment account information.

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver who owns the payout	[default to null]
payout_id	Long	The ID of the payout to retrieve	[default to null]

PaginatedResponse_DriverPayoutDetails listDriverPayouts(vendor_id, driver_id, page, per_page)

List all payout requests for a driver

Retrieves a complete history of all payout requests made by the driver including pending, approved, and completed payouts.

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver requesting payouts	[default to null]
page	Integer	Page number (default: 1)	[optional] [default to null]
per_page	Integer	Items per page (default: 20)	[optional] [default to null]

MessageResponse requestDriverPayout(vendor_id, driver_id, DriverPayoutRequestInput)

Request a new driver payout

Submits a new payout request for the specified amount. The payout will be processed according to the vendor’s payout schedule and policies.

Name	Type	Description	Notes
vendor_id	Long	The ID of the vendor organization	[default to null]
driver_id	Long	The ID of the driver requesting payout	[default to null]
DriverPayoutRequestInput	DriverPayoutRequestInput	Payout request details including amount and payment account