POST api/Eca/Refund

Request Information

URI Parameters

None.

Body Parameters

RefundRequest
NameDescriptionTypeAdditional information
username

string

None.

password

string

None.

accountNumber

string

None.

address1

string

None.

address2

string

None.

adjustmentAmount

decimal number

None.

adjustmentDesc

string

None.

expirationMonth

integer

None.

expirationYear

integer

None.

merchantNumber

string

None.

promoCode

string

None.

client

string

None.

zipCode

string

None.

storeNumber

string

None.

purchaseAuthID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "username": "sample string 1",
  "password": "sample string 2",
  "accountNumber": "sample string 3",
  "address1": "sample string 4",
  "address2": "sample string 5",
  "adjustmentAmount": 6.0,
  "adjustmentDesc": "sample string 7",
  "expirationMonth": 8,
  "expirationYear": 9,
  "merchantNumber": "sample string 10",
  "promoCode": "sample string 11",
  "client": "sample string 12",
  "zipCode": "sample string 13",
  "storeNumber": "sample string 14",
  "purchaseAuthID": "sample string 15"
}

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 3</accountNumber>
  <address1>sample string 4</address1>
  <address2>sample string 5</address2>
  <adjustmentAmount>6</adjustmentAmount>
  <adjustmentDesc>sample string 7</adjustmentDesc>
  <client>sample string 12</client>
  <expirationMonth>8</expirationMonth>
  <expirationYear>9</expirationYear>
  <merchantNumber>sample string 10</merchantNumber>
  <password>sample string 2</password>
  <promoCode>sample string 11</promoCode>
  <purchaseAuthID>sample string 15</purchaseAuthID>
  <storeNumber>sample string 14</storeNumber>
  <username>sample string 1</username>
  <zipCode>sample string 13</zipCode>
</RefundRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RefundResponse
NameDescriptionTypeAdditional information
status

string

None.

transactionId

string

None.

responseText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": "sample string 1",
  "transactionId": "sample string 2",
  "responseText": "sample string 3"
}

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">
  <responseText>sample string 3</responseText>
  <status>sample string 1</status>
  <transactionId>sample string 2</transactionId>
</RefundResponse>