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 'package:servicestack/servicestack.dart';
import 'dart:collection';

class OnceOffPaymentResponse implements IConvertible
{
    String? PublicAccessGuid;
    String? InvoiceNumber;
    int? StatusCodesId;
    ResponseStatus? ResponseStatus;

    OnceOffPaymentResponse({this.PublicAccessGuid,this.InvoiceNumber,this.StatusCodesId,this.ResponseStatus});
    OnceOffPaymentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PublicAccessGuid = json['PublicAccessGuid'];
        InvoiceNumber = json['InvoiceNumber'];
        StatusCodesId = json['StatusCodesId'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PublicAccessGuid': PublicAccessGuid,
        'InvoiceNumber': InvoiceNumber,
        'StatusCodesId': StatusCodesId,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "OnceOffPaymentResponse";
    TypeContext? context = _ctx;
}

class OnceOffPaymentRequests implements IConvertible
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    String? Segment;

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    String? FirstName;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    String? LastName;

    // @DataMember(Order=4)
    String? Address;

    // @DataMember(Order=5)
    String? City;

    // @DataMember(Order=6)
    String? Region;

    // @DataMember(Order=7)
    String? Suburb;

    // @DataMember(Order=8)
    String? PostalCode;

    // @DataMember(Order=9)
    String? MobileNumber;

    // @DataMember(Order=10)
    String? Email;

    // @DataMember(Order=11)
    String? IdNumber;

    // @DataMember(Order=12)
    String? PassportNumber;

    // @DataMember(Order=13)
    // @Validate(Validator="NotNull")
    String? InvoiceNumber;

    // @DataMember(Order=14)
    DateTime? DebtDate;

    // @DataMember(Order=15)
    // @Validate(Validator="NotNull")
    double? AmountOutstanding;

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    int? CurrenciesId;

    // @DataMember(Order=17)
    // @Validate(Validator="NotNull")
    int? ChannelsId;

    // @DataMember(Order=18)
    Map<String,String?>? DebtMeta;

    // @DataMember(Order=19)
    Map<String,String?>? CustomersMeta;

    // @DataMember(Order=20)
    String? UrlToDocument;

    // @DataMember(Order=21)
    String? CustomerUniqueIdentifier;

    OnceOffPaymentRequests({this.Segment,this.FirstName,this.LastName,this.Address,this.City,this.Region,this.Suburb,this.PostalCode,this.MobileNumber,this.Email,this.IdNumber,this.PassportNumber,this.InvoiceNumber,this.DebtDate,this.AmountOutstanding,this.CurrenciesId,this.ChannelsId,this.DebtMeta,this.CustomersMeta,this.UrlToDocument,this.CustomerUniqueIdentifier});
    OnceOffPaymentRequests.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Segment = json['Segment'];
        FirstName = json['FirstName'];
        LastName = json['LastName'];
        Address = json['Address'];
        City = json['City'];
        Region = json['Region'];
        Suburb = json['Suburb'];
        PostalCode = json['PostalCode'];
        MobileNumber = json['MobileNumber'];
        Email = json['Email'];
        IdNumber = json['IdNumber'];
        PassportNumber = json['PassportNumber'];
        InvoiceNumber = json['InvoiceNumber'];
        DebtDate = JsonConverters.fromJson(json['DebtDate'],'DateTime',context!);
        AmountOutstanding = JsonConverters.toDouble(json['AmountOutstanding']);
        CurrenciesId = json['CurrenciesId'];
        ChannelsId = json['ChannelsId'];
        DebtMeta = JsonConverters.toStringMap(json['DebtMeta']);
        CustomersMeta = JsonConverters.toStringMap(json['CustomersMeta']);
        UrlToDocument = json['UrlToDocument'];
        CustomerUniqueIdentifier = json['CustomerUniqueIdentifier'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Segment': Segment,
        'FirstName': FirstName,
        'LastName': LastName,
        'Address': Address,
        'City': City,
        'Region': Region,
        'Suburb': Suburb,
        'PostalCode': PostalCode,
        'MobileNumber': MobileNumber,
        'Email': Email,
        'IdNumber': IdNumber,
        'PassportNumber': PassportNumber,
        'InvoiceNumber': InvoiceNumber,
        'DebtDate': JsonConverters.toJson(DebtDate,'DateTime',context!),
        'AmountOutstanding': AmountOutstanding,
        'CurrenciesId': CurrenciesId,
        'ChannelsId': ChannelsId,
        'DebtMeta': DebtMeta,
        'CustomersMeta': CustomersMeta,
        'UrlToDocument': UrlToDocument,
        'CustomerUniqueIdentifier': CustomerUniqueIdentifier
    };

    getTypeName() => "OnceOffPaymentRequests";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'OnceOffPaymentResponse': TypeInfo(TypeOf.Class, create:() => OnceOffPaymentResponse()),
    'OnceOffPaymentRequests': TypeInfo(TypeOf.Class, create:() => OnceOffPaymentRequests()),
});

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