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.

// @ValidateRequest(Validator="IsAuthenticated")
export class RefundBookingPayment implements ICompany
{
    /** @description 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.")
    public CompanyId?: string;

    /** @description The booking id */
    // @ApiMember(Description="The booking id", IsRequired=true, ParameterType="path")
    public Id: number;

    /** @description The booking payment log id */
    // @ApiMember(Description="The booking payment log id", IsRequired=true, ParameterType="path")
    public PaymentLogId: number;

    /** @description The amount to refund on the checkout. */
    // @ApiMember(Description="The amount to refund on the checkout.", IsRequired=true)
    public Amount: number;

    /** @description Any comments to be saved in log. */
    // @ApiMember(Description="Any comments to be saved in log.")
    public Comments: string;

    public constructor(init?: Partial<RefundBookingPayment>) { (Object as any).assign(this, init); }
}

TypeScript 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: testapi.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

{}