BokaMera.API.Host

<back to all web services

RefundBookingPayment

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/bookings/{Id}/refund/{PaymentLogId}Refund a payment on a booking.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class RefundBookingPayment : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    var CompanyId:UUID? = null

    /**
    * The booking id
    */
    @ApiMember(Description="The booking id", IsRequired=true, ParameterType="path")
    var Id:Int? = null

    /**
    * The booking payment log id
    */
    @ApiMember(Description="The booking payment log id", IsRequired=true, ParameterType="path")
    var PaymentLogId:Int? = null

    /**
    * The amount to refund on the checkout.
    */
    @ApiMember(Description="The amount to refund on the checkout.", IsRequired=true)
    var Amount:Double? = null

    /**
    * Any comments to be saved in log.
    */
    @ApiMember(Description="Any comments to be saved in log.")
    var Comments:String? = null
}

Kotlin RefundBookingPayment DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /bookings/{Id}/refund/{PaymentLogId} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RefundBookingPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Amount>0</Amount>
  <Comments>String</Comments>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Id>0</Id>
  <PaymentLogId>0</PaymentLogId>
</RefundBookingPayment>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />