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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using QvicklyIntegration.Models.Payment;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class IpnCallBackResponse
    {
        public virtual string Message { get; set; }
        public virtual bool Success { get; set; }
    }

    public partial class QvicklyCheckoutIpnCallBack
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Internal reference id (Could be booking, could be Article..)
        ///</summary>
        [ApiMember(Description="Internal reference id (Could be booking, could be Article..)")]
        public virtual string BookingId { get; set; }

        ///<summary>
        ///The payment ipn callback data.
        ///</summary>
        [ApiMember(Description="The payment ipn callback data.")]
        public virtual QvicklyIpnCallbackResponseData data { get; set; }

        ///<summary>
        ///Article type (Could be Service, rebate code types, etc..
        ///</summary>
        [ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)]
        public virtual int ArticleTypeId { get; set; }
    }

}

namespace QvicklyIntegration.Models.Payment
{
    public partial class QvicklyIpnCallbackResponseData
    {
        public virtual string number { get; set; }
        public virtual string status { get; set; }
        public virtual string orderid { get; set; }
        public virtual string url { get; set; }
    }

}

C# 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.bookmore.com 
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>
  <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>