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.*


/**
* CreateAEPayRecordRequires active-e Customer Service.
*/
@DataContract
open class CreateAePayRecordRequest : BaseSecureRequest()
{
    @DataMember
    var Payments:ArrayList<Payment> = ArrayList<Payment>()

    @DataMember
    var WebId:Int? = null

    @DataMember
    var PayRef:String? = null

    @DataMember
    var Approval:String? = null

    @DataMember
    var UpdateCc:Boolean? = null

    @DataMember
    var CcName:String? = null

    @DataMember
    var CardInfo:CcInfo? = null

    @DataMember
    var Acct:Int? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract(Name="Payment")
open class Payment
{
    @DataMember
    var Ref:String? = null

    @DataMember
    var WebRef:String? = null

    @DataMember
    var Amount:BigDecimal? = null

    @DataMember
    var Date:Date? = null
}

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

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

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

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

    /**
    * Reason the card is on file.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    var ReasonOnFile:String? = 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")
    var TokenPk:Long? = 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")
    var Primary:Boolean? = null
}

@DataContract
open class CreateAePayRecordResponse : BaseResponse()
{
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

Kotlin CreateAePayRecordRequest 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/CreateAEPayRecord HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateAePayRecordRequest 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>
  <Approval>String</Approval>
  <CardInfo>
    <CardType>String</CardType>
    <Expiration>String</Expiration>
    <LastFour>String</LastFour>
    <Primary>false</Primary>
    <ReasonOnFile>String</ReasonOnFile>
    <TokenPk>0</TokenPk>
    <TokenStr>String</TokenStr>
  </CardInfo>
  <CcName>String</CcName>
  <PayRef>String</PayRef>
  <Payments>
    <Payment>
      <Amount>0</Amount>
      <Date>0001-01-01T00:00:00</Date>
      <Ref>String</Ref>
      <WebRef>String</WebRef>
    </Payment>
  </Payments>
  <UpdateCc>false</UpdateCc>
  <WebId>0</WebId>
</CreateAePayRecordRequest>

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

<CreateAePayRecordResponse 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>
</CreateAePayRecordResponse>