digitaluapi

<back to all web services

InitialisePaymentRequest

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Enum FrequencyEnum
            Daily = 1
            Weekly = 2
            Monthly = 3
            Quarterly = 4
            Biannually = 5
            Annually = 6
        End Enum

        Public Partial Class InitialisePaymentRequest
            Public Overridable Property PaymentType As PaymentTypeEnum
            Public Overridable Property Uuid As Guid
            Public Overridable Property ReferenceNumber As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property Currency As String
            Public Overridable Property ItemName As String
            Public Overridable Property ItemDescription As String
            Public Overridable Property BillingDate As Date
            Public Overridable Property Frequency As FrequencyEnum
            Public Overridable Property Cycles As Integer
        End Class

        Public Partial Class InitialisePaymentResponse
            Inherits ResponseBase
            Public Overridable Property TransactionId As String
            Public Overridable Property Signature As String
            Public Overridable Property Url As String
        End Class

        Public Enum PaymentTypeEnum
            OneTime = 1
            Recurring = 2
        End Enum

        Public Partial Class ResponseBase
            Public Overridable Property Status As Boolean
            Public Overridable Property Message As String
            Public Overridable Property Errors As Dictionary(Of String, List(Of String))
        End Class
    End Namespace
End Namespace

VB.NET InitialisePaymentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/InitialisePaymentRequest HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PaymentType: OneTime,
	Uuid: 00000000000000000000000000000000,
	ReferenceNumber: String,
	Amount: 0,
	Currency: String,
	ItemName: String,
	ItemDescription: String,
	BillingDate: 0001-01-01,
	Frequency: Daily,
	Cycles: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TransactionId: String,
	Signature: String,
	Url: String,
	Status: False,
	Message: String,
	Errors: 
	{
		String: 
		[
			String
		]
	}
}