digitaluapi

<back to all web services

InitialisePaymentRequest

namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ResponseBase() = 
        member val Status:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val Errors:Dictionary<String, List<String>> = null with get,set

    [<AllowNullLiteral>]
    type InitialisePaymentResponse() = 
        inherit ResponseBase()
        member val TransactionId:String = null with get,set
        member val Signature:String = null with get,set
        member val Url:String = null with get,set

    type PaymentTypeEnum =
        | OneTime = 1
        | Recurring = 2

    type FrequencyEnum =
        | Daily = 1
        | Weekly = 2
        | Monthly = 3
        | Quarterly = 4
        | Biannually = 5
        | Annually = 6

    [<AllowNullLiteral>]
    type InitialisePaymentRequest() = 
        member val PaymentType:PaymentTypeEnum = new PaymentTypeEnum() with get,set
        member val Uuid:Guid = new Guid() with get,set
        member val ReferenceNumber:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Currency:String = null with get,set
        member val ItemName:String = null with get,set
        member val ItemDescription:String = null with get,set
        member val BillingDate:DateTime = new DateTime() with get,set
        member val Frequency:FrequencyEnum = new FrequencyEnum() with get,set
        member val Cycles:Int32 = new Int32() with get,set

F# 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>