Get Payments

Request Url: /apis/payments?BookingID=602&DateFrom=2021-01-01&DateTo=2021-03-31

• BookingId booking filter, return only payments for this booking
• DateFrom date filter, only show payments after this date.
• DateTo date filter, show only payments before this date.

Response:

{
    "Payments": [
        {
            "PaymentID": 823,
            "BookingID": 602,
            "Amount": 1015.0000,
            "PaymentMethod": "BankTransfer",
            "PaymentDate": "26/03/2021",
            "PaymentCategory": 2,
            "PaymentType": 2,
            "Comments": "",
            "PaymentToken": "",
            "CardPartialNumbers": "",
            "SagepaySecurityKey": null,
            "SagepayVendorTxCode": null,
            "SagepayVPSTxId": null,
            "SagepayTxAuthNo": "",
            "PaymentSchedules": [
                {
                    "PaymentScheduleID": 3074,
                    "PaymentScheduleName": "10% tax",
                    "Amount": 90.00
                },
                {
                    "PaymentScheduleID": 3075,
                    "PaymentScheduleName": "Booking Fee",
                    "Amount": 25.00
                },
                {
                    "PaymentScheduleID": 3076,
                    "PaymentScheduleName": "Rental Deposit",
                    "Amount": 248.00
                },
                {
                    "PaymentScheduleID": 3078,
                    "PaymentScheduleName": "Rental Balance",
                    "Amount": 652.00
                }
            ]
        }
    ]
}

• "PaymentCategory" 0 - None
  1 - Deposit
  2 - BalancePaid
  3 - Refunded
  4 - PartPayment
  5 - DamagesPayment
  6 - DeferredPayment
  7 - CashOnArrival
  8 - CompensationAwarded
  9 - CancellationFee
  10 - TransferSecurityDeposit
  11 - BookingFee
  12 - HolidayExtra
  13 - Initial Deposit

• "PaymentType" 0 - None
  1 - PaymentToOwner
  2 - ReceiptFromRenter
  3 - BreakagesDeposit
  4 - PaymentToSupplier
  5 - PaymentToGuest
  6 - TransferSecurityDeposit
  7 - BreakagesInsurance