| POST, GET | /api/CreateAEPayRecord |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Payments | body | List<Payment> | No | |
| WebId | body | int? | No | |
| PayRef | body | string | No | |
| Approval | body | string | No | |
| UpdateCc | body | bool? | No | |
| CcName | body | string | No | |
| CardInfo | body | CcInfo | No | |
| Acct | body | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | The Login Token return by the Security API. Required for secured calls. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Ref | form | string | No | |
| WebRef | form | string | No | |
| Amount | form | decimal | No | |
| Date | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TokenStr | body | string | Yes | Token returned from processor |
| CardType | body | string | Yes | Card Type (VISA, MCARD, AMEX, DSCVR) |
| LastFour | body | string | Yes | Last four of the card |
| Expiration | body | string | No | Expiration Date of the Card. (MM/YY) |
| ReasonOnFile | body | string | No | Reason the card is on file. |
| TokenPk | body | integer | No | ID of the existing Token Record in AIM, if applicable |
| Primary | body | boolean | No | Is this the customer's primary card? Defaults to false. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
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
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","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"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"}}