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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* AutoPayInfoRequires active-e Customer Service.
*/
@DataContract
open class AutoPayInfoRequest : BaseSecureRequest()
{
    @DataMember
    var Acct:Int? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

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

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

@DataContract
open class BaseRequest
{
    /**
    * 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class AutoPayInfoResponse : BaseResponse()
{
    @DataMember
    var PrimaryCard:CcInfo? = null

    @DataMember
    var AchInfo:AchDetail? = null

    @DataMember
    var SubAccounts:ArrayList<SubAccountInfo> = ArrayList<SubAccountInfo>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

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

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

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

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

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

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

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

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

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

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

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

    /**
    * 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")
    var TokenPk:Long? = null

    /**
    * 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")
    var Primary:Boolean? = null
}

@DataContract
open class AchDetail
{
    @DataMember
    var Name:String? = null

    @DataMember
    var BankNumber:String? = null

    @DataMember
    var Routing:String? = null

    @DataMember
    var Type:String? = null
}

@DataContract
open class SubAccountInfo
{
    @DataMember
    var Type:String? = null

    @DataMember
    var Sub:Int? = null

    @DataMember
    var CardInfo:CcInfo? = null

    @DataMember
    var AcctType:String? = null

    @DataMember
    var AutoPayDetail:AutoPayDetail? = null

    @DataMember
    var SchedulingRecords:ArrayList<SchedulingInfo> = ArrayList<SchedulingInfo>()
}

@DataContract
open class AutoPayDetail
{
    @DataMember
    var IsAutoPay:Boolean? = null

    @DataMember
    var IsAutoPayLateOnly:Boolean? = null

    @DataMember
    var AutoPayType:String? = null
}

@DataContract
open class SchedulingInfo
{
    @DataMember
    var Description:String? = null

    @DataMember
    var StartDate:Date? = null

    @DataMember
    var EndDate:Date? = null

    @DataMember
    var AutoPayDetail:AutoPayDetail? = null
}

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