| POST | /payment/billmate/v1/checkout | Create an checkout for Booking. Note if existing checkouts already exists, i will invalidate those. | Create Qvickly checkout (requires settings for Billmat Checkout 1.0) |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | Yes | The company id. |
| BookingId | body | string | No | An internal reference id (Could be booking, rebate code etc.) |
| InternalReferenceId | body | string | Yes | An internal reference id (Could be booking, rebate code etc.) |
| CheckoutUrl | body | Uri | No | Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason. |
| ConfirmationUrl | body | Uri | No | Optional to set your own confirmation url after payment completed. |
| PaymentOrigin | body | PaymentOrigin | Yes | The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3 |
| Language | body | string | Yes | If you want to have another language (sv, fi, dk, no, en) than the default language in system settings, specify it here. Leave empty if default language should be used. |
| TestMode | body | bool | No | Determins if it's a test call |
| Articles | body | ArticleToCreate[] | Yes | Articles (Could be Service, rebate code types, etc.. |
| HomePage | |
| Embedded | |
| Admin | |
| Apps | |
| HomePageNew |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ArticleId | form | int | No | |
| ArticleTypeId | form | int | No | |
| Quantity | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Number | form | int | No | The checkout id |
| Url | form | string | No | The url for checkout module to be placed in a iframe |
| Status | form | string | No | The checkout status |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /payment/billmate/v1/checkout HTTP/1.1
Host: api.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","BookingId":"String","InternalReferenceId":"String","PaymentOrigin":"HomePage","Language":"String","TestMode":false,"Articles":[{"ArticleId":0,"ArticleTypeId":0,"Quantity":0}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Number":0,"Url":"String","Status":"String"}