Get Health Trip Receipt
GEThttps://api.uber.com/v1/health/trips/{request_id}/receipt
¶ Use Case
Get the receipt of a completed trip
¶ Authorization
OAuth 2.0 Bearer token with the health
scope. For more information, see Authentication.
¶ Request parameters
Name | Type | Description |
---|---|---|
request_id | string | The unique ID of the ride request. |
¶ Response parameters
Name | Type | Description |
---|---|---|
request_id | string | The unique ID of the ride request |
guest | object | Object containing all the information about the rider. |
guest.first_name | string | The first name of the rider. |
guest.last_name | string | The last name of the rider. |
guest.phone_number | string | Phone number of rider in E.164 (international) format. |
guest.email | string | Email address of the rider. |
charges | array | Enumerated charges |
charges.name | string | The name of the charge |
charges.amount | float | The amount of the charge |
charge_adjustments | array | Adjustments made to the charges |
charge_adjustments[].name | string | The name of the charge adjustment. |
charge_adjustments[].amount | float | The amount of the charge adjustment. |
charge_adjustments[].type | string | The type of charge adjustment. |
surge_charge | object | Object containing information about increased fares. |
surge_charge.name | string | The name of the surge charge (includes multiplier) |
surge_charge.amount | float | The amount of the surge charge |
normal_fare | string | The summation of the charges |
subtotal | string | The summation of the normal_fare and surge_charge[amount] |
total_fare | string | The fare after credits and refunds have been applied |
total_owed | float | The total amount still owed after attempting to charge the user. May be null if amount was paid in full. |
currency_code | string | The currency of the amounts in the response, in ISO 4217 format |
duration | string | Time duration of the trip in ISO 8601 HH:MM:SS format |
distance | string | Distance of the trip |
distance_label | string | The localized unit of distance |
¶ Example Request
Try It Replace the token and trip id from a past trip in the below request to use it a terminal to get receipt of a trip.
curl -X GET -H "authorization: Bearer $UBER_TOKEN" \
'https://sandbox-api.uber.com/v1/health/trips/REPLACETRIPID/receipt'
¶ Example Response
{
"guest": {
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+14155550000",
"email": "jane@example.com"
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"charges": [
{
"name": "Base Fare",
"amount": 2.2
},
{
"name": "Distance",
"amount": 2.75
},
{
"name": "Time",
"amount": 3.57
}
],
"surge_charge": {
"name": "Surge x1.5",
"amount": 4.26
},
"normal_fare": "$8.52",
"subtotal": "$12.78",
"total_fare": "$5.92",
"total_owed": null,
"currency_code": "USD",
"duration": "00:11:35",
"distance": "1.49",
"distance_label": "miles"
}