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.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class QvicklyCheckoutIpnCallBack : 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.")
    var CompanyId:UUID? = null

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

    /**
    * The payment credentials.
    */
    @ApiMember(Description="The payment credentials.")
    var credentials:CredentialsResponse? = null

    /**
    * The payment ipn callback data.
    */
    @ApiMember(Description="The payment ipn callback data.")
    @SerializedName("data") var Data:QvicklyIpnCallbackResponseData? = null

    /**
    * Article type (Could be Service, rebate code types, etc..
    */
    @ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
    var ArticleTypeId:Int? = null
}

open class CredentialsResponse
{
    var hash:String? = null
    var id:String? = null
    var version:String? = null
    var client:String? = null
    var serverdata:ServerDataResponse? = null
    var time:String? = null
    var test:String? = null
    var language:String? = null
}

open class ServerDataResponse
{
    var HTTP_HOST:String? = null
    var HTTP_CONNECTION:String? = null
    var HTTP_CACHE_CONTROL:String? = null
    var HTTP_ACCEPT:String? = null
    var HTTP_USER_AGENT:String? = null
    var HTTP_ACCEPT_ENCODING:String? = null
    var HTTP_ACCEPT_LANGUAGE:String? = null
    var PATH:String? = null
    var SERVER_SOFTWARE:String? = null
    var SERVER_NAME:String? = null
    var SERVER_ADDR:String? = null
    var SERVER_PORT:String? = null
    var REMOTE_ADDR:String? = null
    var REMOTE_PORT:String? = null
    var GATEWAY_INTERFACE:String? = null
    var SERVER_PROTOCOL:String? = null
    var REQUEST_METHOD:String? = null
    var QUERY_STRING:String? = null
    var REQUEST_TIME:String? = null
}

open class QvicklyIpnCallbackResponseData
{
    var number:String? = null
    var status:String? = null
    var orderid:String? = null
    var url:String? = null
}

open class IpnCallBackResponse
{
    var Message:String? = null
    var Success:Boolean? = null
}

Kotlin 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>