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 Foundation
import ServiceStack

/**
* CreateAEPayRecordRequires active-e Customer Service.
*/
// @DataContract
public class CreateAePayRecordRequest : BaseSecureRequest
{
    // @DataMember
    public var payments:[Payment] = []

    // @DataMember
    public var webId:Int?

    // @DataMember
    public var payRef:String

    // @DataMember
    public var approval:String

    // @DataMember
    public var updateCc:Bool?

    // @DataMember
    public var ccName:String

    // @DataMember
    public var cardInfo:CcInfo

    // @DataMember
    public var acct:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case payments
        case webId
        case payRef
        case approval
        case updateCc
        case ccName
        case cardInfo
        case acct
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        payments = try container.decodeIfPresent([Payment].self, forKey: .payments) ?? []
        webId = try container.decodeIfPresent(Int.self, forKey: .webId)
        payRef = try container.decodeIfPresent(String.self, forKey: .payRef)
        approval = try container.decodeIfPresent(String.self, forKey: .approval)
        updateCc = try container.decodeIfPresent(Bool.self, forKey: .updateCc)
        ccName = try container.decodeIfPresent(String.self, forKey: .ccName)
        cardInfo = try container.decodeIfPresent(CcInfo.self, forKey: .cardInfo)
        acct = try container.decodeIfPresent(Int.self, forKey: .acct)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if payments.count > 0 { try container.encode(payments, forKey: .payments) }
        if webId != nil { try container.encode(webId, forKey: .webId) }
        if payRef != nil { try container.encode(payRef, forKey: .payRef) }
        if approval != nil { try container.encode(approval, forKey: .approval) }
        if updateCc != nil { try container.encode(updateCc, forKey: .updateCc) }
        if ccName != nil { try container.encode(ccName, forKey: .ccName) }
        if cardInfo != nil { try container.encode(cardInfo, forKey: .cardInfo) }
        if acct != nil { try container.encode(acct, forKey: .acct) }
    }
}

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

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

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

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

    required public init(){}
}

// @DataContract(Name="Payment")
public class Payment : Codable
{
    // @DataMember
    public var ref:String

    // @DataMember
    public var webRef:String

    // @DataMember
    public var amount:Double

    // @DataMember
    public var date:Date?

    required public init(){}
}

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

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

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

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

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

    /**
    * 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 var tokenPk:Int?

    /**
    * 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 var primary:Bool?

    required public init(){}
}

// @DataContract
public class CreateAePayRecordResponse : BaseResponse
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

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

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

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

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

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

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

Swift 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>