Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /bookings/{Id}/refund/{PaymentLogId} | Refund a payment on a booking. |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class RefundBookingPayment
Implements 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 Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''The booking id
'''</Summary>
<ApiMember(Description:="The booking id", IsRequired:=true, ParameterType:="path")>
Public Overridable Property Id As Integer
'''<Summary>
'''The booking payment log id
'''</Summary>
<ApiMember(Description:="The booking payment log id", IsRequired:=true, ParameterType:="path")>
Public Overridable Property PaymentLogId As Integer
'''<Summary>
'''The amount to refund on the checkout.
'''</Summary>
<ApiMember(Description:="The amount to refund on the checkout.", IsRequired:=true)>
Public Overridable Property Amount As Double
'''<Summary>
'''Any comments to be saved in log.
'''</Summary>
<ApiMember(Description:="Any comments to be saved in log.")>
Public Overridable Property Comments As String
End Class
End Namespace
End Namespace
VB.NET RefundBookingPayment DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 { }