| 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) |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class StripeV1CreateCheckout implements ICompany
{
/**
* The company id.
*/
@ApiMember(Description="The company id.", IsRequired=true)
public UUID CompanyId = null;
/**
* Country code for checkout
*/
@ApiMember(Description="Country code for checkout", IsRequired=true)
public String CountryCode = null;
/**
* Articles (Could be Service, rebate code types, etc..
*/
@ApiMember(Description="Articles (Could be Service, rebate code types, etc..", IsRequired=true)
public ArrayList<ArticleToCreate> Articles = null;
/**
* 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 String InternalReferenceId = null;
/**
* Optional to set your own confirmation url after payment completed.
*/
@ApiMember(Description="Optional to set your own confirmation url after payment completed.")
public String ConfirmationUrl = null;
/**
* 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 String CancelUrl = null;
/**
* 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 String UiMode = null;
public UUID getCompanyId() { return CompanyId; }
public StripeV1CreateCheckout setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getCountryCode() { return CountryCode; }
public StripeV1CreateCheckout setCountryCode(String value) { this.CountryCode = value; return this; }
public ArrayList<ArticleToCreate> getArticles() { return Articles; }
public StripeV1CreateCheckout setArticles(ArrayList<ArticleToCreate> value) { this.Articles = value; return this; }
public String getInternalReferenceId() { return InternalReferenceId; }
public StripeV1CreateCheckout setInternalReferenceId(String value) { this.InternalReferenceId = value; return this; }
public String getConfirmationUrl() { return ConfirmationUrl; }
public StripeV1CreateCheckout setConfirmationUrl(String value) { this.ConfirmationUrl = value; return this; }
public String getCancelUrl() { return CancelUrl; }
public StripeV1CreateCheckout setCancelUrl(String value) { this.CancelUrl = value; return this; }
public String getUiMode() { return UiMode; }
public StripeV1CreateCheckout setUiMode(String value) { this.UiMode = value; return this; }
}
public static class ArticleToCreate
{
public Integer ArticleId = null;
public Integer ArticleTypeId = null;
public Integer Quantity = null;
public Integer getArticleId() { return ArticleId; }
public ArticleToCreate setArticleId(Integer value) { this.ArticleId = value; return this; }
public Integer getArticleTypeId() { return ArticleTypeId; }
public ArticleToCreate setArticleTypeId(Integer value) { this.ArticleTypeId = value; return this; }
public Integer getQuantity() { return Quantity; }
public ArticleToCreate setQuantity(Integer value) { this.Quantity = value; return this; }
}
public static class StripeCheckoutQueryResponse
{
/**
* The checkout session id
*/
@ApiMember(Description="The checkout session id")
public String Number = null;
/**
* 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 String Url = null;
/**
* The checkout status
*/
@ApiMember(Description="The checkout status")
public String Status = null;
/**
* 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 String ClientSecret = null;
public String getNumber() { return Number; }
public StripeCheckoutQueryResponse setNumber(String value) { this.Number = value; return this; }
public String getUrl() { return Url; }
public StripeCheckoutQueryResponse setUrl(String value) { this.Url = value; return this; }
public String getStatus() { return Status; }
public StripeCheckoutQueryResponse setStatus(String value) { this.Status = value; return this; }
public String getClientSecret() { return ClientSecret; }
public StripeCheckoutQueryResponse setClientSecret(String value) { this.ClientSecret = value; return this; }
}
}
Java StripeV1CreateCheckout DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<StripeV1CreateCheckout xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Articles>
<ArticleToCreate>
<ArticleId>0</ArticleId>
<ArticleTypeId>0</ArticleTypeId>
<Quantity>0</Quantity>
</ArticleToCreate>
</Articles>
<CancelUrl>String</CancelUrl>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<ConfirmationUrl>String</ConfirmationUrl>
<CountryCode>String</CountryCode>
<InternalReferenceId>String</InternalReferenceId>
<UiMode>String</UiMode>
</StripeV1CreateCheckout>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <StripeCheckoutQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <ClientSecret>String</ClientSecret> <Number>String</Number> <Status>String</Status> <Url>String</Url> </StripeCheckoutQueryResponse>