digitaluapi

OnceOffPaymentRequests

**Requires Authentication**
Required role:	Client

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

import Foundation
import ServiceStack

public class OnceOffPaymentRequests : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var segment:String

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var firstName:String

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var lastName:String

    // @DataMember(Order=4)
    public var address:String

    // @DataMember(Order=5)
    public var city:String

    // @DataMember(Order=6)
    public var region:String

    // @DataMember(Order=7)
    public var suburb:String

    // @DataMember(Order=8)
    public var postalCode:String

    // @DataMember(Order=9)
    public var mobileNumber:String

    // @DataMember(Order=10)
    public var email:String

    // @DataMember(Order=11)
    public var idNumber:String

    // @DataMember(Order=12)
    public var passportNumber:String

    // @DataMember(Order=13)
    // @Validate(Validator="NotNull")
    public var invoiceNumber:String

    // @DataMember(Order=14)
    public var debtDate:Date

    // @DataMember(Order=15)
    // @Validate(Validator="NotNull")
    public var amountOutstanding:Double

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    public var currenciesId:Int

    // @DataMember(Order=17)
    // @Validate(Validator="NotNull")
    public var channelsId:Int

    // @DataMember(Order=18)
    public var debtMeta:[String:String]

    // @DataMember(Order=19)
    public var customersMeta:[String:String]

    // @DataMember(Order=20)
    public var urlToDocument:String

    // @DataMember(Order=21)
    public var customerUniqueIdentifier:String

    required public init(){}
}

public class OnceOffPaymentResponse : Codable
{
    public var publicAccessGuid:String
    public var invoiceNumber:String
    public var statusCodesId:Int
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift 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>