| GET | /api/AutoPayInfo |
|---|
"use strict";
export class BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description This is your AIM API Key provided by Tri-Tech */
ApiKey;
/** @type {string} */
OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
/** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Token;
/** @type {string} */
DeviceId;
/** @type {string} */
AppId;
}
export class BaseResponseResult {
/** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
StatusCode;
/** @type {string} */
Login;
/** @type {string} */
ErrorCode;
/** @type {string} */
ErrorDisplayText;
/** @type {string} */
ErrorMessage;
/** @type {string} */
DomainName;
/** @type {string} */
IpAddress;
}
export class BaseResponse {
/** @param {{Status?:BaseResponseResult}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BaseResponseResult} */
Status;
}
export class CcInfo {
/** @param {{TokenStr?:string,CardType?:string,LastFour?:string,Expiration?:string,ReasonOnFile?:string,TokenPk?:number,Primary?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Token returned from processor */
TokenStr;
/**
* @type {string}
* @description Card Type (VISA, MCARD, AMEX, DSCVR) */
CardType;
/**
* @type {string}
* @description Last four of the card */
LastFour;
/**
* @type {string}
* @description Expiration Date of the Card. (MM/YY) */
Expiration;
/**
* @type {string}
* @description Reason the card is on file. */
ReasonOnFile;
/**
* @type {?number}
* @description ID of the existing Token Record in AIM, if applicable */
TokenPk;
/**
* @type {?boolean}
* @description Is this the customer's primary card? Defaults to false. */
Primary;
}
export class AchDetail {
/** @param {{Name?:string,BankNumber?:string,Routing?:string,Type?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
BankNumber;
/** @type {string} */
Routing;
/** @type {string} */
Type;
}
export class AutoPayDetail {
/** @param {{IsAutoPay?:boolean,IsAutoPayLateOnly?:boolean,AutoPayType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
IsAutoPay;
/** @type {boolean} */
IsAutoPayLateOnly;
/** @type {string} */
AutoPayType;
}
export class SchedulingInfo {
/** @param {{Description?:string,StartDate?:string,EndDate?:string,AutoPayDetail?:AutoPayDetail}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Description;
/** @type {string} */
StartDate;
/** @type {?string} */
EndDate;
/** @type {AutoPayDetail} */
AutoPayDetail;
}
export class SubAccountInfo {
/** @param {{Type?:string,Sub?:number,CardInfo?:CcInfo,AcctType?:string,AutoPayDetail?:AutoPayDetail,SchedulingRecords?:SchedulingInfo[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Type;
/** @type {number} */
Sub;
/** @type {CcInfo} */
CardInfo;
/** @type {string} */
AcctType;
/** @type {AutoPayDetail} */
AutoPayDetail;
/** @type {SchedulingInfo[]} */
SchedulingRecords;
}
export class AutoPayInfoResponse extends BaseResponse {
/** @param {{PrimaryCard?:CcInfo,AchInfo?:AchDetail,SubAccounts?:SubAccountInfo[],Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {CcInfo} */
PrimaryCard;
/** @type {AchDetail} */
AchInfo;
/** @type {SubAccountInfo[]} */
SubAccounts;
}
export class AutoPayInfoRequest extends BaseSecureRequest {
/** @param {{Acct?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
Acct;
}
JavaScript AutoPayInfoRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>