| 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) |
|---|
export class StripeCheckoutQueryResponse
{
/** @description The checkout session id */
// @ApiMember(Description="The checkout session id")
public SessionId: string;
/** @description The url for checkout module to be placed in a iframe */
// @ApiMember(Description="The url for checkout module to be placed in a iframe")
public Url: string;
/** @description The checkout status */
// @ApiMember(Description="The checkout status")
public Status: string;
/** @description Client secret to be used when initializing Stripe.js embedded checkout. */
// @ApiMember(Description="Client secret to be used when initializing Stripe.js embedded checkout.")
public ClientSecret: string;
/** @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. */
// @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 CustomerId: string;
/** @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. */
// @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 PaymentIntentClientSecret: string;
public PaymentIntentId: string;
public StripeAccount: string;
public constructor(init?: Partial<StripeCheckoutQueryResponse>) { (Object as any).assign(this, init); }
}
export class StripeV1CreateCheckout implements ICompany
{
/** @description The company id. */
// @ApiMember(Description="The company id.", IsRequired=true)
public CompanyId: string;
/** @description Country code for checkout */
// @ApiMember(Description="Country code for checkout", IsRequired=true)
public CountryCode: string;
/** @description Articles (Could be Service, rebate code types, etc.. */
// @ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)
public Articles: ArticleToCreate[];
/** @description An internal reference id (Could be booking, rebate code etc.) */
// @ApiMember(Description="An internal reference id (Could be booking, rebate code etc.)", IsRequired=true)
public InternalReferenceId: string;
/** @description Optional to set your own confirmation url after payment completed. */
// @ApiMember(Description="Optional to set your own confirmation url after payment completed.")
public ConfirmationUrl: string;
/** @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>. */
// @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 CancelUrl: string;
/** @description The UI mode of the Session. Defaults to <c>hosted</c>; One of: <c>embedded</c>, or <c>hosted</c> */
// @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 UiMode: string;
public constructor(init?: Partial<StripeV1CreateCheckout>) { (Object as any).assign(this, init); }
}
export class ArticleToCreate
{
public ArticleId: number;
public ArticleTypeId: number;
public Quantity: number;
public constructor(init?: Partial<ArticleToCreate>) { (Object as any).assign(this, init); }
}
TypeScript 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"}