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
QvicklyCheckoutIpnCallBack Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
BookingIdbodyintNoThe booking id.
credentialsbodyCredentialsResponseNoThe payment credentials.
databodyQvicklyIpnCallbackResponseDataNoThe payment ipn callback data.
CredentialsResponse Parameters:
NameParameterData TypeRequiredDescription
hashformstringNo
idformstringNo
versionformstringNo
clientformstringNo
serverdataformServerDataResponseNo
timeformstringNo
testformstringNo
languageformstringNo
ServerDataResponse Parameters:
NameParameterData TypeRequiredDescription
HTTP_HOSTformstringNo
HTTP_CONNECTIONformstringNo
HTTP_CACHE_CONTROLformstringNo
HTTP_ACCEPTformstringNo
HTTP_USER_AGENTformstringNo
HTTP_ACCEPT_ENCODINGformstringNo
HTTP_ACCEPT_LANGUAGEformstringNo
PATHformstringNo
SERVER_SOFTWAREformstringNo
SERVER_NAMEformstringNo
SERVER_ADDRformstringNo
SERVER_PORTformstringNo
REMOTE_ADDRformstringNo
REMOTE_PORTformstringNo
GATEWAY_INTERFACEformstringNo
SERVER_PROTOCOLformstringNo
REQUEST_METHODformstringNo
QUERY_STRINGformstringNo
REQUEST_TIMEformstringNo
QvicklyIpnCallbackResponseData Parameters:
NameParameterData TypeRequiredDescription
numberformstringNo
statusformstringNo
orderidformstringNo
urlformstringNo
IpnCallBackResponse Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SuccessformboolNo

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: testapi.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">
  <BookingId>0</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>