Get bookingorder paydetails (optional query target_currency for converted totals)

GET

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

Pay details of the bookingorder. Pass target_currency (and optional fxratemoment_id) for converted target_payment_details.

Authorizations

api_key

Type

API Key (header: X-Api-Key)

Parameters

Path Parameters

bookingorder_id*

XS2event ID of the Bookingorder

Type

string

Required

Query Parameters

target_currency

If set, response includes base_currency and (when not EUR) converted target_payment_details in this ISO code

Example"GBP"

Default

null

fxratemoment_id

Optional FX rate moment override

Examplenull

Default

null

Responses

OK

Content-Type

application/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"

  

]

}

GET

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

Playground

Server

Authorization

api_key

Variables

Key

Value

bookingorder_id*

target_currency

fxratemoment_id

Samples