POST api/Eca/AuthOnly
Request Information
URI Parameters
None.
Body Parameters
AuthOnlyRequestName | Description | Type | Additional information |
---|---|---|---|
RequestAgentType | string |
None. |
|
RequestAgent | string |
None. |
|
Username | string |
None. |
|
Password | string |
None. |
|
AccountNumber | string |
None. |
|
ApplicationID | integer |
None. |
|
CardNumber | integer |
None. |
|
AuthorizationGUID | string |
None. |
|
TransactionAmount | decimal number |
None. |
|
PromoCode | string |
None. |
|
MerchantNumber | integer |
None. |
|
MerchantReferenceNumber | string |
None. |
|
ExpirationDate | string |
None. |
|
NameOnCard | string |
None. |
|
ShippingAddress | ShippingAddress |
None. |
|
RequestSource | string |
None. |
|
ExtendedData | Dictionary of string [key] and string [value] |
None. |
Request Formats
application/json, text/json
Sample:
{ "RequestAgentType": "sample string 1", "RequestAgent": "sample string 2", "Username": "sample string 3", "Password": "sample string 4", "AccountNumber": "sample string 5", "ApplicationID": 6, "CardNumber": 7, "AuthorizationGUID": "sample string 8", "TransactionAmount": 9.0, "PromoCode": "sample string 10", "MerchantNumber": 11, "MerchantReferenceNumber": "sample string 12", "ExpirationDate": "sample string 13", "NameOnCard": "sample string 14", "ShippingAddress": { "Address1": "sample string 1", "Address2": "sample string 2", "City": "sample string 3", "State": "sample string 4", "ZipCode": "sample string 5" }, "RequestSource": "sample string 15", "ExtendedData": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }
application/xml, text/xml
Sample:
<AuthOnlyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Progressive.Web.Api.Library.Models.AuthOnly"> <AccountNumber>sample string 5</AccountNumber> <ApplicationID>6</ApplicationID> <AuthorizationGUID>sample string 8</AuthorizationGUID> <CardNumber>7</CardNumber> <ExpirationDate>sample string 13</ExpirationDate> <ExtendedData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:KeyValueOfstringstring> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value>sample string 4</d2p1:Value> </d2p1:KeyValueOfstringstring> </ExtendedData> <MerchantNumber>11</MerchantNumber> <MerchantReferenceNumber>sample string 12</MerchantReferenceNumber> <NameOnCard>sample string 14</NameOnCard> <Password>sample string 4</Password> <PromoCode>sample string 10</PromoCode> <RequestAgent>sample string 2</RequestAgent> <RequestAgentType>sample string 1</RequestAgentType> <RequestSource>sample string 15</RequestSource> <ShippingAddress> <Address1>sample string 1</Address1> <Address2>sample string 2</Address2> <City>sample string 3</City> <State>sample string 4</State> <ZipCode>sample string 5</ZipCode> </ShippingAddress> <TransactionAmount>9</TransactionAmount> <Username>sample string 3</Username> </AuthOnlyRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AuthOnlyResponseName | Description | Type | Additional information |
---|---|---|---|
ChargeAuthorizationCode | string |
None. |
|
Status | string |
None. |
|
ChargeAuthorizationTransactionID | integer |
None. |
|
AvailableCredit | decimal number |
None. |
|
ChargeAuthorizationExpirationDate | date |
None. |
|
PromoCode | string |
None. |
|
PromoVerbiage | string |
None. |
|
AVSCode | string |
None. |
|
AuthorizationGUID | string |
None. |
|
Messages | Collection of string |
None. |
|
POSReceiptVerbiage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ChargeAuthorizationCode": "sample string 1", "Status": "sample string 2", "ChargeAuthorizationTransactionID": 3, "AvailableCredit": 4.0, "ChargeAuthorizationExpirationDate": "2025-04-04T14:29:43.4894571-05:00", "PromoCode": "sample string 5", "PromoVerbiage": "sample string 6", "AVSCode": "sample string 7", "AuthorizationGUID": "sample string 8", "Messages": [ "sample string 1", "sample string 2" ], "POSReceiptVerbiage": "sample string 9" }
application/xml, text/xml
Sample:
<AuthOnlyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Progressive.Web.Api.Library.Models.AuthOnly"> <AVSCode>sample string 7</AVSCode> <AuthorizationGUID>sample string 8</AuthorizationGUID> <AvailableCredit>4</AvailableCredit> <ChargeAuthorizationCode>sample string 1</ChargeAuthorizationCode> <ChargeAuthorizationExpirationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-04-04T19:29:43.4894571Z</d2p1:DateTime> <d2p1:OffsetMinutes>-300</d2p1:OffsetMinutes> </ChargeAuthorizationExpirationDate> <ChargeAuthorizationTransactionID>3</ChargeAuthorizationTransactionID> <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Messages> <POSReceiptVerbiage>sample string 9</POSReceiptVerbiage> <PromoCode>sample string 5</PromoCode> <PromoVerbiage>sample string 6</PromoVerbiage> <Status>sample string 2</Status> </AuthOnlyResponse>