List by driver

Lists all payouts for a specific driver within the authenticated organization.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

driver_idstringRequired

Successful Response

schema_versioninteger

courier_pay_driver_line_item_group_idslist of strings

_idstring

driver_idstring

courier_org_idstring

Must be a string starting with org_

task_group_idslist of strings

payout_amountdouble

payout_created_atstringformat: "date-time"

payout_created_by_user_idstring

Must be a string starting with user_

payout_statusenum or null

Allowed values:

payout_completed_atstring or nullformat: "date-time"

payout_completed_by_user_idstring or null

1	[
2	{
3	"schema_version": 1,
4	"courier_pay_driver_line_item_group_ids": [
5	"string"
6	],
7	"_id": "string",
8	"driver_id": "string",
9	"courier_org_id": "string",
10	"task_group_ids": [
11	"string"
12	],
13	"payout_amount": 1.1,
14	"payout_created_at": "2024-01-15T09:30:00Z",
15	"payout_created_by_user_id": "string",
16	"payout_status": "created",
17	"payout_completed_at": "2024-01-15T09:30:00Z",
18	"payout_completed_by_user_id": "string"
19	}
20	]

1	import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3	const client = new ChrtClient({ token: "YOUR_TOKEN" });
4	await client.courierPayDriverPayouts.listByDriverIdV1("driver_id");