AIM Web Services

<back to all web services

GetCustomerTokensRequest

GetCustomerTokens
Requires active-e Customer Service.

The following routes are available for this service:
POST, GET/api/GetCustomerTokens

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CCInfo")
export class CcInfo
{
    /** @description Token returned from processor */
    // @DataMember
    // @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
    public TokenStr: string;

    /** @description Card Type (VISA, MCARD, AMEX, DSCVR) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
    public CardType: string;

    /** @description Last four of the card */
    // @DataMember
    // @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
    public LastFour: string;

    /** @description Expiration Date of the Card. (MM/YY) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
    public Expiration: string;

    /** @description Reason the card is on file. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    public ReasonOnFile: string;

    /** @description ID of the existing Token Record in AIM, if applicable */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
    public TokenPk?: number;

    /** @description Is this the customer's primary card? Defaults to false. */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
    public Primary?: boolean;

    public constructor(init?: Partial<CcInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AchDetail
{
    // @DataMember
    public Name: string;

    // @DataMember
    public BankNumber: string;

    // @DataMember
    public Routing: string;

    // @DataMember
    public Type: string;

    public constructor(init?: Partial<AchDetail>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetCustomerTokensResponse extends BaseResponse
{
    // @DataMember
    public CustomerTokens: CcInfo[];

    // @DataMember
    public Ach: AchDetail;

    public constructor(init?: Partial<GetCustomerTokensResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description GetCustomerTokensRequires active-e Customer Service. */
// @DataContract
export class GetCustomerTokensRequest extends BaseSecureRequest
{
    // @DataMember
    public GetExpiredCards?: boolean;

    // @DataMember
    public GetInactiveCards?: boolean;

    // @DataMember
    public Acct?: number;

    public constructor(init?: Partial<GetCustomerTokensRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetCustomerTokensRequest 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.

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>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <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>