| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /payment/settings/ | Update payment settings | Update payment settings for the logged in company |
|---|
import Foundation
import ServiceStack
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdatePaymentSettings : ICompany, Codable
{
/**
* 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 var companyId:String?
/**
* The payment is enabled
*/
// @ApiMember(Description="The payment is enabled")
public var enabled:Bool?
/**
* If there should be any fee added when customer selected invoice payment method
*/
// @ApiMember(Description="If there should be any fee added when customer selected invoice payment method")
public var invoiceFee:Int?
/**
* If allow credit card payment
*/
// @ApiMember(Description="If allow credit card payment")
public var allowCreditCardPayment:Bool?
/**
* If allow invoice payment
*/
// @ApiMember(Description="If allow invoice payment")
public var allowInvoicePayment:Bool?
/**
* If allow bank payment
*/
// @ApiMember(Description="If allow bank payment")
public var allowBankPayment:Bool?
/**
* Automatically refund customer on canceled booking
*/
// @ApiMember(Description="Automatically refund customer on canceled booking")
public var refundOnCancelBooking:Bool?
/**
* The default option when admin creates a new booking
*/
// @ApiMember(Description="The default option when admin creates a new booking")
public var defaultPaymentOptionId:Int?
/**
* What payment provider to use
*/
// @ApiMember(Description="What payment provider to use")
public var paymentProviderId:Int?
required public init(){}
}
public class PaymentSettingsQueryResponse : Codable
{
/**
* The company id
*/
// @ApiMember(Description="The company id")
public var companyId:String
/**
* The payment is enabled
*/
// @ApiMember(Description="The payment is enabled")
public var enabled:Bool
/**
* If there should be any fee added when customer selected invoice payment method
*/
// @ApiMember(Description="If there should be any fee added when customer selected invoice payment method")
public var invoiceFee:Int
/**
* If allow credit card payment
*/
// @ApiMember(Description="If allow credit card payment")
public var allowCreditCardPayment:Bool
/**
* If allow invoice payment
*/
// @ApiMember(Description="If allow invoice payment")
public var allowInvoicePayment:Bool
/**
* If allow bank payment
*/
// @ApiMember(Description="If allow bank payment")
public var allowBankPayment:Bool
/**
* Automatically refund customer on canceled booking
*/
// @ApiMember(Description="Automatically refund customer on canceled booking")
public var refundOnCancelBooking:Bool
/**
* The default option when admin creates a new booking
*/
// @ApiMember(Description="The default option when admin creates a new booking")
public var defaultPaymentOptionId:Int?
/**
* What payment provider to use
*/
// @ApiMember(Description="What payment provider to use")
public var paymentProviderId:Int
/**
* 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")
public var adminPaymentOptions:[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")
public var paymentProviderOptions:[PaymentProviderOptionsResponse] = []
/**
* SendPaymentRequestDirectly
*/
// @ApiMember(Description="SendPaymentRequestDirectly")
public var sendPaymentRequestDirectly:Bool
required public init(){}
}
public class AdminPaymentOptionsResponse : Codable
{
/**
* The payment options id
*/
// @ApiMember(Description="The payment options id")
public var id:Int
/**
* The payment options name
*/
// @ApiMember(Description="The payment options name")
public var name:String
/**
* The payment options description
*/
// @ApiMember(Description="The payment options description")
public var Description:String
required public init(){}
}
public class PaymentProviderOptionsResponse : Codable
{
/**
* The payment provider id
*/
// @ApiMember(Description="The payment provider id")
public var id:Int
/**
* The payment provider name
*/
// @ApiMember(Description="The payment provider name")
public var name:String
/**
* The payment provider description
*/
// @ApiMember(Description="The payment provider description")
public var Description:String
required public init(){}
}
Swift UpdatePaymentSettings DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: api.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">
<AllowBankPayment>false</AllowBankPayment>
<AllowCreditCardPayment>false</AllowCreditCardPayment>
<AllowInvoicePayment>false</AllowInvoicePayment>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<DefaultPaymentOptionId>0</DefaultPaymentOptionId>
<Enabled>false</Enabled>
<InvoiceFee>0</InvoiceFee>
<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>
<AllowBankPayment>false</AllowBankPayment>
<AllowCreditCardPayment>false</AllowCreditCardPayment>
<AllowInvoicePayment>false</AllowInvoicePayment>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<DefaultPaymentOptionId>0</DefaultPaymentOptionId>
<Enabled>false</Enabled>
<InvoiceFee>0</InvoiceFee>
<PaymentProviderId>0</PaymentProviderId>
<PaymentProviderOptions>
<PaymentProviderOptionsResponse>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</PaymentProviderOptionsResponse>
</PaymentProviderOptions>
<RefundOnCancelBooking>false</RefundOnCancelBooking>
<SendPaymentRequestDirectly>false</SendPaymentRequestDirectly>
</PaymentSettingsQueryResponse>