digitaluapi

<back to all web services

InitialisePaymentRequest

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class InitialisePaymentRequest
{
    open var PaymentType:PaymentTypeEnum? = null
    open var Uuid:UUID? = null
    open var ReferenceNumber:String? = null
    open var Amount:BigDecimal? = null
    open var Currency:String? = null
    open var ItemName:String? = null
    open var ItemDescription:String? = null
    open var BillingDate:Date? = null
    open var Frequency:FrequencyEnum? = null
    open var Cycles:Int? = null
}

enum class PaymentTypeEnum(val value:Int)
{
    OneTime(1),
    Recurring(2),
}

enum class FrequencyEnum(val value:Int)
{
    Daily(1),
    Weekly(2),
    Monthly(3),
    Quarterly(4),
    Biannually(5),
    Annually(6),
}

open class InitialisePaymentResponse : ResponseBase()
{
    open var TransactionId:String? = null
    open var Signature:String? = null
    open var Url:String? = null
}

open class ResponseBase
{
    open var Status:Boolean? = null
    open var Message:String? = null
    open var Errors:HashMap<String,ArrayList<String>>? = null
}

Kotlin InitialisePaymentRequest 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 /xml/reply/InitialisePaymentRequest HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InitialisePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Amount>0</Amount>
  <BillingDate>0001-01-01T00:00:00</BillingDate>
  <CampaignActionsRequestsId>0</CampaignActionsRequestsId>
  <Currency>String</Currency>
  <Cycles>0</Cycles>
  <Frequency>Daily</Frequency>
  <ItemDescription>String</ItemDescription>
  <ItemName>String</ItemName>
  <PaymentType>OneTime</PaymentType>
  <ReferenceNumber>String</ReferenceNumber>
  <Uuid>00000000-0000-0000-0000-000000000000</Uuid>
</InitialisePaymentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InitialisePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>String</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </Errors>
  <Message>String</Message>
  <Status>false</Status>
  <Signature>String</Signature>
  <TransactionId>String</TransactionId>
  <Url>String</Url>
</InitialisePaymentResponse>