| 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 |
|---|---|---|---|---|
| SessionId | 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. |
| CustomerId | form | string | No | (ID of the Customer) The ID of the customer for this Session. For Checkout Sessions in subscription mode or Checkout Sessions with customer_creation set as always in payment mode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created. |
| PaymentIntentClientSecret | form | string | No | The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to accept a payment and learn about how client_secret should be handled. |
| PaymentIntentId | form | string | No | |
| StripeAccount | form | string | No |
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
{"SessionId":"String","Url":"String","Status":"String","ClientSecret":"String","CustomerId":"String","PaymentIntentClientSecret":"String","PaymentIntentId":"String","StripeAccount":"String"}