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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type RefundBookingPayment() = 
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The booking id
        ///</summary>
        [<ApiMember(Description="The booking id", IsRequired=true, ParameterType="path")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The booking payment log id
        ///</summary>
        [<ApiMember(Description="The booking payment log id", IsRequired=true, ParameterType="path")>]
        member val PaymentLogId:Int32 = new Int32() with get,set

        ///<summary>
        ///The amount to refund on the checkout.
        ///</summary>
        [<ApiMember(Description="The amount to refund on the checkout.", IsRequired=true)>]
        member val Amount:Double = new Double() with get,set

        ///<summary>
        ///Any comments to be saved in log.
        ///</summary>
        [<ApiMember(Description="Any comments to be saved in log.")>]
        member val Comments:String = null with get,set

F# RefundBookingPayment DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Id: 0,
	PaymentLogId: 0,
	Amount: 0,
	Comments: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}