| POST | /payment/stripe/v1/checkout | Create an checkout for Payble entity. Note if existing checkouts already exists, it will invalidate those. | Create Stripe checkout (requires settings for Stripe Checkout 1.0) |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | Yes | The company id. |
| CountryCode | body | string | Yes | Country code for checkout |
| Articles | body | ArticleToCreate[] | Yes | Articles (Could be Service, rebate code types, etc.. |
| InternalReferenceId | body | string | Yes | An internal reference id (Could be booking, rebate code etc.) |
| ConfirmationUrl | body | string | No | Optional to set your own confirmation url after payment completed. |
| CancelUrl | body | string | No | If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is |
| UiMode | body | string | Yes | The UI mode of the Session. Defaults to |
| 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 | string | No | The checkout session id |
| Url | form | string | No | The url for checkout module to be placed in a iframe |
| Status | form | string | No | The checkout status |
| ClientSecret | form | string | No | Client secret to be used when initializing Stripe.js embedded checkout. |
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.
POST /payment/stripe/v1/checkout HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","CountryCode":"String","Articles":[{"ArticleId":0,"ArticleTypeId":0,"Quantity":0}],"InternalReferenceId":"String","ConfirmationUrl":"String","CancelUrl":"String","UiMode":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Number":"String","Url":"String","Status":"String","ClientSecret":"String"}