digitaluapi

OnceOffPaymentRequests

**Requires Authentication**
Required role:	Client

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

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 Partial Class OnceOffPaymentRequests
            <DataMember(Order:=1)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Segment As String

            <DataMember(Order:=2)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property FirstName As String

            <DataMember(Order:=3)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property LastName As String

            <DataMember(Order:=4)>
            Public Overridable Property Address As String

            <DataMember(Order:=5)>
            Public Overridable Property City As String

            <DataMember(Order:=6)>
            Public Overridable Property Region As String

            <DataMember(Order:=7)>
            Public Overridable Property Suburb As String

            <DataMember(Order:=8)>
            Public Overridable Property PostalCode As String

            <DataMember(Order:=9)>
            Public Overridable Property MobileNumber As String

            <DataMember(Order:=10)>
            Public Overridable Property Email As String

            <DataMember(Order:=11)>
            Public Overridable Property IdNumber As String

            <DataMember(Order:=12)>
            Public Overridable Property PassportNumber As String

            <DataMember(Order:=13)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property InvoiceNumber As String

            <DataMember(Order:=14)>
            Public Overridable Property DebtDate As Date

            <DataMember(Order:=15)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property AmountOutstanding As Double

            <DataMember(Order:=16)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property CurrenciesId As Integer

            <DataMember(Order:=17)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property ChannelsId As Integer

            <DataMember(Order:=18)>
            Public Overridable Property DebtMeta As Dictionary(Of String, String)

            <DataMember(Order:=19)>
            Public Overridable Property CustomersMeta As Dictionary(Of String, String)

            <DataMember(Order:=20)>
            Public Overridable Property UrlToDocument As String

            <DataMember(Order:=21)>
            Public Overridable Property CustomerUniqueIdentifier As String
        End Class

        Public Partial Class OnceOffPaymentResponse
            Public Overridable Property PublicAccessGuid As Guid
            Public Overridable Property InvoiceNumber As String
            Public Overridable Property StatusCodesId As Long
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET OnceOffPaymentRequests DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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-01T00:00:00.0000000","AmountOutstanding":0,"CurrenciesId":0,"ChannelsId":0,"DebtMeta":{"String":"String"},"CustomersMeta":{"String":"String"},"UrlToDocument":"String","CustomerUniqueIdentifier":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}