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

<OnceOffPaymentRequests xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Address>String</Address>
  <AmountOutstanding>0</AmountOutstanding>
  <ChannelsId>0</ChannelsId>
  <City>String</City>
  <CurrenciesId>0</CurrenciesId>
  <CustomerUniqueIdentifier>String</CustomerUniqueIdentifier>
  <CustomersMeta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CustomersMeta>
  <DebtDate>0001-01-01T00:00:00</DebtDate>
  <DebtMeta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </DebtMeta>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <IdNumber>String</IdNumber>
  <InvoiceNumber>String</InvoiceNumber>
  <LastName>String</LastName>
  <MobileNumber>String</MobileNumber>
  <PassportNumber>String</PassportNumber>
  <PostalCode>String</PostalCode>
  <Region>String</Region>
  <Segment>String</Segment>
  <Suburb>String</Suburb>
  <UrlToDocument>String</UrlToDocument>
</OnceOffPaymentRequests>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OnceOffPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <InvoiceNumber>String</InvoiceNumber>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StatusCodesId>0</StatusCodesId>
</OnceOffPaymentResponse>