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 Foundation
import ServiceStack

/**
* AutoPayInfoRequires active-e Customer Service.
*/
// @DataContract
public class AutoPayInfoRequest : BaseSecureRequest
{
    // @DataMember
    public var acct:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case acct
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        acct = try container.decodeIfPresent(Int.self, forKey: .acct)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if acct != nil { try container.encode(acct, forKey: .acct) }
    }
}

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

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

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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")
    public var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class AutoPayInfoResponse : BaseResponse
{
    // @DataMember
    public var primaryCard:CcInfo

    // @DataMember
    public var achInfo:AchDetail

    // @DataMember
    public var subAccounts:[SubAccountInfo] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case primaryCard
        case achInfo
        case subAccounts
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        primaryCard = try container.decodeIfPresent(CcInfo.self, forKey: .primaryCard)
        achInfo = try container.decodeIfPresent(AchDetail.self, forKey: .achInfo)
        subAccounts = try container.decodeIfPresent([SubAccountInfo].self, forKey: .subAccounts) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if primaryCard != nil { try container.encode(primaryCard, forKey: .primaryCard) }
        if achInfo != nil { try container.encode(achInfo, forKey: .achInfo) }
        if subAccounts.count > 0 { try container.encode(subAccounts, forKey: .subAccounts) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

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

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

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

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

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

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

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

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

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

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

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

    /**
    * 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")
    public var tokenPk:Int?

    /**
    * 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")
    public var primary:Bool?

    required public init(){}
}

// @DataContract
public class AchDetail : Codable
{
    // @DataMember
    public var name:String

    // @DataMember
    public var bankNumber:String

    // @DataMember
    public var routing:String

    // @DataMember
    public var type:String

    required public init(){}
}

// @DataContract
public class SubAccountInfo : Codable
{
    // @DataMember
    public var type:String

    // @DataMember
    public var sub:Int

    // @DataMember
    public var cardInfo:CcInfo

    // @DataMember
    public var acctType:String

    // @DataMember
    public var autoPayDetail:AutoPayDetail

    // @DataMember
    public var schedulingRecords:[SchedulingInfo] = []

    required public init(){}
}

// @DataContract
public class AutoPayDetail : Codable
{
    // @DataMember
    public var isAutoPay:Bool

    // @DataMember
    public var isAutoPayLateOnly:Bool

    // @DataMember
    public var autoPayType:String

    required public init(){}
}

// @DataContract
public class SchedulingInfo : Codable
{
    // @DataMember
    public var Description:String

    // @DataMember
    public var startDate:Date

    // @DataMember
    public var endDate:Date?

    // @DataMember
    public var autoPayDetail:AutoPayDetail

    required public init(){}
}

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