Preview payment

1 import { ChrtClient } from "@chrt-inc/typescript-sdk"; 2 3 const client = new ChrtClient({ token: "YOUR_TOKEN" }); 4 await client.shipperPayCourierPayments.previewV1({ 5 order_id_or_short_id: "order_id_or_short_id" 6 });

1 { 2 "task_groups": [ 3 { 4 "schema_version": 1, 5 "_id": "string", 6 "order_id": "string", 7 "order_short_id": "string", 8 "task_ids": [ 9 "string" 10 ], 11 "courier_org_id": "string", 12 "order_cancelled": false, 13 "status": "not_started", 14 "driver_id": "string", 15 "started_at": "2024-01-15T09:30:00Z", 16 "completed_at": "2024-01-15T09:30:00Z", 17 "completed": false, 18 "paused": false 19 } 20 ], 21 "line_item_groups": [ 22 { 23 "schema_version": 1, 24 "task_group_id": "string", 25 "courier_org_id": "string", 26 "rate_sheet_id": "string", 27 "line_items": [ 28 { 29 "schema_version": 1, 30 "item": "base_rate", 31 "quantity": 1.1, 32 "rate": 1.1, 33 "comment": "string", 34 "created_at": "2024-01-15T09:30:00Z", 35 "uuid_str": "string" 36 } 37 ], 38 "_id": "string", 39 "shipper_org_id": "string", 40 "off_chrt_shipper_org_info_id": "string", 41 "order_cancelled": false 42 } 43 ], 44 "total_amount": 1.1, 45 "payment_ready": true 46 }

Previews a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

order_id_or_short_idstringRequired

Response

Successful Response

task_groupslist of objects

line_item_groupslist of objects

total_amountdouble

payment_readyboolean

Authentication

Request

Response

Errors