BokaMera.API.Host

<back to all web services

QvicklyCheckoutIpnCallBack

The following routes are available for this service:
POST/payment/billmate/v1/ipncallbackIPN callback for Qvickly checkout 1.0IPN callback for Qvickly checkout 1.0
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class QvicklyCheckoutIpnCallBack implements ICompany
    {
        /**
        * The company id, if empty will use the company id for the user you are logged in with.
        */
        @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        public UUID CompanyId = null;

        /**
        * Internal reference id (Could be booking, could be Article..)
        */
        @ApiMember(Description="Internal reference id (Could be booking, could be Article..)")
        public String BookingId = null;

        /**
        * The payment credentials.
        */
        @ApiMember(Description="The payment credentials.")
        public CredentialsResponse credentials = null;

        /**
        * The payment ipn callback data.
        */
        @ApiMember(Description="The payment ipn callback data.")
        public QvicklyIpnCallbackResponseData data = null;

        /**
        * Article type (Could be Service, rebate code types, etc..
        */
        @ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
        public Integer ArticleTypeId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public QvicklyCheckoutIpnCallBack setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getBookingId() { return BookingId; }
        public QvicklyCheckoutIpnCallBack setBookingId(String value) { this.BookingId = value; return this; }
        public CredentialsResponse getCredentials() { return credentials; }
        public QvicklyCheckoutIpnCallBack setCredentials(CredentialsResponse value) { this.credentials = value; return this; }
        public QvicklyIpnCallbackResponseData getData() { return data; }
        public QvicklyCheckoutIpnCallBack setData(QvicklyIpnCallbackResponseData value) { this.data = value; return this; }
        public Integer getArticleTypeId() { return ArticleTypeId; }
        public QvicklyCheckoutIpnCallBack setArticleTypeId(Integer value) { this.ArticleTypeId = value; return this; }
    }

    public static class CredentialsResponse
    {
        public String hash = null;
        public String id = null;
        public String version = null;
        public String client = null;
        public ServerDataResponse serverdata = null;
        public String time = null;
        public String test = null;
        public String language = null;
        
        public String getHash() { return hash; }
        public CredentialsResponse setHash(String value) { this.hash = value; return this; }
        public String getId() { return id; }
        public CredentialsResponse setId(String value) { this.id = value; return this; }
        public String getVersion() { return version; }
        public CredentialsResponse setVersion(String value) { this.version = value; return this; }
        public String getClient() { return client; }
        public CredentialsResponse setClient(String value) { this.client = value; return this; }
        public ServerDataResponse getServerdata() { return serverdata; }
        public CredentialsResponse setServerdata(ServerDataResponse value) { this.serverdata = value; return this; }
        public String getTime() { return time; }
        public CredentialsResponse setTime(String value) { this.time = value; return this; }
        public String getTest() { return test; }
        public CredentialsResponse setTest(String value) { this.test = value; return this; }
        public String getLanguage() { return language; }
        public CredentialsResponse setLanguage(String value) { this.language = value; return this; }
    }

    public static class ServerDataResponse
    {
        public String HTTP_HOST = null;
        public String HTTP_CONNECTION = null;
        public String HTTP_CACHE_CONTROL = null;
        public String HTTP_ACCEPT = null;
        public String HTTP_USER_AGENT = null;
        public String HTTP_ACCEPT_ENCODING = null;
        public String HTTP_ACCEPT_LANGUAGE = null;
        public String PATH = null;
        public String SERVER_SOFTWARE = null;
        public String SERVER_NAME = null;
        public String SERVER_ADDR = null;
        public String SERVER_PORT = null;
        public String REMOTE_ADDR = null;
        public String REMOTE_PORT = null;
        public String GATEWAY_INTERFACE = null;
        public String SERVER_PROTOCOL = null;
        public String REQUEST_METHOD = null;
        public String QUERY_STRING = null;
        public String REQUEST_TIME = null;
        
        public String getHttpHost() { return HTTP_HOST; }
        public ServerDataResponse setHttpHost(String value) { this.HTTP_HOST = value; return this; }
        public String getHttpConnection() { return HTTP_CONNECTION; }
        public ServerDataResponse setHttpConnection(String value) { this.HTTP_CONNECTION = value; return this; }
        public String getHttpCacheControl() { return HTTP_CACHE_CONTROL; }
        public ServerDataResponse setHttpCacheControl(String value) { this.HTTP_CACHE_CONTROL = value; return this; }
        public String getHttpAccept() { return HTTP_ACCEPT; }
        public ServerDataResponse setHttpAccept(String value) { this.HTTP_ACCEPT = value; return this; }
        public String getHttpUserAgent() { return HTTP_USER_AGENT; }
        public ServerDataResponse setHttpUserAgent(String value) { this.HTTP_USER_AGENT = value; return this; }
        public String getHttpAcceptEncoding() { return HTTP_ACCEPT_ENCODING; }
        public ServerDataResponse setHttpAcceptEncoding(String value) { this.HTTP_ACCEPT_ENCODING = value; return this; }
        public String getHttpAcceptLanguage() { return HTTP_ACCEPT_LANGUAGE; }
        public ServerDataResponse setHttpAcceptLanguage(String value) { this.HTTP_ACCEPT_LANGUAGE = value; return this; }
        public String getPath() { return PATH; }
        public ServerDataResponse setPath(String value) { this.PATH = value; return this; }
        public String getServerSoftware() { return SERVER_SOFTWARE; }
        public ServerDataResponse setServerSoftware(String value) { this.SERVER_SOFTWARE = value; return this; }
        public String getServerName() { return SERVER_NAME; }
        public ServerDataResponse setServerName(String value) { this.SERVER_NAME = value; return this; }
        public String getServerAddr() { return SERVER_ADDR; }
        public ServerDataResponse setServerAddr(String value) { this.SERVER_ADDR = value; return this; }
        public String getServerPort() { return SERVER_PORT; }
        public ServerDataResponse setServerPort(String value) { this.SERVER_PORT = value; return this; }
        public String getRemoteAddr() { return REMOTE_ADDR; }
        public ServerDataResponse setRemoteAddr(String value) { this.REMOTE_ADDR = value; return this; }
        public String getRemotePort() { return REMOTE_PORT; }
        public ServerDataResponse setRemotePort(String value) { this.REMOTE_PORT = value; return this; }
        public String getGatewayInterface() { return GATEWAY_INTERFACE; }
        public ServerDataResponse setGatewayInterface(String value) { this.GATEWAY_INTERFACE = value; return this; }
        public String getServerProtocol() { return SERVER_PROTOCOL; }
        public ServerDataResponse setServerProtocol(String value) { this.SERVER_PROTOCOL = value; return this; }
        public String getRequestMethod() { return REQUEST_METHOD; }
        public ServerDataResponse setRequestMethod(String value) { this.REQUEST_METHOD = value; return this; }
        public String getQueryString() { return QUERY_STRING; }
        public ServerDataResponse setQueryString(String value) { this.QUERY_STRING = value; return this; }
        public String getRequestTime() { return REQUEST_TIME; }
        public ServerDataResponse setRequestTime(String value) { this.REQUEST_TIME = value; return this; }
    }

    public static class QvicklyIpnCallbackResponseData
    {
        public String number = null;
        public String status = null;
        public String orderid = null;
        public String url = null;
        
        public String getNumber() { return number; }
        public QvicklyIpnCallbackResponseData setNumber(String value) { this.number = value; return this; }
        public String getStatus() { return status; }
        public QvicklyIpnCallbackResponseData setStatus(String value) { this.status = value; return this; }
        public String getOrderid() { return orderid; }
        public QvicklyIpnCallbackResponseData setOrderid(String value) { this.orderid = value; return this; }
        public String getUrl() { return url; }
        public QvicklyIpnCallbackResponseData setUrl(String value) { this.url = value; return this; }
    }

    public static class IpnCallBackResponse
    {
        public String Message = null;
        public Boolean Success = null;
        
        public String getMessage() { return Message; }
        public IpnCallBackResponse setMessage(String value) { this.Message = value; return this; }
        public Boolean isSuccess() { return Success; }
        public IpnCallBackResponse setSuccess(Boolean value) { this.Success = value; return this; }
    }

}

