AIM Web Services

<back to all web services

UpdateCcRequest

UpdateCC
Requires active-e Customer Service.

The following routes are available for this service:
POST, GET/api/UpdateCC
"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 UpdateCcResponse extends BaseResponse {
    /** @param {{Topic?:string,ErrorDetails?:string,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Topic;
    /** @type {string} */
    ErrorDetails;
}
export class UpdateCcRequest extends BaseSecureRequest {
    /** @param {{CardToken?:string,LastFour?:string,ExpirationMonth?:number,ExpirationYear?:number,CardExpiration?:string,CardType?:string,AcctType?:string,Gateway?:string,TokenPk?:string,WebRef?:string,NickName?:string,Acct?:number,MakePrimaryCard?:boolean,IsTempToken?:boolean,EnableAutoPay?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    CardToken;
    /** @type {string} */
    LastFour;
    /** @type {number} */
    ExpirationMonth;
    /** @type {number} */
    ExpirationYear;
    /** @type {string} */
    CardExpiration;
    /** @type {string} */
    CardType;
    /** @type {string} */
    AcctType;
    /** @type {string} */
    Gateway;
    /** @type {string} */
    TokenPk;
    /** @type {string} */
    WebRef;
    /** @type {string} */
    NickName;
    /** @type {?number} */
    Acct;
    /** @type {boolean} */
    MakePrimaryCard;
    /** @type {boolean} */
    IsTempToken;
    /** @type {boolean} */
    EnableAutoPay;
}

JavaScript UpdateCcRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/UpdateCC HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CardToken":"String","LastFour":"String","ExpirationMonth":0,"ExpirationYear":0,"CardExpiration":"String","CardType":"String","AcctType":"String","Gateway":"String","TokenPk":"String","WebRef":"String","NickName":"String","Acct":0,"MakePrimaryCard":false,"IsTempToken":false,"EnableAutoPay":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Topic":"String","ErrorDetails":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}