Appearance

Calculate bookingorder proposed paydetails for a given payment method ​

PUT
/v1/bookingorders/{bookingorder_id}/proposed-pay-details

Calculate proposed pay details of the bookingorder for a given payment method.

When a distributor selects a payment method in the portal, a new payment request is created with status PROPOSED.
Then the pay details are calculated based on the proposed method and returned.
This new payment request has the status PROPOSED and is not yet confirmed.
It becomes confirmed when the ditributor updates payment method via patch /string:bookingorder_id/payment-method-distributor

Authorizations​

api_key
Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

bookingorder_id*

XS2event ID of the Bookingorder

Type
string
Required

Request Body​

application/json
JSON
{
  
"payment_method": null,
  
"payment_reference": null
}

Responses​

OK

application/json
JSON
{
  
"tickets": [
  
  
{
  
  
  
"name": null,
  
  
  
"sub_title": null,
  
  
  
"quantity": null,
  
  
  
"percentage": null,
  
  
  
"net_rate": null,
  
  
  
"currency": null,
  
  
  
"vat": null,
  
  
  
"sub_total": null,
  
  
  
"sub_total_inc_vat": null,
  
  
  
"sub_total_exc_vat": null,
  
  
  
"vat_category": null,
  
  
  
"vat_rate": null,
  
  
  
"vat_amount": null,
  
  
  
"local_vat_number": null,
  
  
  
"ticket_id": null,
  
  
  
"reverse_charge_applied": false
  
  
}
  
],
  
"ticket_fee": {
  
  
"name": null,
  
  
"sub_title": null,
  
  
"quantity": null,
  
  
"percentage": null,
  
  
"net_rate": null,
  
  
"currency": null,
  
  
"vat": null,
  
  
"sub_total": null,
  
  
"sub_total_inc_vat": null,
  
  
"sub_total_exc_vat": null,
  
  
"vat_category": null,
  
  
"vat_rate": null,
  
  
"vat_amount": null,
  
  
"local_vat_number": null,
  
  
"ticket_id": null
  
},
  
"payment_fee": {
  
  
"name": null,
  
  
"sub_title": null,
  
  
"quantity": null,
  
  
"percentage": null,
  
  
"net_rate": null,
  
  
"currency": null,
  
  
"vat": null,
  
  
"sub_total": null,
  
  
"sub_total_inc_vat": null,
  
  
"sub_total_exc_vat": null,
  
  
"vat_category": null,
  
  
"vat_rate": null,
  
  
"vat_amount": null,
  
  
"local_vat_number": null,
  
  
"ticket_id": null
  
},
  
"vat": {
  
  
"name": null,
  
  
"sub_title": null,
  
  
"quantity": null,
  
  
"percentage": null,
  
  
"net_rate": null,
  
  
"currency": null,
  
  
"vat": null,
  
  
"sub_total": null,
  
  
"sub_total_inc_vat": null,
  
  
"sub_total_exc_vat": null,
  
  
"vat_category": null,
  
  
"vat_rate": null,
  
  
"vat_amount": null,
  
  
"local_vat_number": null,
  
  
"ticket_id": null
  
},
  
"total": {
  
  
"name": null,
  
  
"sub_title": null,
  
  
"quantity": null,
  
  
"percentage": null,
  
  
"net_rate": null,
  
  
"currency": null,
  
  
"vat": null,
  
  
"sub_total": null,
  
  
"sub_total_inc_vat": null,
  
  
"sub_total_exc_vat": null,
  
  
"vat_category": null,
  
  
"vat_rate": null,
  
  
"vat_amount": null,
  
  
"local_vat_number": null,
  
  
"ticket_id": null
  
},
  
"bookingcosts": {
  
  
"name": null,
  
  
"sub_title": null,
  
  
"quantity": null,
  
  
"percentage": null,
  
  
"net_rate": null,
  
  
"currency": null,
  
  
"vat": null,
  
  
"sub_total": null,
  
  
"sub_total_inc_vat": null,
  
  
"sub_total_exc_vat": null,
  
  
"vat_category": null,
  
  
"vat_rate": null,
  
  
"vat_amount": null,
  
  
"local_vat_number": null,
  
  
"ticket_id": null
  
},
  
"platform_service_fee": {
  
  
"name": null,
  
  
"sub_title": null,
  
  
"quantity": null,
  
  
"percentage": null,
  
  
"net_rate": null,
  
  
"currency": null,
  
  
"vat": null,
  
  
"sub_total": null,
  
  
"sub_total_inc_vat": null,
  
  
"sub_total_exc_vat": null,
  
  
"vat_category": null,
  
  
"vat_rate": null,
  
  
"vat_amount": null,
  
  
"local_vat_number": null,
  
  
"ticket_id": null
  
},
  
"base_currency": null,
  
"target_currency": null,
  
"target_payment_details": {
  
  
"tickets": [
  
  
  
{
  
  
  
  
"name": null,
  
  
  
  
"sub_title": null,
  
  
  
  
"quantity": null,
  
  
  
  
"percentage": null,
  
  
  
  
"net_rate": null,
  
  
  
  
"currency": null,
  
  
  
  
"vat": null,
  
  
  
  
"sub_total": null,
  
  
  
  
"sub_total_inc_vat": null,
  
  
  
  
"sub_total_exc_vat": null,
  
  
  
  
"vat_category": null,
  
  
  
  
"vat_rate": null,
  
  
  
  
"vat_amount": null,
  
  
  
  
"local_vat_number": null,
  
  
  
  
"ticket_id": null,
  
  
  
  
"reverse_charge_applied": false
  
  
  
}
  
  
],
  
  
"ticket_fee": {
  
  
  
"name": null,
  
  
  
"sub_title": null,
  
  
  
"quantity": null,
  
  
  
"percentage": null,
  
  
  
"net_rate": null,
  
  
  
"currency": null,
  
  
  
"vat": null,
  
  
  
"sub_total": null,
  
  
  
"sub_total_inc_vat": null,
  
  
  
"sub_total_exc_vat": null,
  
  
  
"vat_category": null,
  
  
  
"vat_rate": null,
  
  
  
"vat_amount": null,
  
  
  
"local_vat_number": null,
  
  
  
"ticket_id": null
  
  
},
  
  
"payment_fee": {
  
  
  
"name": null,
  
  
  
"sub_title": null,
  
  
  
"quantity": null,
  
  
  
"percentage": null,
  
  
  
"net_rate": null,
  
  
  
"currency": null,
  
  
  
"vat": null,
  
  
  
"sub_total": null,
  
  
  
"sub_total_inc_vat": null,
  
  
  
"sub_total_exc_vat": null,
  
  
  
"vat_category": null,
  
  
  
"vat_rate": null,
  
  
  
"vat_amount": null,
  
  
  
"local_vat_number": null,
  
  
  
"ticket_id": null
  
  
},
  
  
"vat": {
  
  
  
"name": null,
  
  
  
"sub_title": null,
  
  
  
"quantity": null,
  
  
  
"percentage": null,
  
  
  
"net_rate": null,
  
  
  
"currency": null,
  
  
  
"vat": null,
  
  
  
"sub_total": null,
  
  
  
"sub_total_inc_vat": null,
  
  
  
"sub_total_exc_vat": null,
  
  
  
"vat_category": null,
  
  
  
"vat_rate": null,
  
  
  
"vat_amount": null,
  
  
  
"local_vat_number": null,
  
  
  
"ticket_id": null
  
  
},
  
  
"total": {
  
  
  
"name": null,
  
  
  
"sub_title": null,
  
  
  
"quantity": null,
  
  
  
"percentage": null,
  
  
  
"net_rate": null,
  
  
  
"currency": null,
  
  
  
"vat": null,
  
  
  
"sub_total": null,
  
  
  
"sub_total_inc_vat": null,
  
  
  
"sub_total_exc_vat": null,
  
  
  
"vat_category": null,
  
  
  
"vat_rate": null,
  
  
  
"vat_amount": null,
  
  
  
"local_vat_number": null,
  
  
  
"ticket_id": null
  
  
},
  
  
"bookingcosts": {
  
  
  
"name": null,
  
  
  
"sub_title": null,
  
  
  
"quantity": null,
  
  
  
"percentage": null,
  
  
  
"net_rate": null,
  
  
  
"currency": null,
  
  
  
"vat": null,
  
  
  
"sub_total": null,
  
  
  
"sub_total_inc_vat": null,
  
  
  
"sub_total_exc_vat": null,
  
  
  
"vat_category": null,
  
  
  
"vat_rate": null,
  
  
  
"vat_amount": null,
  
  
  
"local_vat_number": null,
  
  
  
"ticket_id": null
  
  
},
  
  
"platform_service_fee": {
  
  
  
"name": null,
  
  
  
"sub_title": null,
  
  
  
"quantity": null,
  
  
  
"percentage": null,
  
  
  
"net_rate": null,
  
  
  
"currency": null,
  
  
  
"vat": null,
  
  
  
"sub_total": null,
  
  
  
"sub_total_inc_vat": null,
  
  
  
"sub_total_exc_vat": null,
  
  
  
"vat_category": null,
  
  
  
"vat_rate": null,
  
  
  
"vat_amount": null,
  
  
  
"local_vat_number": null,
  
  
  
"ticket_id": null
  
  
}
  
},
  
"payment_supplier": null,
  
"available_payment_methods": [
  
  
"string"
  
]
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​