Java QvicklyCheckoutIpnCallBack DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment/billmate/v1/ipncallback HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QvicklyCheckoutIpnCallBack xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ArticleTypeId>0</ArticleTypeId>
  <BookingId>String</BookingId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <credentials>
    <client>String</client>
    <hash>String</hash>
    <id>String</id>
    <language>String</language>
    <serverdata>
      <GATEWAY_INTERFACE>String</GATEWAY_INTERFACE>
      <HTTP_ACCEPT>String</HTTP_ACCEPT>
      <HTTP_ACCEPT_ENCODING>String</HTTP_ACCEPT_ENCODING>
      <HTTP_ACCEPT_LANGUAGE>String</HTTP_ACCEPT_LANGUAGE>
      <HTTP_CACHE_CONTROL>String</HTTP_CACHE_CONTROL>
      <HTTP_CONNECTION>String</HTTP_CONNECTION>
      <HTTP_HOST>String</HTTP_HOST>
      <HTTP_USER_AGENT>String</HTTP_USER_AGENT>
      <PATH>String</PATH>
      <QUERY_STRING>String</QUERY_STRING>
      <REMOTE_ADDR>String</REMOTE_ADDR>
      <REMOTE_PORT>String</REMOTE_PORT>
      <REQUEST_METHOD>String</REQUEST_METHOD>
      <REQUEST_TIME>String</REQUEST_TIME>
      <SERVER_ADDR>String</SERVER_ADDR>
      <SERVER_NAME>String</SERVER_NAME>
      <SERVER_PORT>String</SERVER_PORT>
      <SERVER_PROTOCOL>String</SERVER_PROTOCOL>
      <SERVER_SOFTWARE>String</SERVER_SOFTWARE>
    </serverdata>
    <test>String</test>
    <time>String</time>
    <version>String</version>
  </credentials>
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QvicklyIntegration.Models.Payment">
    <d2p1:number>String</d2p1:number>
    <d2p1:orderid>String</d2p1:orderid>
    <d2p1:status>String</d2p1:status>
    <d2p1:url>String</d2p1:url>
  </data>
</QvicklyCheckoutIpnCallBack>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IpnCallBackResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Message>String</Message>
  <Success>false</Success>
</IpnCallBackResponse>