AIM Web Services

<back to all web services

CreateAePayRecordRequest

CreateAEPayRecord
Requires active-e Customer Service.

The following routes are available for this service:
POST, GET/api/CreateAEPayRecord
import 'package:servicestack/servicestack.dart';

// @DataContract
class BaseRequest implements IConvertible
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    String? ApiKey;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    String? OAuthToken;

    BaseRequest({this.ApiKey,this.OAuthToken});
    BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        OAuthToken = json['OAuthToken'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'OAuthToken': OAuthToken
    };

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

// @DataContract
class BaseSecureRequest extends BaseRequest implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    String? Token;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    String? DeviceId;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    String? AppId;

    BaseSecureRequest({this.Token,this.DeviceId,this.AppId});
    BaseSecureRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Token = json['Token'];
        DeviceId = json['DeviceId'];
        AppId = json['AppId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Token': Token,
        'DeviceId': DeviceId,
        'AppId': AppId
    });

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

// @DataContract
class BaseResponseResult implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    String? StatusCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    String? Login;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    String? ErrorCode;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    String? ErrorDisplayText;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    String? ErrorMessage;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    String? DomainName;

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    String? IpAddress;

    BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
    BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StatusCode = json['StatusCode'];
        Login = json['Login'];
        ErrorCode = json['ErrorCode'];
        ErrorDisplayText = json['ErrorDisplayText'];
        ErrorMessage = json['ErrorMessage'];
        DomainName = json['DomainName'];
        IpAddress = json['IpAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StatusCode': StatusCode,
        'Login': Login,
        'ErrorCode': ErrorCode,
        'ErrorDisplayText': ErrorDisplayText,
        'ErrorMessage': ErrorMessage,
        'DomainName': DomainName,
        'IpAddress': IpAddress
    };

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

// @DataContract
class BaseResponse implements IConvertible
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    BaseResponseResult? Status;

    BaseResponse({this.Status});
    BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
    };

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

// @DataContract
class CreateAePayRecordResponse extends BaseResponse implements IConvertible
{
    CreateAePayRecordResponse();
    CreateAePayRecordResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "CreateAePayRecordResponse";
    TypeContext? context = _ctx;
}

// @DataContract(Name="Payment")
class Payment implements IConvertible
{
    // @DataMember
    String? Ref;

    // @DataMember
    String? WebRef;

    // @DataMember
    double? Amount;

    // @DataMember
    DateTime? Date;

    Payment({this.Ref,this.WebRef,this.Amount,this.Date});
    Payment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Ref = json['Ref'];
        WebRef = json['WebRef'];
        Amount = JsonConverters.toDouble(json['Amount']);
        Date = JsonConverters.fromJson(json['Date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Ref': Ref,
        'WebRef': WebRef,
        'Amount': Amount,
        'Date': JsonConverters.toJson(Date,'DateTime',context!)
    };

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

// @DataContract(Name="CCInfo")
class CcInfo implements IConvertible
{
    /**
    * Token returned from processor
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
    String? TokenStr;

    /**
    * Card Type (VISA, MCARD, AMEX, DSCVR)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
    String? CardType;

    /**
    * Last four of the card
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
    String? LastFour;

    /**
    * Expiration Date of the Card. (MM/YY)
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
    String? Expiration;

    /**
    * Reason the card is on file.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    String? ReasonOnFile;

    /**
    * ID of the existing Token Record in AIM, if applicable
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
    int? TokenPk;

    /**
    * Is this the customer's primary card? Defaults to false.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
    bool? Primary;

    CcInfo({this.TokenStr,this.CardType,this.LastFour,this.Expiration,this.ReasonOnFile,this.TokenPk,this.Primary});
    CcInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TokenStr = json['TokenStr'];
        CardType = json['CardType'];
        LastFour = json['LastFour'];
        Expiration = json['Expiration'];
        ReasonOnFile = json['ReasonOnFile'];
        TokenPk = json['TokenPk'];
        Primary = json['Primary'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TokenStr': TokenStr,
        'CardType': CardType,
        'LastFour': LastFour,
        'Expiration': Expiration,
        'ReasonOnFile': ReasonOnFile,
        'TokenPk': TokenPk,
        'Primary': Primary
    };

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

/**
* CreateAEPayRecordRequires active-e Customer Service.
*/
// @DataContract
class CreateAePayRecordRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    List<Payment>? Payments;

    // @DataMember
    int? WebId;

    // @DataMember
    String? PayRef;

    // @DataMember
    String? Approval;

    // @DataMember
    bool? UpdateCc;

    // @DataMember
    String? CcName;

    // @DataMember
    CcInfo? CardInfo;

    // @DataMember
    int? Acct;

    CreateAePayRecordRequest({this.Payments,this.WebId,this.PayRef,this.Approval,this.UpdateCc,this.CcName,this.CardInfo,this.Acct});
    CreateAePayRecordRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Payments = JsonConverters.fromJson(json['Payments'],'List<Payment>',context!);
        WebId = json['WebId'];
        PayRef = json['PayRef'];
        Approval = json['Approval'];
        UpdateCc = json['UpdateCc'];
        CcName = json['CcName'];
        CardInfo = JsonConverters.fromJson(json['CardInfo'],'CcInfo',context!);
        Acct = json['Acct'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Payments': JsonConverters.toJson(Payments,'List<Payment>',context!),
        'WebId': WebId,
        'PayRef': PayRef,
        'Approval': Approval,
        'UpdateCc': UpdateCc,
        'CcName': CcName,
        'CardInfo': JsonConverters.toJson(CardInfo,'CcInfo',context!),
        'Acct': Acct
    });

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

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseSecureRequest': TypeInfo(TypeOf.Class, create:() => BaseSecureRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'CreateAePayRecordResponse': TypeInfo(TypeOf.Class, create:() => CreateAePayRecordResponse()),
    'Payment': TypeInfo(TypeOf.Class, create:() => Payment()),
    'CcInfo': TypeInfo(TypeOf.Class, create:() => CcInfo()),
    'CreateAePayRecordRequest': TypeInfo(TypeOf.Class, create:() => CreateAePayRecordRequest()),
    'List<Payment>': TypeInfo(TypeOf.Class, create:() => <Payment>[]),
});

Dart CreateAePayRecordRequest 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 /api/CreateAEPayRecord HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateAePayRecordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Acct>0</Acct>
  <Approval>String</Approval>
  <CardInfo>
    <CardType>String</CardType>
    <Expiration>String</Expiration>
    <LastFour>String</LastFour>
    <Primary>false</Primary>
    <ReasonOnFile>String</ReasonOnFile>
    <TokenPk>0</TokenPk>
    <TokenStr>String</TokenStr>
  </CardInfo>
  <CcName>String</CcName>
  <PayRef>String</PayRef>
  <Payments>
    <Payment>
      <Amount>0</Amount>
      <Date>0001-01-01T00:00:00</Date>
      <Ref>String</Ref>
      <WebRef>String</WebRef>
    </Payment>
  </Payments>
  <UpdateCc>false</UpdateCc>
  <WebId>0</WebId>
</CreateAePayRecordRequest>

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

<CreateAePayRecordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
</CreateAePayRecordResponse>