BokaMera.API.Host

PaymentSettingsQuery

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

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

**PaymentSettingsQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
IncludeAdminPaymentOptions	query	boolean	No	If you want to include the admin payment options to select from
IncludePaymentProviderOptions	query	boolean	No	If you want to include the payment provider options to select from

**PaymentSettingsQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No	The company id
Enabled	form	bool	No	The payment is enabled
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	Yes	If you want to include the admin payment options to select from
PaymentProviderOptions	query	boolean	Yes	If you want to include the payment provider options to select from

**AdminPaymentOptionsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The payment options id
Name	form	string	Yes	The payment options name
Description	form	string	Yes	The payment options description

**PaymentProviderOptionsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The payment provider id
Name	form	string	Yes	The payment provider name
Description	form	string	Yes	The payment provider description

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.

GET /payment/settings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

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>