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
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
class BaseRequest implements JsonSerializable
{
    public function __construct(
        /** @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")
        /** @var string */
        public string $ApiKey='',

        // @DataMember
        // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        /** @var string|null */
        public ?string $OAuthToken=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
        if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
        if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseSecureRequest extends BaseRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        /** @var string|null */
        public ?string $Token=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        /** @var string|null */
        public ?string $DeviceId=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        /** @var string */
        public string $AppId=''
    ) {
        parent::__construct($ApiKey,$OAuthToken);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Token'])) $this->Token = $o['Token'];
        if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
        if (isset($o['AppId'])) $this->AppId = $o['AppId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Token)) $o['Token'] = $this->Token;
        if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
        if (isset($this->AppId)) $o['AppId'] = $this->AppId;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseResponseResult implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        /** @var string|null */
        public ?string $StatusCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        /** @var string|null */
        public ?string $Login=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorCode=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorDisplayText=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        /** @var string|null */
        public ?string $ErrorMessage=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        /** @var string|null */
        public ?string $DomainName=null,

        /** @description  */
        // @DataMember
        // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        /** @var string|null */
        public ?string $IpAddress=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
        if (isset($o['Login'])) $this->Login = $o['Login'];
        if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
        if (isset($o['ErrorDisplayText'])) $this->ErrorDisplayText = $o['ErrorDisplayText'];
        if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
        if (isset($o['DomainName'])) $this->DomainName = $o['DomainName'];
        if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
        if (isset($this->Login)) $o['Login'] = $this->Login;
        if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
        if (isset($this->ErrorDisplayText)) $o['ErrorDisplayText'] = $this->ErrorDisplayText;
        if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
        if (isset($this->DomainName)) $o['DomainName'] = $this->DomainName;
        if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseResponse implements JsonSerializable
{
    public function __construct(
        /** @description  */
        // @DataMember
        // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        /** @var BaseResponseResult|null */
        public ?BaseResponseResult $Status=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Status'])) $this->Status = JsonConverters::from('BaseResponseResult', $o['Status']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Status)) $o['Status'] = JsonConverters::to('BaseResponseResult', $this->Status);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class CreateAePayRecordResponse extends BaseResponse implements JsonSerializable
{
    /**
     * @param BaseResponseResult|null $Status
     */
    public function __construct(
        ?BaseResponseResult $Status=null
    ) {
        parent::__construct($Status);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract(Name="Payment")
class Payment implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $Ref=null,

        // @DataMember
        /** @var string|null */
        public ?string $WebRef=null,

        // @DataMember
        /** @var float */
        public float $Amount=0.0,

        // @DataMember
        /** @var DateTime|null */
        public ?DateTime $Date=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Ref'])) $this->Ref = $o['Ref'];
        if (isset($o['WebRef'])) $this->WebRef = $o['WebRef'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
        if (isset($o['Date'])) $this->Date = JsonConverters::from('DateTime', $o['Date']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Ref)) $o['Ref'] = $this->Ref;
        if (isset($this->WebRef)) $o['WebRef'] = $this->WebRef;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        if (isset($this->Date)) $o['Date'] = JsonConverters::to('DateTime', $this->Date);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract(Name="CCInfo")
class CcInfo implements JsonSerializable
{
    public function __construct(
        /** @description Token returned from processor */
        // @DataMember
        // @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
        /** @var string */
        public string $TokenStr='',

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

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

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

        /** @description Reason the card is on file. */
        // @DataMember
        // @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
        /** @var string|null */
        public ?string $ReasonOnFile=null,

        /** @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")
        /** @var int|null */
        public ?int $TokenPk=null,

        /** @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")
        /** @var bool|null */
        public ?bool $Primary=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TokenStr'])) $this->TokenStr = $o['TokenStr'];
        if (isset($o['CardType'])) $this->CardType = $o['CardType'];
        if (isset($o['LastFour'])) $this->LastFour = $o['LastFour'];
        if (isset($o['Expiration'])) $this->Expiration = $o['Expiration'];
        if (isset($o['ReasonOnFile'])) $this->ReasonOnFile = $o['ReasonOnFile'];
        if (isset($o['TokenPk'])) $this->TokenPk = $o['TokenPk'];
        if (isset($o['Primary'])) $this->Primary = $o['Primary'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TokenStr)) $o['TokenStr'] = $this->TokenStr;
        if (isset($this->CardType)) $o['CardType'] = $this->CardType;
        if (isset($this->LastFour)) $o['LastFour'] = $this->LastFour;
        if (isset($this->Expiration)) $o['Expiration'] = $this->Expiration;
        if (isset($this->ReasonOnFile)) $o['ReasonOnFile'] = $this->ReasonOnFile;
        if (isset($this->TokenPk)) $o['TokenPk'] = $this->TokenPk;
        if (isset($this->Primary)) $o['Primary'] = $this->Primary;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description CreateAEPayRecordRequires active-e Customer Service. */
// @DataContract
class CreateAePayRecordRequest extends BaseSecureRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string|null $OAuthToken
     * @param string|null $Token
     * @param string|null $DeviceId
     * @param string $AppId
     */
    public function __construct(
        string $ApiKey='',
        ?string $OAuthToken=null,
        ?string $Token=null,
        ?string $DeviceId=null,
        string $AppId='',
        // @DataMember
        /** @var array<Payment>|null */
        public ?array $Payments=null,

        // @DataMember
        /** @var int|null */
        public ?int $WebId=null,

        // @DataMember
        /** @var string|null */
        public ?string $PayRef=null,

        // @DataMember
        /** @var string|null */
        public ?string $Approval=null,

        // @DataMember
        /** @var bool|null */
        public ?bool $UpdateCc=null,

        // @DataMember
        /** @var string|null */
        public ?string $CcName=null,

        // @DataMember
        /** @var CcInfo|null */
        public ?CcInfo $CardInfo=null,

        // @DataMember
        /** @var int|null */
        public ?int $Acct=null
    ) {
        parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['Payments'])) $this->Payments = JsonConverters::fromArray('Payment', $o['Payments']);
        if (isset($o['WebId'])) $this->WebId = $o['WebId'];
        if (isset($o['PayRef'])) $this->PayRef = $o['PayRef'];
        if (isset($o['Approval'])) $this->Approval = $o['Approval'];
        if (isset($o['UpdateCc'])) $this->UpdateCc = $o['UpdateCc'];
        if (isset($o['CcName'])) $this->CcName = $o['CcName'];
        if (isset($o['CardInfo'])) $this->CardInfo = JsonConverters::from('CcInfo', $o['CardInfo']);
        if (isset($o['Acct'])) $this->Acct = $o['Acct'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->Payments)) $o['Payments'] = JsonConverters::toArray('Payment', $this->Payments);
        if (isset($this->WebId)) $o['WebId'] = $this->WebId;
        if (isset($this->PayRef)) $o['PayRef'] = $this->PayRef;
        if (isset($this->Approval)) $o['Approval'] = $this->Approval;
        if (isset($this->UpdateCc)) $o['UpdateCc'] = $this->UpdateCc;
        if (isset($this->CcName)) $o['CcName'] = $this->CcName;
        if (isset($this->CardInfo)) $o['CardInfo'] = JsonConverters::to('CcInfo', $this->CardInfo);
        if (isset($this->Acct)) $o['Acct'] = $this->Acct;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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"}}