POST api/bookings/bookingpayment

Create a payment for a booking. Select one payment type only, if payment type is Bank Transfer, you may specify a reference. If payment type is a Card Payment, you may specify a Terminal Id.

Request Information

URI Parameters

None.

Body Parameters

BookingPayment

Name	Type	Additional information
BookingId	integer	Required
Amount	decimal number	Required
AmountOutstanding	decimal number	Required
PaymentDate	date	None.
IsCashPayment	boolean	None.
IsCardPayment	boolean	None.
IsBankTransfer	boolean	None.
IsRefund	boolean	None.
IsPending	boolean	None.
BankTransferReference	string	None.
CardPaymentTerminalId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "bookingId": 1,
  "amount": 1.0,
  "amountOutstanding": 1.0,
  "paymentDate": "2025-12-06T03:15:08.9961403+00:00",
  "isCashPayment": true,
  "isCardPayment": true,
  "isBankTransfer": true,
  "isRefund": true,
  "isPending": true,
  "bankTransferReference": "sample string 1",
  "cardPaymentTerminalId": "sample string 2"
}

application/xml, text/xml

Sample:

<BookingPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request">
  <Amount>1</Amount>
  <AmountOutstanding>1</AmountOutstanding>
  <BankTransferReference>sample string 1</BankTransferReference>
  <BookingId>1</BookingId>
  <CardPaymentTerminalId>sample string 2</CardPaymentTerminalId>
  <IsBankTransfer>true</IsBankTransfer>
  <IsCardPayment>true</IsCardPayment>
  <IsCashPayment>true</IsCashPayment>
  <IsPending>true</IsPending>
  <IsRefund>true</IsRefund>
  <PaymentDate>2025-12-06T03:15:08.9961403+00:00</PaymentDate>
</BookingPayment>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BookingPayment'.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BookingId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Amount"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AmountOutstanding"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentDate"

2025-12-06T03:15:08.9961403+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsCashPayment"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsCardPayment"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsBankTransfer"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsRefund"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsPending"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BankTransferReference"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CardPaymentTerminalId"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, multipart/form-data

Sample:

Sample not available.