POST api/Eca/AuthorizationReversal
Request Information
URI Parameters
None.
Body Parameters
AuthorizationReversalRequest| Name | 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. |
|
| MerchantReferenceNumber | string |
None. |
|
| ReturnAuthorizationGUID | string |
None. |
|
| MerchantNumber | integer |
None. |
|
| RefundAmount | decimal number |
None. |
|
| RequestType | string |
None. |
|
| ChargeAuthorizationCode | string |
None. |
|
| ExtendedData | Dictionary of string [key] and string [value] |
None. |
|
| RequestSource | string |
None. |
|
| ChargeAuthorizationTransactionID | integer |
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,
"MerchantReferenceNumber": "sample string 8",
"ReturnAuthorizationGUID": "sample string 9",
"MerchantNumber": 10,
"RefundAmount": 11.0,
"RequestType": "sample string 12",
"ChargeAuthorizationCode": "sample string 13",
"ExtendedData": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"RequestSource": "sample string 14",
"ChargeAuthorizationTransactionID": 15
}
application/xml, text/xml
Sample:
<AuthorizationReversalRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Progressive.Web.Api.Library.Models.AuthorizationReversal">
<AccountNumber>sample string 5</AccountNumber>
<ApplicationID>6</ApplicationID>
<CardNumber>7</CardNumber>
<ChargeAuthorizationCode>sample string 13</ChargeAuthorizationCode>
<ChargeAuthorizationTransactionID>15</ChargeAuthorizationTransactionID>
<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>10</MerchantNumber>
<MerchantReferenceNumber>sample string 8</MerchantReferenceNumber>
<Password>sample string 4</Password>
<RefundAmount>11</RefundAmount>
<RequestAgent>sample string 2</RequestAgent>
<RequestAgentType>sample string 1</RequestAgentType>
<RequestSource>sample string 14</RequestSource>
<RequestType>sample string 12</RequestType>
<ReturnAuthorizationGUID>sample string 9</ReturnAuthorizationGUID>
<Username>sample string 3</Username>
</AuthorizationReversalRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AuthorizationReversalResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | string |
None. |
|
| ChargeAuthorizationReversalCode | string |
None. |
|
| ChargeAuthorizationReversalTransactionID | integer |
None. |
|
| Messages | Collection of string |
None. |
|
| ReturnAuthorizationGUID | string |
None. |
|
| AvailableCredit | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": "sample string 1",
"ChargeAuthorizationReversalCode": "sample string 2",
"ChargeAuthorizationReversalTransactionID": 3,
"Messages": [
"sample string 1",
"sample string 2"
],
"ReturnAuthorizationGUID": "sample string 4",
"AvailableCredit": 5.0
}
application/xml, text/xml
Sample:
<AuthorizationReversalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Progressive.Web.Api.Library.Models.AuthorizationReversal">
<AvailableCredit>5</AvailableCredit>
<ChargeAuthorizationReversalCode>sample string 2</ChargeAuthorizationReversalCode>
<ChargeAuthorizationReversalTransactionID>3</ChargeAuthorizationReversalTransactionID>
<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>
<ReturnAuthorizationGUID>sample string 4</ReturnAuthorizationGUID>
<Status>sample string 1</Status>
</AuthorizationReversalResponse>