Basket Checkout

post https://{api_url}/api/v5/baskets/{basket_id}/checkout

Confirms the transaction and generates a Purchase.

Will generate all the necessary bookings, will generate tickets
Will generate the slots on the relevant people / resources / services / companies
Will alert both the associated client and all the relevant stakeholders through various channels.
Will delete the current basket.

Recipes

📆

Service first customer appointment booking journey

Open Recipe

Response

Response body

object

total_price

number

price

integer

paid

integer

deposit

integer

tax_payable_on_price

integer

tax_payable_on_deposit

integer

tax_payable_on_due_now

integer

due_now

integer

long_id

string

integer

affiliate_ref

string

client_name

string

created_at

string

certificate_paid

integer

payment_type

string

original_price

integer

last_payment_log

object

payment_reference

string

external_ref

string

_embedded

object

client

object

member

object

bookings

array of objects

bookings

object

string

full_describe

string

describe

string

resource_name

string

person_name

string

datetime

string

end_datetime

string

duration

string

duration_span

string

listed_duration

string

on_waitlist

string

company_id

string

attended

string

price

string

original_price

string

due_now

string

paid

string

quantity

string

event_id

string

session_id

string

service_id

string

purchase_id

string

purchase_ref

string

settings

string

slot_settings

string

min_cancellation_time

string

service_name

string

category_name

string

time_zone

string

ticket_name

string

address

string

booking_type

string

slot_id

string

first_name

string

first_name_extra

string

last_name

string

last_name_extra

string

coupon_paid

string

coupon_title

string

coupon_code

string

tickets

string

recurrence_type

string

num_bookings

string

remaining

string

is_cancelled

string

private_note

string

channel

string

user_id

string

unpaid_cancel_time

string

_embedded

object

person_id

string

person_ids

string

checked_in

string

check_in_code

string

price_in_major_units

string

original_price_in_major_units

string

paid_in_major_units

string

due_now_in_major_units

string

packages

array of objects

packages

object

integer

name

string

description

string

price

integer

paid

integer

products

array of objects

products

object

integer

name

string

description

string

group

string

make

string

sku

string

qty

integer

price

integer

paid

integer

pre_paid_bookings

array of objects

pre_paid_bookings

object

integer

price

integer

number_of_bookings

integer

number_of_bookings_remaining

integer

use_from

string

use_by

string

book_by

string

paid

integer

service_name

string

linked_package_id

integer

deals

array of objects

deals

object

integer

name

integer

ref

string

num

integer

description

integer

category_id

integer

service_id

integer

affiliate_id

integer

price

integer

link

string

tandc

string

vendor

string

allow_mixed_bookings

boolean

widget_show

boolean

detail_group_id

integer

recipient

object

deal_code

string

course_bookings

array of objects

course_bookings

object

string

full_describe

string

describe

string

resource_name

string

person_name

string

datetime

string

end_datetime

string

duration

string

duration_span

string

listed_duration

string

on_waitlist

string

company_id

string

attended

string

price

string

original_price

string

due_now

string

paid

string

quantity

string

event_id

string

session_id

string

service_id

string

purchase_id

string

purchase_ref

string

settings

string

slot_settings

string

min_cancellation_time

string

service_name

string

category_name

string

time_zone

string

ticket_name

string

address

string

booking_type

string

slot_id

string

first_name

string

first_name_extra

string

last_name

string

last_name_extra

string

coupon_paid

string

coupon_title

string

coupon_code

string

tickets

string

recurrence_type

string

num_bookings

string

remaining

string

is_cancelled

string

private_note

string

channel

string

user_id

string

unpaid_cancel_time

string

_embedded

object

person_id

string

person_ids

string

checked_in

string

check_in_code

string

price_in_major_units

string

original_price_in_major_units

string

paid_in_major_units

string

due_now_in_major_units

string

external_purchases

array of objects

external_purchases

object

integer

name

string

description

string

settings

object

reference

string

purchase_item_id

integer

is_cancelled

boolean

payment_callbacks

array of objects

payment_callbacks

object

verification_key

string

payer_name

string

payer_email

string

payer_id

integer

receiver_email

integer

payment_date

string

amount

integer

confirm_messages

array of objects

confirm_messages

object

integer

message

string

message_type

string

item_type

string

refund

object

amount_refunded

integer

amount_remaining

integer

price_in_major_units

number

total_price_in_major_units

number

paid_in_major_units

number

deposit_in_major_units

number

tax_payable_on_price_in_major_units

number

tax_payable_on_deposit_in_major_units

number

tax_payable_on_due_now_in_major_units

number

due_now_in_major_units

number

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.jrni.com/api/v5/baskets/basket_id/checkout \
3
     --header 'accept: application/vnd.bookingbug-hal-v2+json; charset=utf-8' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.bookingbug-hal-v2+json; charset=utf-8

application/vnd.bookingbug-nolinks-v2+json; charset=utf-8

201Basket