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.
"use strict";
export class RefundBookingPayment {
    /** @param {{CompanyId?:string,Id?:number,PaymentLogId?:number,Amount?:number,Comments?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {number}
     * @description The booking id */
    Id;
    /**
     * @type {number}
     * @description The booking payment log id */
    PaymentLogId;
    /**
     * @type {number}
     * @description The amount to refund on the checkout. */
    Amount;
    /**
     * @type {string}
     * @description Any comments to be saved in log. */
    Comments;
}

JavaScript RefundBookingPayment DTOs

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

HTTP + OTHER

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

{}