POST BankDeposit/ReverseBankDeposit

Reverse a Bank Deposit

Request Information

URI Parameters

Body Parameters

The request object used to reverse the bank deposit

ClsBankDepositReverse
NameDescriptionTypeAdditional Information
DepositKey

Deposit Key of deposit

 string
DepositGUID

GUID of Deposit to Reverse

 globally unique identifier

Request Formats

application/json, text/json

Sample: 
{
  "DepositKey": "sample string 3",
  "DepositGUID": "e98b60da-9bf0-4d91-b397-fd0b07c18bdc"
}

application/xml, text/xml

Sample: 
<BankDepositReverse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <DepositGUID>e98b60da-9bf0-4d91-b397-fd0b07c18bdc</DepositGUID>
  <DepositKey>sample string 3</DepositKey>
</BankDepositReverse>

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 'ClsBankDepositReverse'.

Response Information

Resource Description

Reverse a Bank Deposit

AgvBankDeposit
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

 string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

 string
ErrorList

List of errors from the API

 Collection of string
WarningList

List of warnings from the API

 Collection of string
DepositGuid

The GUID of the deposit that is created

 globally unique identifier
PreSignedUrl

The PreSigned URL to the deposit document

 string

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "DepositGuid": "225cc19c-d43f-43d5-a30d-14e9f3671826",
  "PreSignedUrl": "sample string 3"
}

application/xml, text/xml

Sample: 
<AgvBankDeposit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.GL">
  <DepositGuid>225cc19c-d43f-43d5-a30d-14e9f3671826</DepositGuid>
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <PreSignedUrl>sample string 3</PreSignedUrl>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvBankDeposit>