Update status

Updates the status of a courier driver payout with validation of allowed state transitions.

AuthorizationBearer

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

idstringRequired

This endpoint expects an object.

payout_statusenum or nullOptional

Allowed values:

payout_completed_atstring or nullOptionalformat: "date-time"

payout_completed_by_user_idstring or nullOptional

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

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