| POST | /payment/payson/v2/checkout | Create an checkout for Booking. Note if existing checkouts already exists, i will invalidate those. | Create payson checkout (requires settings for Payson Checkout 2.0) |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class PaysonV2CreateCheckout implements ICompany
{
/**
* The company id.
*/
@ApiMember(Description="The company id.", IsRequired=true)
public UUID CompanyId = null;
/**
* The reference id. (Could be booking, could be rebate code etc.)
*/
@ApiMember(Description="The reference id. (Could be booking, could be rebate code etc.)")
public String BookingId = null;
/**
* The reference id. (Could be booking, could be rebate code etc.)
*/
@ApiMember(Description="The reference id. (Could be booking, could be rebate code etc.)", IsRequired=true)
public String InternalReferenceId = null;
/**
* Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.
*/
@ApiMember(Description="Optional to set the checkout url. This url will be redirected to if payment is interupted for some reason.")
public Uri CheckoutUrl = null;
/**
* Optional to set your own confirmation url after payment completed.
*/
@ApiMember(Description="Optional to set your own confirmation url after payment completed.")
public Uri ConfirmationUrl = null;
/**
* The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3
*/
@ApiMember(Description="The payment origin id. HomePage = 0, Embedded = 1, Admin = 2, Apps = 3", IsRequired=true)
public PaymentOrigin PaymentOrigin = null;
/**
* If you want to have another language (sv, fi, dk, no, en) than the default language in system settings, specify it here. Leave empty if default language should be used.
*/
@ApiMember(Description="If you want to have another language (sv, fi, dk, no, en) than the default language in system settings, specify it here. Leave empty if default language should be used.", IsRequired=true)
public String Language = null;
/**
* Country code for checkout
*/
@ApiMember(Description="Country code for checkout", IsRequired=true)
public String CountryCode = null;
/**
* Determins if it's a test call
*/
@ApiMember(Description="Determins if it's a test call")
public Boolean TestMode = 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;
public UUID getCompanyId() { return CompanyId; }
public PaysonV2CreateCheckout setCompanyId(UUID value) { this.CompanyId = value; return this; }
public String getBookingId() { return BookingId; }
public PaysonV2CreateCheckout setBookingId(String value) { this.BookingId = value; return this; }
public String getInternalReferenceId() { return InternalReferenceId; }
public PaysonV2CreateCheckout setInternalReferenceId(String value) { this.InternalReferenceId = value; return this; }
public Uri getCheckoutUrl() { return CheckoutUrl; }
public PaysonV2CreateCheckout setCheckoutUrl(Uri value) { this.CheckoutUrl = value; return this; }
public Uri getConfirmationUrl() { return ConfirmationUrl; }
public PaysonV2CreateCheckout setConfirmationUrl(Uri value) { this.ConfirmationUrl = value; return this; }
public PaymentOrigin getPaymentOrigin() { return PaymentOrigin; }
public PaysonV2CreateCheckout setPaymentOrigin(PaymentOrigin value) { this.PaymentOrigin = value; return this; }
public String getLanguage() { return Language; }
public PaysonV2CreateCheckout setLanguage(String value) { this.Language = value; return this; }
public String getCountryCode() { return CountryCode; }
public PaysonV2CreateCheckout setCountryCode(String value) { this.CountryCode = value; return this; }
public Boolean isTestMode() { return TestMode; }
public PaysonV2CreateCheckout setTestMode(Boolean value) { this.TestMode = value; return this; }
public ArrayList<ArticleToCreate> getArticles() { return Articles; }
public PaysonV2CreateCheckout setArticles(ArrayList<ArticleToCreate> value) { this.Articles = value; return this; }
}
public static enum PaymentOrigin
{
HomePage,
Embedded,
Admin,
Apps,
HomePageNew;
}
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 PaysonCheckoutV2Response
{
/**
* The checkout id
*/
@ApiMember(Description="The checkout id")
public UUID Id = null;
/**
* The code snippet to for checkout module
*/
@ApiMember(Description="The code snippet to for checkout module")
public String Snippet = null;
/**
* The checkout status
*/
@ApiMember(Description="The checkout status")
public Payson2CheckoutStatus Status = null;
public UUID getId() { return Id; }
public PaysonCheckoutV2Response setId(UUID value) { this.Id = value; return this; }
public String getSnippet() { return Snippet; }
public PaysonCheckoutV2Response setSnippet(String value) { this.Snippet = value; return this; }
public Payson2CheckoutStatus getStatus() { return Status; }
public PaysonCheckoutV2Response setStatus(Payson2CheckoutStatus value) { this.Status = value; return this; }
}
public static enum Payson2CheckoutStatus
{
None,
Created,
FormsFilled,
ReadyToPay,
ProcessingPayment,
ReadyToShip,
Shipped,
PaidToAccount,
Canceled,
Credited,
Expired,
Denied;
}
}
Java PaysonV2CreateCheckout 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/payson/v2/checkout HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
BookingId: String,
InternalReferenceId: String,
PaymentOrigin: HomePage,
Language: String,
CountryCode: String,
TestMode: False,
Articles:
[
{
ArticleId: 0,
ArticleTypeId: 0,
Quantity: 0
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Snippet: String,
Status: None
}