BokaMera.API.Host

<back to all web services

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/settingsGet payson payment settingsGet payson payment settings for the logged in company
PaymentSettingsQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IncludeAdminPaymentOptionsquerybooleanNoIf you want to include the admin payment options to select from
IncludePaymentProviderOptionsquerybooleanNoIf you want to include the payment provider options to select from
PaymentSettingsQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id
EnabledformboolNoThe payment is enabled
InvoiceFeeformintNoIf there should be any fee added when customer selected invoice payment method
AllowCreditCardPaymentformboolNoIf allow credit card payment
AllowInvoicePaymentformboolNoIf allow invoice payment
AllowBankPaymentformboolNoIf allow bank payment
RefundOnCancelBookingformboolNoAutomatically refund customer on canceled booking
DefaultPaymentOptionIdformint?NoThe default option when admin creates a new booking
PaymentProviderIdformintNoWhat payment provider to use
AdminPaymentOptionsquerybooleanNoIf you want to include the admin payment options to select from
PaymentProviderOptionsquerybooleanNoIf you want to include the payment provider options to select from
SendPaymentRequestDirectlyformboolNoSendPaymentRequestDirectly
AdminPaymentOptionsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe payment options id
NameformstringNoThe payment options name
DescriptionformstringNoThe payment options description
PaymentProviderOptionsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe payment provider id
NameformstringNoThe payment provider name
DescriptionformstringNoThe payment provider description

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

HTTP + OTHER

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: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Enabled":false,"InvoiceFee":0,"AllowCreditCardPayment":false,"AllowInvoicePayment":false,"AllowBankPayment":false,"RefundOnCancelBooking":false,"DefaultPaymentOptionId":0,"PaymentProviderId":0,"AdminPaymentOptions":[{"Id":0,"Name":"String","Description":"String"}],"PaymentProviderOptions":[{"Id":0,"Name":"String","Description":"String"}],"SendPaymentRequestDirectly":false}