Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
POST | /payment/settings | Add payment settings | Add payment settings for the logged in company |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
Enabled | body | bool | No | The payson payment is enabled |
InvoiceFee | body | int | No | If there should be any fee added when customer selected invoice payment method |
AllowCreditCardPayment | body | bool | No | If allow credit card payment |
AllowInvoicePayment | body | bool | No | If allow invoice payment |
AllowBankPayment | body | bool | No | If allow bank payment |
RefundOnCancelBooking | body | bool | No | Automatically refund customer on canceled booking |
DefaultAdminPaymentOptionsId | body | int? | No | The default option when admin creates a new booking |
PaymentProviderId | body | int | No | What payment provider to use |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | No | The company id |
Enabled | form | bool | No | The payment is enabled |
InvoiceFee | form | int | No | If there should be any fee added when customer selected invoice payment method |
AllowCreditCardPayment | form | bool | No | If allow credit card payment |
AllowInvoicePayment | form | bool | No | If allow invoice payment |
AllowBankPayment | form | bool | No | If allow bank payment |
RefundOnCancelBooking | form | bool | No | Automatically refund customer on canceled booking |
DefaultPaymentOptionId | form | int? | No | The default option when admin creates a new booking |
PaymentProviderId | form | int | No | What payment provider to use |
AdminPaymentOptions | query | boolean | No | If you want to include the admin payment options to select from |
PaymentProviderOptions | query | boolean | No | If you want to include the payment provider options to select from |
SendPaymentRequestDirectly | form | bool | No | SendPaymentRequestDirectly |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The payment options id |
Name | form | string | No | The payment options name |
Description | form | string | No | The payment options description |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The payment provider id |
Name | form | string | No | The payment provider name |
Description | form | string | No | The payment provider description |
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.
POST /payment/settings HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddPaymentSettings 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>
<DefaultAdminPaymentOptionsId>0</DefaultAdminPaymentOptionsId>
<Enabled>false</Enabled>
<InvoiceFee>0</InvoiceFee>
<PaymentProviderId>0</PaymentProviderId>
<RefundOnCancelBooking>false</RefundOnCancelBooking>
</AddPaymentSettings>
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>