| 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 Number: 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;
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 .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length
{
Number: String,
Url: String,
Status: String,
ClientSecret: String
}