AIM Web Services

AutoPayInfoRequest

AutoPayInfo
Requires active-e Customer Service.

The following routes are available for this service:
GET	/api/AutoPayInfo

**AutoPayInfoRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Acct	query	int?	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**AutoPayInfoResponse** Parameters:
Name	Parameter	Data Type	Required
PrimaryCard	form	CcInfo	No
AchInfo	form	AchDetail	No
SubAccounts	form	List<SubAccountInfo>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**CcInfo** Parameters:
Name	Parameter	Data Type	Required	Description
TokenStr	query	string	Yes	Token returned from processor
CardType	query	string	Yes	Card Type (VISA, MCARD, AMEX, DSCVR)
LastFour	query	string	Yes	Last four of the card
Expiration	query	string	No	Expiration Date of the Card. (MM/YY)
ReasonOnFile	query	string	No	Reason the card is on file.
TokenPk	query	integer	No	ID of the existing Token Record in AIM, if applicable
Primary	query	boolean	No	Is this the customer's primary card? Defaults to false.

**AchDetail** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
BankNumber	form	string	No
Routing	form	string	No
Type	form	string	No

**SubAccountInfo** Parameters:
Name	Parameter	Data Type	Required
Type	form	string	No
Sub	form	int	No
CardInfo	form	CcInfo	No
AcctType	form	string	No
AutoPayDetail	form	AutoPayDetail	No
SchedulingRecords	form	List<SchedulingInfo>	No

**AutoPayDetail** Parameters:
Name	Parameter	Data Type	Required
IsAutoPay	form	bool	No
IsAutoPayLateOnly	form	bool	No
AutoPayType	form	string	No

**SchedulingInfo** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
StartDate	form	DateTime	No
EndDate	form	DateTime?	No
AutoPayDetail	form	AutoPayDetail	No

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>

AIM Web Services

AutoPayInfoRequest

AutoPayInfo Requires active-e Customer Service.

HTTP + XML

AutoPayInfo
Requires active-e Customer Service.