/v1/appointment/book/payment/paymentPost

Overview

Retrieves the payment summary for an appointment booking in the UAT environment for BID 49197. Use this endpoint to calculate the amounts due for a configured booking, including totals, discounts, taxes, surcharges, and promotions, before finalizing the booking.

Request

Method: GET

Path: /v1/appointment/book/payment/paymentPost

Environment: UAT (BID 49197)

This endpoint is typically called after the booking flow has been configured (service/asset, staff, schedule) and before the /v1/appointment/book/finish step.

Query Parameters

id_region – Region identifier for the booking context.

k_business – Business identifier, set to 49197 for this BID.

k_location – Location key for the booking.

id_mode – Booking/payment mode identifier.

Response

Returns a payment summary object including:

a_promotion_data – Applied promotion details (if any).

a_purchase – Purchase line items.

m_coupon – Coupon amount.

m_discount – Discount amount.

m_surcharge / m_surcharge_ach – Surcharge amounts.

m_tax – Tax amount.

m_total – Total amount due.

k_location – Location key echoed back.

status – Request status (e.g., "ok").

Currently, when there is nothing to pay for the configured booking, the endpoint returns a zeroed-out total (all monetary fields set to "0.00") with status: "ok".

Usage Notes

Call this endpoint once the booking configuration (service/asset selection, staff selection, schedule/calendar selection) is complete.

Use the returned m_total and related monetary fields to drive payment UI and decisioning before calling /v1/appointment/book/finish.

A zeroed-out response indicates that no payment is required for the current booking configuration.

curl --location -g --request GET '/v1/appointment/book/payment/paymentPost?id_region={{id_region}}&k_business={{k_business}}&k_location={{k_location}}&id_mode=1' \ --header 'Content-Type: text/plain' \ --data-raw ''

Overview#

Request#

Query Parameters#

Response#

Usage Notes#

Request

Responses

Overview

Request

Query Parameters

Response

Usage Notes