CiirusXMLAdditionalFunctions15025


Click here for a complete list of operations.

AddGuestPayment

This can be used to add a record of payemnt to an existing BookingID.
Note: This is used when payment is taken external to any CiiRUS User.

This allows users to track the balance due for a booking. If not paid in full, the user will not release arrival detail to the guest.
Note: For each payment you may wish to only report the percentage of the booking the user is expecting to recieve; otherwise, you will be showing the user the price you sold the reservation once paid in full. Any number of payments can be added to any given reservation as long as it falls within the guidelines of your contract with the user.



Pass the following parameters:

  • APIUsername (String)
  • APIPassword (String)
  • BookingID (Integer)
  • PaymentDate (String, dd MMM yyyy)
  • PaymentAmount (decimal)
  • Description (String)



Error Responses:

  • AddGuestPayment: Validation Error 1
  • AddGuestPayment: Validation Error 2 - You do not have access to this booking
  • AddGuestPayment: Error - Could not get Property ID from Booking ID
  • AddGuestPayment: Error - Invalid payment date
  • AddGuestPayment: Error - Payment amount must be greater than 0
  • AddGuestPayment: Error adding guest payment

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
APIUsername:
APIPassword:
BookingID:
PaymentDate:
PaymentAmount:
Description:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /XMLAdditionalFunctions15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://xml.ciirus.com/AddGuestPayment"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddGuestPayment xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <BookingID>int</BookingID>
      <PaymentDate>string</PaymentDate>
      <PaymentAmount>decimal</PaymentAmount>
      <Description>string</Description>
    </AddGuestPayment>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddGuestPaymentResponse xmlns="http://xml.ciirus.com/">
      <AddGuestPaymentResult>string</AddGuestPaymentResult>
    </AddGuestPaymentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /XMLAdditionalFunctions15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AddGuestPayment xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <BookingID>int</BookingID>
      <PaymentDate>string</PaymentDate>
      <PaymentAmount>decimal</PaymentAmount>
      <Description>string</Description>
    </AddGuestPayment>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AddGuestPaymentResponse xmlns="http://xml.ciirus.com/">
      <AddGuestPaymentResult>string</AddGuestPaymentResult>
    </AddGuestPaymentResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /XMLAdditionalFunctions15.025.asmx/AddGuestPayment?APIUsername=string&APIPassword=string&BookingID=string&PaymentDate=string&PaymentAmount=string&Description=string HTTP/1.1
Host: api.ciirus.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://xml.ciirus.com/">string</string>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /XMLAdditionalFunctions15.025.asmx/AddGuestPayment HTTP/1.1
Host: api.ciirus.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

APIUsername=string&APIPassword=string&BookingID=string&PaymentDate=string&PaymentAmount=string&Description=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://xml.ciirus.com/">string</string>