POST api/Eca/Refund

Request Information

URI Parameters

None.

Body Parameters

Name	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.
AuthorizationCode	string	None.
RefundAmount	decimal number	None.
RefundDescription	string	None.
StoreNumber	integer	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,
  "MerchantReferenceNumber": "sample string 8",
  "ReturnAuthorizationGUID": "sample string 9",
  "MerchantNumber": 10,
  "AuthorizationCode": "sample string 11",
  "RefundAmount": 12.0,
  "RefundDescription": "sample string 13",
  "StoreNumber": 14,
  "ExtendedData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<RefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Progressive.Web.Api.Library.Models.Refund">
  <AccountNumber>sample string 5</AccountNumber>
  <ApplicationID>6</ApplicationID>
  <AuthorizationCode>sample string 11</AuthorizationCode>
  <CardNumber>7</CardNumber>
  <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>12</RefundAmount>
  <RefundDescription>sample string 13</RefundDescription>
  <RequestAgent>sample string 2</RequestAgent>
  <RequestAgentType>sample string 1</RequestAgentType>
  <ReturnAuthorizationGUID>sample string 9</ReturnAuthorizationGUID>
  <StoreNumber>14</StoreNumber>
  <Username>sample string 3</Username>
</RefundRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RefundResponse

Name	Type	Additional information
Status	string	None.
TransactionID	integer	None.
AuthorizationCode	string	None.
Messages	Collection of string	None.
ReturnAuthorizationGUID	string	None.
AvailableCredit	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "TransactionID": 2,
  "AuthorizationCode": "sample string 3",
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "ReturnAuthorizationGUID": "sample string 4",
  "AvailableCredit": 5.0
}

application/xml, text/xml

Sample:

<RefundResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Progressive.Web.Api.Library.Models.Refund">
  <AuthorizationCode>sample string 3</AuthorizationCode>
  <AvailableCredit>5</AvailableCredit>
  <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>
  <TransactionID>2</TransactionID>
</RefundResponse>