digitaluapi

OnceOffPaymentRequests

**Requires Authentication**
Required role:	Client

The following routes are available for this service:
POST	/onceoffpayment	Once of Payments

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


open class OnceOffPaymentRequests
{
    @DataMember(Order=1)
    @Validate(Validator="NotNull")
    open var Segment:String? = null

    @DataMember(Order=2)
    @Validate(Validator="NotNull")
    open var FirstName:String? = null

    @DataMember(Order=3)
    @Validate(Validator="NotNull")
    open var LastName:String? = null

    @DataMember(Order=4)
    open var Address:String? = null

    @DataMember(Order=5)
    open var City:String? = null

    @DataMember(Order=6)
    open var Region:String? = null

    @DataMember(Order=7)
    open var Suburb:String? = null

    @DataMember(Order=8)
    open var PostalCode:String? = null

    @DataMember(Order=9)
    open var MobileNumber:String? = null

    @DataMember(Order=10)
    open var Email:String? = null

    @DataMember(Order=11)
    open var IdNumber:String? = null

    @DataMember(Order=12)
    open var PassportNumber:String? = null

    @DataMember(Order=13)
    @Validate(Validator="NotNull")
    open var InvoiceNumber:String? = null

    @DataMember(Order=14)
    open var DebtDate:Date? = null

    @DataMember(Order=15)
    @Validate(Validator="NotNull")
    open var AmountOutstanding:Double? = null

    @DataMember(Order=16)
    @Validate(Validator="NotNull")
    open var CurrenciesId:Int? = null

    @DataMember(Order=17)
    @Validate(Validator="NotNull")
    open var ChannelsId:Int? = null

    @DataMember(Order=18)
    open var DebtMeta:HashMap<String,String>? = null

    @DataMember(Order=19)
    open var CustomersMeta:HashMap<String,String>? = null

    @DataMember(Order=20)
    open var UrlToDocument:String? = null

    @DataMember(Order=21)
    open var CustomerUniqueIdentifier:String? = null
}

open class OnceOffPaymentResponse
{
    open var PublicAccessGuid:UUID? = null
    open var InvoiceNumber:String? = null
    open var StatusCodesId:Long? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin OnceOffPaymentRequests 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 /onceoffpayment HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Segment: String,
	FirstName: String,
	LastName: String,
	Address: String,
	City: String,
	Region: String,
	Suburb: String,
	PostalCode: String,
	MobileNumber: String,
	Email: String,
	IdNumber: String,
	PassportNumber: String,
	InvoiceNumber: String,
	DebtDate: 0001-01-01,
	AmountOutstanding: 0,
	CurrenciesId: 0,
	ChannelsId: 0,
	DebtMeta: 
	{
		String: String
	},
	CustomersMeta: 
	{
		String: String
	},
	UrlToDocument: String,
	CustomerUniqueIdentifier: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PublicAccessGuid: 00000000000000000000000000000000,
	InvoiceNumber: String,
	StatusCodesId: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}