| GET | /api/AutoPayInfo |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Acct | query | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PrimaryCard | form | CcInfo | No | |
| AchInfo | form | AchDetail | No | |
| SubAccounts | form | List<SubAccountInfo> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| BankNumber | form | string | No | |
| Routing | form | string | No | |
| Type | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsAutoPay | form | bool | No | |
| IsAutoPayLateOnly | form | bool | No | |
| AutoPayType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"PrimaryCard":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"AchInfo":{"Name":"String","BankNumber":"String","Routing":"String","Type":"String"},"SubAccounts":[{"Type":"String","Sub":0,"CardInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"AcctType":"String","AutoPayDetail":{"IsAutoPay":false,"IsAutoPayLateOnly":false,"AutoPayType":"String"},"SchedulingRecords":[{"Description":"String","EndDate":"0001-01-01T00:00:00.0000000","AutoPayDetail":{"IsAutoPay":false,"IsAutoPayLateOnly":false,"AutoPayType":"String"}}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}