| 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) |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class ArticleToCreate
Public Overridable Property ArticleId As Integer
Public Overridable Property ArticleTypeId As Integer
Public Overridable Property Quantity As Integer
End Class
Public Partial Class StripeCheckoutQueryResponse
'''<Summary>
'''The checkout session id
'''</Summary>
<ApiMember(Description:="The checkout session id")>
Public Overridable Property SessionId As String
'''<Summary>
'''The url for checkout module to be placed in a iframe
'''</Summary>
<ApiMember(Description:="The url for checkout module to be placed in a iframe")>
Public Overridable Property Url As String
'''<Summary>
'''The checkout status
'''</Summary>
<ApiMember(Description:="The checkout status")>
Public Overridable Property Status As String
'''<Summary>
'''Client secret to be used when initializing Stripe.js embedded checkout.
'''</Summary>
<ApiMember(Description:="Client secret to be used when initializing Stripe.js embedded checkout.")>
Public Overridable Property ClientSecret As String
'''<Summary>
'''(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.
'''</Summary>
<ApiMember(Description:="(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.")>
Public Overridable Property CustomerId As String
'''<Summary>
'''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.
'''</Summary>
<ApiMember(Description:="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.")>
Public Overridable Property PaymentIntentClientSecret As String
Public Overridable Property PaymentIntentId As String
Public Overridable Property StripeAccount As String
End Class
Public Partial Class StripeV1CreateCheckout
Implements ICompany
Public Sub New()
Articles = New ArticleToCreate(){}
End Sub
'''<Summary>
'''The company id.
'''</Summary>
<ApiMember(Description:="The company id.", IsRequired:=true)>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''Country code for checkout
'''</Summary>
<ApiMember(Description:="Country code for checkout", IsRequired:=true)>
Public Overridable Property CountryCode As String
'''<Summary>
'''Articles (Could be Service, rebate code types, etc..
'''</Summary>
<ApiMember(Description:="Articles (Could be Service, rebate code types, etc..", IsRequired:=true)>
Public Overridable Property Articles As ArticleToCreate()
'''<Summary>
'''An internal reference id (Could be booking, rebate code etc.)
'''</Summary>
<ApiMember(Description:="An internal reference id (Could be booking, rebate code etc.)", IsRequired:=true)>
Public Overridable Property InternalReferenceId As String
'''<Summary>
'''Optional to set your own confirmation url after payment completed.
'''</Summary>
<ApiMember(Description:="Optional to set your own confirmation url after payment completed.")>
Public Overridable Property ConfirmationUrl As String
'''<Summary>
'''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 <c>embedded</c>.
'''</Summary>
<ApiMember(Description:="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 <c>embedded</c>.")>
Public Overridable Property CancelUrl As String
'''<Summary>
'''The UI mode of the Session. Defaults to <c>hosted</c>; One of: <c>embedded</c>, or <c>hosted</c>
'''</Summary>
<ApiMember(Description:="The UI mode of the Session. Defaults to <c>hosted</c>; One of: <c>embedded</c>, or <c>hosted</c>", IsRequired:=true)>
Public Overridable Property UiMode As String
End Class
End Namespace
End Namespace
VB.NET StripeV1CreateCheckout DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
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: application/json
Content-Length: length
{"SessionId":"String","Url":"String","Status":"String","ClientSecret":"String","CustomerId":"String","PaymentIntentClientSecret":"String","PaymentIntentId":"String","StripeAccount":"String"}