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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract(Name="CCInfo")>]
    [<AllowNullLiteral>]
    type CcInfo() = 
        ///<summary>
        ///Token returned from processor
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")>]
        member val TokenStr:String = null with 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")>]
        member val CardType:String = null with 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")>]
        member val LastFour:String = null with 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")>]
        member val Expiration:String = null with 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")>]
        member val ReasonOnFile:String = null with 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")>]
        member val TokenPk:Nullable<Int64> = new Nullable<Int64>() with 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")>]
        member val Primary:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AchDetail() = 
        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val BankNumber:String = null with get,set

        [<DataMember>]
        member val Routing:String = null with get,set

        [<DataMember>]
        member val Type:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AutoPayDetail() = 
        [<DataMember>]
        member val IsAutoPay:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsAutoPayLateOnly:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val AutoPayType:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SchedulingInfo() = 
        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val StartDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val AutoPayDetail:AutoPayDetail = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SubAccountInfo() = 
        [<DataMember>]
        member val Type:String = null with get,set

        [<DataMember>]
        member val Sub:Int32 = new Int32() with get,set

        [<DataMember>]
        member val CardInfo:CcInfo = null with get,set

        [<DataMember>]
        member val AcctType:String = null with get,set

        [<DataMember>]
        member val AutoPayDetail:AutoPayDetail = null with get,set

        [<DataMember>]
        member val SchedulingRecords:ResizeArray<SchedulingInfo> = new ResizeArray<SchedulingInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AutoPayInfoResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val PrimaryCard:CcInfo = null with get,set

        [<DataMember>]
        member val AchInfo:AchDetail = null with get,set

        [<DataMember>]
        member val SubAccounts:ResizeArray<SubAccountInfo> = new ResizeArray<SubAccountInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///AutoPayInfoRequires active-e Customer Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type AutoPayInfoRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set

F# 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>