digitaluapi

OnceOffPaymentRequests

**Requires Authentication**
Required role:	Client

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


export class OnceOffPaymentResponse
{
    public PublicAccessGuid: string;
    public InvoiceNumber: string;
    public StatusCodesId: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<OnceOffPaymentResponse>) { (Object as any).assign(this, init); }
}

export class OnceOffPaymentRequests
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public Segment: string;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public FirstName: string;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public LastName: string;

    // @DataMember(Order=4)
    public Address: string;

    // @DataMember(Order=5)
    public City: string;

    // @DataMember(Order=6)
    public Region: string;

    // @DataMember(Order=7)
    public Suburb: string;

    // @DataMember(Order=8)
    public PostalCode: string;

    // @DataMember(Order=9)
    public MobileNumber: string;

    // @DataMember(Order=10)
    public Email: string;

    // @DataMember(Order=11)
    public IdNumber: string;

    // @DataMember(Order=12)
    public PassportNumber: string;

    // @DataMember(Order=13)
    // @Validate(Validator="NotNull")
    public InvoiceNumber: string;

    // @DataMember(Order=14)
    public DebtDate: string;

    // @DataMember(Order=15)
    // @Validate(Validator="NotNull")
    public AmountOutstanding: number;

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    public CurrenciesId: number;

    // @DataMember(Order=17)
    // @Validate(Validator="NotNull")
    public ChannelsId: number;

    // @DataMember(Order=18)
    public DebtMeta: { [index:string]: string; };

    // @DataMember(Order=19)
    public CustomersMeta: { [index:string]: string; };

    // @DataMember(Order=20)
    public UrlToDocument: string;

    // @DataMember(Order=21)
    public CustomerUniqueIdentifier: string;

    public constructor(init?: Partial<OnceOffPaymentRequests>) { (Object as any).assign(this, init); }
}

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