digitaluapi

<back to all web services

OnceOffPaymentRequests

Requires Authentication
Required role:Client
The following routes are available for this service:
POST/onceoffpaymentOnce of Payments
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class OnceOffPaymentRequests
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public String Segment = null;

        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public String FirstName = null;

        @DataMember(Order=3)
        @Validate(Validator="NotNull")
        public String LastName = null;

        @DataMember(Order=4)
        public String Address = null;

        @DataMember(Order=5)
        public String City = null;

        @DataMember(Order=6)
        public String Region = null;

        @DataMember(Order=7)
        public String Suburb = null;

        @DataMember(Order=8)
        public String PostalCode = null;

        @DataMember(Order=9)
        public String MobileNumber = null;

        @DataMember(Order=10)
        public String Email = null;

        @DataMember(Order=11)
        public String IdNumber = null;

        @DataMember(Order=12)
        public String PassportNumber = null;

        @DataMember(Order=13)
        @Validate(Validator="NotNull")
        public String InvoiceNumber = null;

        @DataMember(Order=14)
        public Date DebtDate = null;

        @DataMember(Order=15)
        @Validate(Validator="NotNull")
        public Double AmountOutstanding = null;

        @DataMember(Order=16)
        @Validate(Validator="NotNull")
        public Integer CurrenciesId = null;

        @DataMember(Order=17)
        @Validate(Validator="NotNull")
        public Integer ChannelsId = null;

        @DataMember(Order=18)
        public HashMap<String,String> DebtMeta = null;

        @DataMember(Order=19)
        public HashMap<String,String> CustomersMeta = null;

        @DataMember(Order=20)
        public String UrlToDocument = null;

        @DataMember(Order=21)
        public String CustomerUniqueIdentifier = null;
        
        public String getSegment() { return Segment; }
        public OnceOffPaymentRequests setSegment(String value) { this.Segment = value; return this; }
        public String getFirstName() { return FirstName; }
        public OnceOffPaymentRequests setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public OnceOffPaymentRequests setLastName(String value) { this.LastName = value; return this; }
        public String getAddress() { return Address; }
        public OnceOffPaymentRequests setAddress(String value) { this.Address = value; return this; }
        public String getCity() { return City; }
        public OnceOffPaymentRequests setCity(String value) { this.City = value; return this; }
        public String getRegion() { return Region; }
        public OnceOffPaymentRequests setRegion(String value) { this.Region = value; return this; }
        public String getSuburb() { return Suburb; }
        public OnceOffPaymentRequests setSuburb(String value) { this.Suburb = value; return this; }
        public String getPostalCode() { return PostalCode; }
        public OnceOffPaymentRequests setPostalCode(String value) { this.PostalCode = value; return this; }
        public String getMobileNumber() { return MobileNumber; }
        public OnceOffPaymentRequests setMobileNumber(String value) { this.MobileNumber = value; return this; }
        public String getEmail() { return Email; }
        public OnceOffPaymentRequests setEmail(String value) { this.Email = value; return this; }
        public String getIdNumber() { return IdNumber; }
        public OnceOffPaymentRequests setIdNumber(String value) { this.IdNumber = value; return this; }
        public String getPassportNumber() { return PassportNumber; }
        public OnceOffPaymentRequests setPassportNumber(String value) { this.PassportNumber = value; return this; }
        public String getInvoiceNumber() { return InvoiceNumber; }
        public OnceOffPaymentRequests setInvoiceNumber(String value) { this.InvoiceNumber = value; return this; }
        public Date getDebtDate() { return DebtDate; }
        public OnceOffPaymentRequests setDebtDate(Date value) { this.DebtDate = value; return this; }
        public Double getAmountOutstanding() { return AmountOutstanding; }
        public OnceOffPaymentRequests setAmountOutstanding(Double value) { this.AmountOutstanding = value; return this; }
        public Integer getCurrenciesId() { return CurrenciesId; }
        public OnceOffPaymentRequests setCurrenciesId(Integer value) { this.CurrenciesId = value; return this; }
        public Integer getChannelsId() { return ChannelsId; }
        public OnceOffPaymentRequests setChannelsId(Integer value) { this.ChannelsId = value; return this; }
        public HashMap<String,String> getDebtMeta() { return DebtMeta; }
        public OnceOffPaymentRequests setDebtMeta(HashMap<String,String> value) { this.DebtMeta = value; return this; }
        public HashMap<String,String> getCustomersMeta() { return CustomersMeta; }
        public OnceOffPaymentRequests setCustomersMeta(HashMap<String,String> value) { this.CustomersMeta = value; return this; }
        public String getUrlToDocument() { return UrlToDocument; }
        public OnceOffPaymentRequests setUrlToDocument(String value) { this.UrlToDocument = value; return this; }
        public String getCustomerUniqueIdentifier() { return CustomerUniqueIdentifier; }
        public OnceOffPaymentRequests setCustomerUniqueIdentifier(String value) { this.CustomerUniqueIdentifier = value; return this; }
    }

    public static class OnceOffPaymentResponse
    {
        public UUID PublicAccessGuid = null;
        public String InvoiceNumber = null;
        public Long StatusCodesId = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getPublicAccessGuid() { return PublicAccessGuid; }
        public OnceOffPaymentResponse setPublicAccessGuid(UUID value) { this.PublicAccessGuid = value; return this; }
        public String getInvoiceNumber() { return InvoiceNumber; }
        public OnceOffPaymentResponse setInvoiceNumber(String value) { this.InvoiceNumber = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public OnceOffPaymentResponse setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public OnceOffPaymentResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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