GetCashCollectibleLineItems
POST/v1/payments/cash-collectible-line-items¶ Description
Returns cash collectible line items for the given order
¶ Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| user_id | string | Unique id of the User | Y |
| order_id | string | Unique id of the Order | Y |
| snapshot_fare | string | Point in time fare for the given Order. | Y |
| currency_code | string | ISO 4217 currency code | Y |
| total_uber_arrear_amount | string | Total arrear amount. In case there are no arrears, this value will be zero | Y |
| uber_arrears | array<Arrear> | Details of individual arrear accounts | Y |
| request_type | string | Type of Request Refer to this table for allowed values of RequestType. |
N |
| transport_provider_last_known_position | Position | Last known position of the transport provider either during the trip or at the time of trip completion. For example, this can be the position of the transport provider when the dropoff completed but the request came post job completion during order finalisation (even with some delay in case of a stuck order). This can also be the last known position of the transport provider on trip when async or sync cash snapshots are generated. | N |
| context | UberRequestContext | Context of the request | Y |
¶ RequestType
| Name | Number | Description |
|---|---|---|
| REQUEST_TYPE_INVALID | 0 | |
| REQUEST_TYPE_ESTIMATE | 1 | If the request is to generate a snapshot estimate |
| REQUEST_TYPE_POST_JOB_COMPLETION | 2 | If the request is to fetch line items for post job completion (finalization) |
¶ Response Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| cash_collectible_line_items | array<CashCollectibleLineItem> | List of cash collectible line items | Y |