AIM Web Services

<back to all web services

CreateAePayRecordRequest

CreateAEPayRecord
Requires active-e Customer Service.

The following routes are available for this service:
POST, GET/api/CreateAEPayRecord
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * CreateAEPayRecordRequires active-e Customer Service.
    */
    @DataContract
    public static class CreateAePayRecordRequest extends BaseSecureRequest
    {
        @DataMember
        public ArrayList<Payment> Payments = null;

        @DataMember
        public Integer WebId = null;

        @DataMember
        public String PayRef = null;

        @DataMember
        public String Approval = null;

        @DataMember
        public Boolean UpdateCc = null;

        @DataMember
        public String CcName = null;

        @DataMember
        public CcInfo CardInfo = null;

        @DataMember
        public Integer Acct = null;
        
        public ArrayList<Payment> getPayments() { return Payments; }
        public CreateAePayRecordRequest setPayments(ArrayList<Payment> value) { this.Payments = value; return this; }
        public Integer getWebId() { return WebId; }
        public CreateAePayRecordRequest setWebId(Integer value) { this.WebId = value; return this; }
        public String getPayRef() { return PayRef; }
        public CreateAePayRecordRequest setPayRef(String value) { this.PayRef = value; return this; }
        public String getApproval() { return Approval; }
        public CreateAePayRecordRequest setApproval(String value) { this.Approval = value; return this; }
        public Boolean isUpdateCc() { return UpdateCc; }
        public CreateAePayRecordRequest setUpdateCc(Boolean value) { this.UpdateCc = value; return this; }
        public String getCcName() { return CcName; }
        public CreateAePayRecordRequest setCcName(String value) { this.CcName = value; return this; }
        public CcInfo getCardInfo() { return CardInfo; }
        public CreateAePayRecordRequest setCardInfo(CcInfo value) { this.CardInfo = value; return this; }
        public Integer getAcct() { return Acct; }
        public CreateAePayRecordRequest setAcct(Integer value) { this.Acct = value; return this; }
    }

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

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * 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 String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract(Name="Payment")
    public static class Payment
    {
        @DataMember
        public String Ref = null;

        @DataMember
        public String WebRef = null;

        @DataMember
        public BigDecimal Amount = null;

        @DataMember
        public Date Date = null;
        
        public String getRef() { return Ref; }
        public Payment setRef(String value) { this.Ref = value; return this; }
        public String getWebRef() { return WebRef; }
        public Payment setWebRef(String value) { this.WebRef = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public Payment setAmount(BigDecimal value) { this.Amount = value; return this; }
        public Date getDate() { return Date; }
        public Payment setDate(Date value) { this.Date = value; return this; }
    }

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

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

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

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

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

        /**
        * 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 Long TokenPk = null;

        /**
        * 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 Boolean Primary = null;
        
        public String getTokenStr() { return TokenStr; }
        public CcInfo setTokenStr(String value) { this.TokenStr = value; return this; }
        public String getCardType() { return CardType; }
        public CcInfo setCardType(String value) { this.CardType = value; return this; }
        public String getLastFour() { return LastFour; }
        public CcInfo setLastFour(String value) { this.LastFour = value; return this; }
        public String getExpiration() { return Expiration; }
        public CcInfo setExpiration(String value) { this.Expiration = value; return this; }
        public String getReasonOnFile() { return ReasonOnFile; }
        public CcInfo setReasonOnFile(String value) { this.ReasonOnFile = value; return this; }
        public Long getTokenPk() { return TokenPk; }
        public CcInfo setTokenPk(Long value) { this.TokenPk = value; return this; }
        public Boolean isPrimary() { return Primary; }
        public CcInfo setPrimary(Boolean value) { this.Primary = value; return this; }
    }

    @DataContract
    public static class CreateAePayRecordResponse extends BaseResponse
    {
        
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

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

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

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

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

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

}

Java CreateAePayRecordRequest DTOs

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

HTTP + JSON

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

POST /api/CreateAEPayRecord HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Payments":[{"Ref":"String","WebRef":"String","Amount":0,"Date":"0001-01-01T00:00:00.0000000"}],"WebId":0,"PayRef":"String","Approval":"String","UpdateCc":false,"CcName":"String","CardInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"Acct":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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