Checkout Basket

post https://{api_url}/api/v5/{company_id}/basket/checkout

Confirm and Pay for the Items in the Shopping Basket

time	status	user agent
Retrieving recent requests…

Loading…

Responses

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

last_payment_log

object

payment_reference

string

external_ref

string

_embedded

object

external_purchases

array of objects

external_purchases

object

integer

name

string

description

string

settings

object

reference

string

purchase_item_id

integer

is_cancelled

boolean

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

member

object

client

object

Creates a new client.

confirm_messages

array of objects

confirm_messages

object

integer

message

string

message_type

string

item_type

string

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

due_now

string

paid

string

quantity

string

event_id

string

session_id

string

service_id

string

purchase_id

string

purchase_ref

string

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

last_name

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

_embedded

object

person_ids

string

packages

array of objects

packages

object

integer

name

string

description

string

price

integer

paid

integer

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

due_now

string

paid

string

quantity

string

event_id

string

session_id

string

service_id

string

purchase_id

string

purchase_ref

string

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

last_name

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

_embedded

object

person_ids

string

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

products

array of objects

products

object

integer

name

string

description

string

group

string

make

string

sku

string

qty

integer

price

integer

paid

integer

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

400

When e-mail contains html

403

When the customer/member does not exist

404

When the member is from a different company

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.jrni.com/api/v5/company_id/basket/checkout \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

201Purchase