POST api/Refunds/RefundImport

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ColumnCount	integer	None.
HasHeaders	boolean	None.
ImportData	Collection of RefundsUpload	None.
Headers	Collection of string	None.
RefundAmount	decimal number	None.
SpeedID	integer	None.
IsValidFileExtension	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ColumnCount": 1,
  "HasHeaders": true,
  "ImportData": [
    {
      "POLiID": "sample string 1",
      "RefundAmount": "sample string 2",
      "MerchantReference": "sample string 3",
      "SpeedName": "sample string 4",
      "ReasonForRefund": "sample string 5",
      "IsDuplicateRow": true
    },
    {
      "POLiID": "sample string 1",
      "RefundAmount": "sample string 2",
      "MerchantReference": "sample string 3",
      "SpeedName": "sample string 4",
      "ReasonForRefund": "sample string 5",
      "IsDuplicateRow": true
    }
  ],
  "Headers": [
    "sample string 1",
    "sample string 2"
  ],
  "RefundAmount": 3.0,
  "SpeedID": 4,
  "IsValidFileExtension": true
}

application/xml, text/xml

Sample:

<RefundListImport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.External.Models.RefundList">
  <ColumnCount>1</ColumnCount>
  <HasHeaders>true</HasHeaders>
  <Headers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Headers>
  <ImportData>
    <RefundsUpload>
      <IsDuplicateRow>true</IsDuplicateRow>
      <MerchantReference>sample string 3</MerchantReference>
      <POLiID>sample string 1</POLiID>
      <ReasonForRefund>sample string 5</ReasonForRefund>
      <RefundAmount>sample string 2</RefundAmount>
      <SpeedName>sample string 4</SpeedName>
    </RefundsUpload>
    <RefundsUpload>
      <IsDuplicateRow>true</IsDuplicateRow>
      <MerchantReference>sample string 3</MerchantReference>
      <POLiID>sample string 1</POLiID>
      <ReasonForRefund>sample string 5</ReasonForRefund>
      <RefundAmount>sample string 2</RefundAmount>
      <SpeedName>sample string 4</SpeedName>
    </RefundsUpload>
  </ImportData>
  <IsValidFileExtension>true</IsValidFileExtension>
  <RefundAmount>3</RefundAmount>
  <SpeedID>4</SpeedID>
</RefundListImport>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RefundListImport'.

Response Information

Resource Description

RefundsServiceValidationResult

Name	Type	Additional information
Success	boolean	None.
Errors	Collection of RefundsItemValidation	None.
Exception	string	None.
SuccessfulTransactions	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Errors": [
    {
      "FieldName": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "FieldName": "sample string 1",
      "Message": "sample string 2"
    }
  ],
  "Exception": "sample string 2",
  "SuccessfulTransactions": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<RefundsServiceValidationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Refunds">
  <Errors>
    <RefundsItemValidation>
      <FieldName>sample string 1</FieldName>
      <Message>sample string 2</Message>
    </RefundsItemValidation>
    <RefundsItemValidation>
      <FieldName>sample string 1</FieldName>
      <Message>sample string 2</Message>
    </RefundsItemValidation>
  </Errors>
  <Exception>sample string 2</Exception>
  <Success>true</Success>
  <SuccessfulTransactions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SuccessfulTransactions>
</RefundsServiceValidationResult>