Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
GET | /payment/settings | Get payson payment settings | Get payson payment settings for the logged in company |
---|
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 |
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 .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK Content-Type: text/jsv 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 }