| POST, GET | /api/GetCustomerTokens |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GetExpiredCards | body | bool? | No | |
| GetInactiveCards | body | bool? | No | |
| Acct | body | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | The Login Token return by the Security API. Required for secured calls. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerTokens | form | List<CcInfo> | No | |
| Ach | form | AchDetail | 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 | body | string | Yes | Token returned from processor |
| CardType | body | string | Yes | Card Type (VISA, MCARD, AMEX, DSCVR) |
| LastFour | body | string | Yes | Last four of the card |
| Expiration | body | string | No | Expiration Date of the Card. (MM/YY) |
| ReasonOnFile | body | string | No | Reason the card is on file. |
| TokenPk | body | integer | No | ID of the existing Token Record in AIM, if applicable |
| Primary | body | 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 |
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.
POST /api/GetCustomerTokens HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetCustomerTokensRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<OAuthToken>String</OAuthToken>
<Token>String</Token>
<Acct>0</Acct>
<GetExpiredCards>false</GetExpiredCards>
<GetInactiveCards>false</GetInactiveCards>
</GetCustomerTokensRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetCustomerTokensResponse 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>
<Ach>
<BankNumber>String</BankNumber>
<Name>String</Name>
<Routing>String</Routing>
<Type>String</Type>
</Ach>
<CustomerTokens>
<CCInfo>
<CardType>String</CardType>
<Expiration>String</Expiration>
<LastFour>String</LastFour>
<Primary>false</Primary>
<ReasonOnFile>String</ReasonOnFile>
<TokenPk>0</TokenPk>
<TokenStr>String</TokenStr>
</CCInfo>
</CustomerTokens>
</GetCustomerTokensResponse>