digitaluapi

<back to all web services

OnceOffPaymentRequests

Requires Authentication
Required role:Client
The following routes are available for this service:
POST/onceoffpaymentOnce of Payments
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 OnceOffPaymentResponse() = 
        member val PublicAccessGuid:Guid = new Guid() with get,set
        member val InvoiceNumber:String = null with get,set
        member val StatusCodesId:Int64 = new Int64() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type OnceOffPaymentRequests() = 
        [<DataMember(Order=1)>]
        [<Validate(Validator="NotNull")>]
        member val Segment:String = null with get,set

        [<DataMember(Order=2)>]
        [<Validate(Validator="NotNull")>]
        member val FirstName:String = null with get,set

        [<DataMember(Order=3)>]
        [<Validate(Validator="NotNull")>]
        member val LastName:String = null with get,set

        [<DataMember(Order=4)>]
        member val Address:String = null with get,set

        [<DataMember(Order=5)>]
        member val City:String = null with get,set

        [<DataMember(Order=6)>]
        member val Region:String = null with get,set

        [<DataMember(Order=7)>]
        member val Suburb:String = null with get,set

        [<DataMember(Order=8)>]
        member val PostalCode:String = null with get,set

        [<DataMember(Order=9)>]
        member val MobileNumber:String = null with get,set

        [<DataMember(Order=10)>]
        member val Email:String = null with get,set

        [<DataMember(Order=11)>]
        member val IdNumber:String = null with get,set

        [<DataMember(Order=12)>]
        member val PassportNumber:String = null with get,set

        [<DataMember(Order=13)>]
        [<Validate(Validator="NotNull")>]
        member val InvoiceNumber:String = null with get,set

        [<DataMember(Order=14)>]
        member val DebtDate:DateTime = new DateTime() with get,set

        [<DataMember(Order=15)>]
        [<Validate(Validator="NotNull")>]
        member val AmountOutstanding:Double = new Double() with get,set

        [<DataMember(Order=16)>]
        [<Validate(Validator="NotNull")>]
        member val CurrenciesId:Int32 = new Int32() with get,set

        [<DataMember(Order=17)>]
        [<Validate(Validator="NotNull")>]
        member val ChannelsId:Int32 = new Int32() with get,set

        [<DataMember(Order=18)>]
        member val DebtMeta:Dictionary<String, String> = null with get,set

        [<DataMember(Order=19)>]
        member val CustomersMeta:Dictionary<String, String> = null with get,set

        [<DataMember(Order=20)>]
        member val UrlToDocument:String = null with get,set

        [<DataMember(Order=21)>]
        member val CustomerUniqueIdentifier:String = null with get,set

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