SubmitTip
POST/v1/rides/submit-tip¶ Description
Submits a tip for the given job id in the request. Only post-trip tipping is currently supported for finalized orders; on-trip tipping is not yet available.
¶ Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| context | ThirdPartyRequestContext | Context of this request | Y |
| order_id | string | The id of the Order | Y |
| job_id | string | The id of the Job | Y |
| requested_by | ParticipantEntity | The participant who is requesting to submit the tip | Y |
| version | int | Fare version as returned in Finalised Fare as part of GetOrder response | Y |
| tip_amount | CurrencyAmount | Tip amount to be submitted | Y |
¶ Response Parameters
(No parameters / Empty response)
¶ Errors
| HTTP status | Code | Message |
|---|---|---|
| 412 | ERROR_CODE_INVALID_ORDER_ACCESS | Participant is not authorized for read/write access on this order |
| 412 | ERROR_CODE_INVALID_ORDER_STATE | Order must be in a finalized state to submit a tip |
| 412 | ERROR_CODE_INVALID_JOB_STATE | Job must be completed before a tip can be submitted |
| 422 | ERROR_CODE_TIPPING_NOT_AVAILABLE | Tipping isn’t available for this payment method, or the driver is not accepting tips, or tipping more than once is not supported |
| 412 | ERROR_CODE_FARE_VERSION_INCORRECT | The fare version provided does not match the current fare version |
| 412 | ERROR_CODE_TIP_SUBMITTED_TOO_LATE | The tip was submitted after the allowed tipping window |
| 400 | ERROR_CODE_INVALID_TIP_AMOUNT | Tip amount exceeds the maximum allowed, or is otherwise invalid |
| 409 | ERROR_CODE_TIP_ALREADY_IN_PROGRESS | A tip submission is already in progress for this job |