BokaMera.API.Host

UpdatePaymentSettings

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
PUT	/payment/settings/	Update payment settings	Update payment settings for the logged in company

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class UpdatePaymentSettings : ICompany
{
    /**
    * 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.")
    override var CompanyId:UUID? = null

    /**
    * The payment is enabled
    */
    @ApiMember(Description="The payment is enabled")
    open var Enabled:Boolean? = null

    /**
    * Automatically refund customer on canceled booking
    */
    @ApiMember(Description="Automatically refund customer on canceled booking")
    open var RefundOnCancelBooking:Boolean? = null

    /**
    * The default option when admin creates a new booking
    */
    @ApiMember(Description="The default option when admin creates a new booking")
    open var DefaultPaymentOptionId:Int? = null

    /**
    * What payment provider to use
    */
    @ApiMember(Description="What payment provider to use")
    open var PaymentProviderId:Int? = null
}

open class PaymentSettingsQueryResponse
{
    /**
    * The company id
    */
    @ApiMember(Description="The company id")
    open var CompanyId:UUID? = null

    /**
    * The payment is enabled
    */
    @ApiMember(Description="The payment is enabled")
    open var Enabled:Boolean? = null

    /**
    * Automatically refund customer on canceled booking
    */
    @ApiMember(Description="Automatically refund customer on canceled booking")
    open var RefundOnCancelBooking:Boolean? = null

    /**
    * The default option when admin creates a new booking
    */
    @ApiMember(Description="The default option when admin creates a new booking")
    open var DefaultPaymentOptionId:Int? = null

    /**
    * What payment provider to use
    */
    @ApiMember(Description="What payment provider to use")
    open var PaymentProviderId:Int? = null

    /**
    * If you want to include the admin payment options to select from
    */
    @ApiMember(DataType="boolean", Description="If you want to include the admin payment options to select from", ParameterType="query")
    open var AdminPaymentOptions:ArrayList<AdminPaymentOptionsResponse> = ArrayList<AdminPaymentOptionsResponse>()

    /**
    * If you want to include the payment provider options to select from
    */
    @ApiMember(DataType="boolean", Description="If you want to include the payment provider options to select from", ParameterType="query")
    open var PaymentProviderOptions:ArrayList<PaymentProviderOptionsResponse> = ArrayList<PaymentProviderOptionsResponse>()
}

open class AdminPaymentOptionsResponse
{
    /**
    * The payment options id
    */
    @ApiMember(Description="The payment options id")
    open var Id:Int? = null

    /**
    * The payment options name
    */
    @ApiMember(Description="The payment options name")
    open var Name:String? = null

    /**
    * The payment options description
    */
    @ApiMember(Description="The payment options description")
    open var Description:String? = null
}

open class PaymentProviderOptionsResponse
{
    /**
    * The payment provider id
    */
    @ApiMember(Description="The payment provider id")
    open var Id:Int? = null

    /**
    * The payment provider name
    */
    @ApiMember(Description="The payment provider name")
    open var Name:String? = null

    /**
    * The payment provider description
    */
    @ApiMember(Description="The payment provider description")
    open var Description:String? = null
}

Kotlin UpdatePaymentSettings DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /payment/settings/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdatePaymentSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <DefaultPaymentOptionId>0</DefaultPaymentOptionId>
  <Enabled>false</Enabled>
  <PaymentProviderId>0</PaymentProviderId>
  <RefundOnCancelBooking>false</RefundOnCancelBooking>
</UpdatePaymentSettings>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentSettingsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AdminPaymentOptions>
    <AdminPaymentOptionsResponse>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </AdminPaymentOptionsResponse>
  </AdminPaymentOptions>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <DefaultPaymentOptionId>0</DefaultPaymentOptionId>
  <Enabled>false</Enabled>
  <PaymentProviderId>0</PaymentProviderId>
  <PaymentProviderOptions>
    <PaymentProviderOptionsResponse>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </PaymentProviderOptionsResponse>
  </PaymentProviderOptions>
  <RefundOnCancelBooking>false</RefundOnCancelBooking>
</PaymentSettingsQueryResponse>