PUT HelenaOraclePayment/UpdateHelenaOraclePendingPayments

Updates the Pending Payment to the status from Oracle

Request Information

URI Parameters

Body Parameters

Object used to send the data to SKY

UpdateScheduledPayment
NameDescriptionTypeAdditional Information
ScheduledPaymentId

Id of scheduled payment to update

 globally unique identifier

Required
Status

Status to update the payment to. Should be one of the ScheduledPaymentState states Currently supported status values are "Posted", "Rejected"

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "ScheduledPaymentId": "3f1509dc-970c-43b9-bff8-94f9b2c73868",
  "Status": "sample string 2"
}

application/xml, text/xml

Sample: 
<UpdateScheduledPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Custom.Helena">
  <ScheduledPaymentId>3f1509dc-970c-43b9-bff8-94f9b2c73868</ScheduledPaymentId>
  <Status>sample string 2</Status>
</UpdateScheduledPayment>

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

Response Information

Resource Description

Updates the Pending Payment to the status from Oracle

AgvHelenaOraclePaymentUpdate
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
Data

List of properties and values returned for the payment that was updated

 UpdateScheduledPayment

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"
  ],
  "Data": {
    "ScheduledPaymentId": "b69ca8bc-dccf-422b-97bc-4e9e27a63a6e",
    "Status": "sample string 2"
  }
}

application/xml, text/xml

Sample: 
<AgvHelenaOraclePaymentUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Custom.Helena">
  <Data>
    <ScheduledPaymentId>b69ca8bc-dccf-422b-97bc-4e9e27a63a6e</ScheduledPaymentId>
    <Status>sample string 2</Status>
  </Data>
  <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>
  <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>
</AgvHelenaOraclePaymentUpdate>