| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /payment/settings | Get payment settings | Get 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 |
| 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 |
| 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 |
| 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 .other suffix or ?format=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: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Enabled":false,"RefundOnCancelBooking":false,"DefaultPaymentOptionId":0,"PaymentProviderId":0,"AdminPaymentOptions":[{"Id":0,"Name":"String","Description":"String"}],"PaymentProviderOptions":[{"Id":0,"Name":"String","Description":"String"}]}