Service Directory > v31.2 > Settlement_Services > Put_Payment_Acknowledgement_Message
 

Operation: Put_Payment_Acknowledgement_Message

This service operation will add or update Payment Acknowledgements or Payment File Acknowledgements providing updates to existing payment status and error code information.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Put_Payment_Acknowledgement_Message_Request

Payment Acknowledgement Message Request provide the abilty to add or update acknowledgements for payment file or payments providing status change and error code information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Payment_Acknowledgement_Message_Reference  Unique_IdentifierObject  [0..1]  Payment Acknowledgement Message Reference   
Payment_Acknowledgement_Message_Data  Payment_Acknowledgement_Message_Data  [1..1]  Payment Acknowledgement Message Data   
Validation Description
The Web Service is set to Add Only; but the Payment Acknowledgment Message already exists.   
top
 

Response Element: Put_Payment_Acknowledgement_Message_Response

Response to an add or updated Payment Acknowledgement Message
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payment_Acknowledgement_Message_Reference  Unique_IdentifierObject  [0..1]  Payment Acknowledgement Message Reference   
top
 

Unique_IdentifierObject

part of: Put_Payment_Acknowledgement_Message_Request, Put_Payment_Acknowledgement_Message_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payment_Acknowledgement_Message_Data

part of: Put_Payment_Acknowledgement_Message_Request
Contains data for creating or updating an Payments Acknowledgment
 
Parameter name Type/Value Cardinality Description Validations
Payment_Acknowlegement_Message_ID  string  [0..1]  Payment Acknowlegement Message ID   
Payment_Acknowledgement_Message_Date  dateTime  [0..1]  Payment Acknowledgement Message Date   
Originating_Bank_ID  string  [0..1]  Originating Bank ID   
Payment_Acknowledgement_Message_Update  boolean  [0..1]  Payment Acknowledgement Message Update   
Mark_Rejected_Prenote_Payment_As_Canceled  boolean  [0..1]  Mark Rejected Prenote Payments As Canceled - All Rejected Prenote Payments will be marked as Canceled is this field is set as Y   
Payment_File_Acknowledgement_Replacement_Data  Payment_File_Acknowledgement_Data  [0..*]  Payment File Acknowledgement Data. Used to provide the status and/or error codes of a previously sent Payment Message.   
Payment_Acknowledgement_Data  Payment_Acknowledgement_Data  [0..*]  Payment Acknowledgement Data. Used to provide the status and/or error codes of a previously sent Payment.   
top
 

Payment_File_Acknowledgement_Data

part of: Payment_Acknowledgement_Message_Data
Payment File Acknowledgement Data add or update payment file acknowledgements that allow the update of payment file status and error code information.
 
Parameter name Type/Value Cardinality Description Validations
Original_Payment_Message_ID  string  [0..1]  Original Payment Message ID   
Payment_Status_Reference  Payment_Acknowledgement_StatusObject  [0..1]  Reference to an existing Payment Status. Examples of Payment Status are Draft, In Progress, Approved   
Status_Reason_Code  string  [0..1]  Status Reason Code   
Status_Reason_Code_Description  string  [0..1]  Status Reason Code Description   
Original_Payment_Message_Date  date  [0..1]  Original Payment Message Date   
top
 

Payment_Acknowledgement_StatusObject

part of: Payment_File_Acknowledgement_Data, Payment_Acknowledgement_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Payment_Acknowledgement_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_Acknowledgement_StatusObjectID

part of: Payment_Acknowledgement_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Status  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payment_Acknowledgement_Data

part of: Payment_Acknowledgement_Message_Data
Payment Acknowledgement Data add or update payment acknowledgements that allow the update of payment status and error code information.
 
Parameter name Type/Value Cardinality Description Validations
Payment_Processing_ID  string  [0..1]  Payment Processing ID   
Payment_Message_Batch_ID  string  [0..1]  Payment Message Batch ID   
Original_Payment_ID  string  [0..1]  Original Payment ID   
Additional_Reconciliation_ID  string  [0..1]  Additional Reconciliation ID   
Merchant_Account_ID  string  [0..1]  Merchant Account ID   
Payment_Status_Reference  Payment_Acknowledgement_StatusObject  [0..1]  Reference to an existing Payment Status. Examples of Payment Status are Draft, In Progress, Approved   
Payment_Value_Date  date  [0..1]  Payment Value Date   
Status_Reason_Code  string  [0..1]  Status Reason Code   
Status_Reason_Code_Description  string  [0..1]  Status Reason Code Description   
Reason_Code  string  [0..1]  Reason Code   
Reason_Code_Description  string  [0..1]  Reason Code Description   
Original_Payment_Amount  decimal (26, 6)   [0..1]  Original Payment Amount   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Original_Payment_Date  date  [0..1]  Original Payment Date   
top
 

CurrencyObject

part of: Payment_Acknowledgement_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Payment_Acknowledgement_StatusReferenceEnumeration

part of: Payment_Acknowledgement_StatusObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top