AIM Web Services

<back to all web services

AutoPayInfoRequest

AutoPayInfo
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/AutoPayInfo
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class AchDetail
    {
        [DataMember]
        public virtual string Name { get; set; }

        [DataMember]
        public virtual string BankNumber { get; set; }

        [DataMember]
        public virtual string Routing { get; set; }

        [DataMember]
        public virtual string Type { get; set; }
    }

    [DataContract]
    public partial class AutoPayDetail
    {
        [DataMember]
        public virtual bool IsAutoPay { get; set; }

        [DataMember]
        public virtual bool IsAutoPayLateOnly { get; set; }

        [DataMember]
        public virtual string AutoPayType { get; set; }
    }

    ///<summary>
    ///AutoPayInfoRequires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class AutoPayInfoRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual int? Acct { get; set; }
    }

    [DataContract]
    public partial class AutoPayInfoResponse
        : BaseResponse
    {
        public AutoPayInfoResponse()
        {
            SubAccounts = new List<SubAccountInfo>{};
        }

        [DataMember]
        public virtual CcInfo PrimaryCard { get; set; }

        [DataMember]
        public virtual AchDetail AchInfo { get; set; }

        [DataMember]
        public virtual List<SubAccountInfo> SubAccounts { get; set; }
    }

    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract(Name="CCInfo")]
    public partial class CcInfo
    {
        ///<summary>
        ///Token returned from processor
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")]
        public virtual string TokenStr { get; set; }

        ///<summary>
        ///Card Type (VISA, MCARD, AMEX, DSCVR)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")]
        public virtual string CardType { get; set; }

        ///<summary>
        ///Last four of the card
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")]
        public virtual string LastFour { get; set; }

        ///<summary>
        ///Expiration Date of the Card. (MM/YY)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")]
        public virtual string Expiration { get; set; }

        ///<summary>
        ///Reason the card is on file.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")]
        public virtual string ReasonOnFile { get; set; }

        ///<summary>
        ///ID of the existing Token Record in AIM, if applicable
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")]
        public virtual long? TokenPk { get; set; }

        ///<summary>
        ///Is this the customer's primary card? Defaults to false.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")]
        public virtual bool? Primary { get; set; }
    }

    [DataContract]
    public partial class SchedulingInfo
    {
        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual DateTime StartDate { get; set; }

        [DataMember]
        public virtual DateTime? EndDate { get; set; }

        [DataMember]
        public virtual AutoPayDetail AutoPayDetail { get; set; }
    }

    [DataContract]
    public partial class SubAccountInfo
    {
        public SubAccountInfo()
        {
            SchedulingRecords = new List<SchedulingInfo>{};
        }

        [DataMember]
        public virtual string Type { get; set; }

        [DataMember]
        public virtual int Sub { get; set; }

        [DataMember]
        public virtual CcInfo CardInfo { get; set; }

        [DataMember]
        public virtual string AcctType { get; set; }

        [DataMember]
        public virtual AutoPayDetail AutoPayDetail { get; set; }

        [DataMember]
        public virtual List<SchedulingInfo> SchedulingRecords { get; set; }
    }

}

C# AutoPayInfoRequest 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.

GET /api/AutoPayInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<AutoPayInfoResponse 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>
  <AchInfo>
    <BankNumber>String</BankNumber>
    <Name>String</Name>
    <Routing>String</Routing>
    <Type>String</Type>
  </AchInfo>
  <PrimaryCard>
    <CardType>String</CardType>
    <Expiration>String</Expiration>
    <LastFour>String</LastFour>
    <Primary>false</Primary>
    <ReasonOnFile>String</ReasonOnFile>
    <TokenPk>0</TokenPk>
    <TokenStr>String</TokenStr>
  </PrimaryCard>
  <SubAccounts>
    <SubAccountInfo>
      <AcctType>String</AcctType>
      <AutoPayDetail>
        <AutoPayType>String</AutoPayType>
        <IsAutoPay>false</IsAutoPay>
        <IsAutoPayLateOnly>false</IsAutoPayLateOnly>
      </AutoPayDetail>
      <CardInfo>
        <CardType>String</CardType>
        <Expiration>String</Expiration>
        <LastFour>String</LastFour>
        <Primary>false</Primary>
        <ReasonOnFile>String</ReasonOnFile>
        <TokenPk>0</TokenPk>
        <TokenStr>String</TokenStr>
      </CardInfo>
      <SchedulingRecords>
        <SchedulingInfo>
          <AutoPayDetail>
            <AutoPayType>String</AutoPayType>
            <IsAutoPay>false</IsAutoPay>
            <IsAutoPayLateOnly>false</IsAutoPayLateOnly>
          </AutoPayDetail>
          <Description>String</Description>
          <EndDate>0001-01-01T00:00:00</EndDate>
          <StartDate>0001-01-01T00:00:00</StartDate>
        </SchedulingInfo>
      </SchedulingRecords>
      <Sub>0</Sub>
      <Type>String</Type>
    </SubAccountInfo>
  </SubAccounts>
</AutoPayInfoResponse>