Stay organized with collections
Save and categorize content based on your preferences.
This method returns a booking status for a user based on provided booking
ID.
Request
GetBookingStatusRequest
Return value
GetBookingStatusResponse
// Request to get booking status and prepayment status for a Booking.messageGetBookingStatusRequest{// ID of the existing booking (required)stringbooking_id=1;}// Response for the GetBookingStatus RPC with booking status and prepayment// status.messageGetBookingStatusResponse{// ID of the booking (required)stringbooking_id=1;// Status of the booking (required)BookingStatusbooking_status=2;// Prepayment status of the booking (required)PrepaymentStatusprepayment_status=3;}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-20 UTC."],[[["\u003cp\u003eThis method retrieves the status of a booking using a provided booking ID.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003ebooking_id\u003c/code\u003e and returns a \u003ccode\u003eGetBookingStatusResponse\u003c/code\u003e containing the \u003ccode\u003ebooking_id\u003c/code\u003e, \u003ccode\u003ebooking_status\u003c/code\u003e, and \u003ccode\u003eprepayment_status\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eBookingStatus\u003c/code\u003e provides details on the overall state of the booking and is further defined in external documentation.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePrepaymentStatus\u003c/code\u003e indicates the status of any advance payment associated with the booking, including whether it was provided, refunded, or credited.\u003c/p\u003e\n"]]],["The method uses a `GetBookingStatusRequest` containing a booking ID to retrieve a `GetBookingStatusResponse`. The response includes the booking ID, `BookingStatus`, and `PrepaymentStatus`. `PrepaymentStatus` can be `PREPAYMENT_NOT_PROVIDED`, `PREPAYMENT_PROVIDED`, `PREPAYMENT_REFUNDED`, or `PREPAYMENT_CREDITED`. Updating prepayment status from `PREPAYMENT_PROVIDED` to `PREPAYMENT_REFUNDED` initiates a refund. `PREPAYMENT_CREDITED` means the user received a voucher for the booking.\n"],null,["# GetBookingStatus method\n\nThis method returns a booking status for a user based on provided booking\nID.\n\n**Request**\n\nGetBookingStatusRequest\n\n**Return value**\n\nGetBookingStatusResponse \n\n```scilab\n// Request to get booking status and prepayment status for a Booking.\nmessage GetBookingStatusRequest {\n // ID of the existing booking (required)\n string booking_id = 1;\n}\n\n// Response for the GetBookingStatus RPC with booking status and prepayment\n// status.\nmessage GetBookingStatusResponse {\n // ID of the booking (required)\n string booking_id = 1;\n\n // Status of the booking (required)\n BookingStatus booking_status = 2;\n\n // Prepayment status of the booking (required)\n PrepaymentStatus prepayment_status = 3;\n}\n```\n\nBookingStatus specification can be found\n[here](/actions-center/verticals/local-services/e2e/reference/booking-server-api-rest/e2e-definitions/bookingstatus-definition) \n\n```gdscript\n// Prepayment status of a booking.\n// Updating payment status will trigger an update on the payment status of the\n// associated booking (if applicable).\n// Currently, the only supported transition is from PREPAYMENT_PROVIDED to\n// PREPAYMENT_REFUNDED, which will initiate a non-reversible refund on the\n// associated payment transaction.\nenum PrepaymentStatus {\n // Not specified, defaults to PREPAYMENT_NOT_PROVIDED.\n PREPAYMENT_STATUS_UNSPECIFIED = 0;\n\n // The fee for the booking has been paid in advance.\n PREPAYMENT_PROVIDED = 1;\n\n // The fee for the booking has not been paid in advance.\n PREPAYMENT_NOT_PROVIDED = 2;\n\n // The fee was previously PREPAYMENT_PROVIDED but has now been refunded.\n PREPAYMENT_REFUNDED = 3;\n\n // The fee was previously PREPAYMENT_PROVIDED but now has been credited\n // (user given a UserPaymentOption as a voucher for the booking).\n // If this is set, the response should also include the updated\n // UserPaymentOption.\n PREPAYMENT_CREDITED = 4;\n}\n```"]]