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.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ValidateRequest("IsAuthenticated")]
    public partial class RefundBookingPayment
        : ICompany
    {
        ///<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.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The booking id
        ///</summary>
        [ApiMember(Description="The booking id", IsRequired=true, ParameterType="path")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The booking payment log id
        ///</summary>
        [ApiMember(Description="The booking payment log id", IsRequired=true, ParameterType="path")]
        public virtual int PaymentLogId { get; set; }

        ///<summary>
        ///The amount to refund on the checkout.
        ///</summary>
        [ApiMember(Description="The amount to refund on the checkout.", IsRequired=true)]
        public virtual double Amount { get; set; }

        ///<summary>
        ///Any comments to be saved in log.
        ///</summary>
        [ApiMember(Description="Any comments to be saved in log.")]
        public virtual string Comments { get; set; }
    }

}

C# RefundBookingPayment DTOs

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

HTTP + CSV

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: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
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/csv
Content-Length: length

{}